Public Web API: Response model for retrieving approval sheets and lists of informed users (Retrieve approval sheets and lists of informed users)

Methods

POST — Retrieve approval sheets and lists of informed users

Resource

{
    "error": "string",
    "result": [
        {
            "id": "uuid",
            "respondents": [
                {
                    "comment": "string",
                    "fileId": "uuid",
                    "id": "uuid",
                    "responseTime": "date-time",
                    "status": "string",
                    "substituteId": "uuid"
                }
            ],
            "status": "string",
            "type": "string"
        }
    ],
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error text if `success == false`	Optional
result[]	array	Context with data	Optional
result[].id	uuid	Identifier	Optional
result[].respondents[]	array	Respondent	Optional
result[].respondents[].comment	string	Respondent’s comment	Optional
result[].respondents[].fileId	uuid	File attached by the respondent can be empty	Optional
result[].respondents[].id	uuid	User ID	Optional
result[].respondents[].responseTime	date-time	Decision time	Optional
result[].respondents[].status	string	User status Possible values are: `in_progress — в процессе;` `approved — согласовано(только для согласования);` `rejected — отказано(только для согласования);` `done — ознакомлен(только для ознакомления);` `terminated - отменен.`	Optional
result[].respondents[].substituteId	uuid	Substitute user ID	Optional
result[].status	string	Sheet or list status Possible values are: `in_progress — в процессе;` `approved — согласовано(только для согласования);` `rejected — отказано(только для согласования);` `done — ознакомлен(только для ознакомления);` `terminated - отменен.`	Optional
result[].type	string	Type Possible values are: `approval — согласование;` `inform — ознакомление.`	Optional
success	boolean	Successful response flag	Optional