Skip to main content

ApprovalResponse

The response to an Approve, Reject, or Reopen action on an Entry Sheet. The results array will be empty, but the status array will contain any status (confirmation) messages generated by the action.

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true
uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users
statusstring[]

Any status (confirmation) messages generated by the Approve, Reject, or Reopen action.

Example: ["The sheet status was changed to approved.","The sheet status was changed to open."]
errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

resultsobject[]
ApprovalResponse
{
"response_code": 200,
"success": true,
"uri": "https://example.apps.journyx.com/api/v1/users",
"status": [
"The sheet status was changed to approved.",
"The sheet status was changed to open."
],
"errors": [
"string"
],
"warnings": [
"string"
],
"info": [
"string"
],
"results": [
{}
]
}