200 | | | Response includes a list of approval items. |
| count | string | Number of records retrieved |
| page | string | Current page number |
| pageSize | string | Number of records on each page |
| commentCounts | object | Comment counts |
| commentCounts.open | string | Number of comments that are open |
| commentCounts.addressed | string | Number of comments that are addressed |
| commentCounts.completed | string | Number of comments that are completed |
| commentCounts.total | string | Total number of comments |
| items | array | List of approval items |
| items.approvalItemId | string | Id for approval item |
| items.objectType | string | Object type for approval item |
| items.objectId | string | Unique Id of the object associated with the approval item |
| items.name | string | Name of the approval item |
| items.description | string | Description of the approval item |
| items.workflowItemId | string | Id of the workflow item |
| items.workflowState | string | Workflow state of the approval item |
| items.workflowType | string | Type of the workflow |
| items.workflowName | string | Name of the workflow |
| items.deadline | array | Deadline for the approval item |
| items.commentCounts | object | Comment counts |
| items.commentCounts.open | string | Number of comments that are open |
| items.commentCounts.addressed | string | Number of comments that are addressed |
| items.commentCounts.completed | string | Number of comments that are completed |
| items.commentCounts.total | string | Total number of comments |
| items.workflowItem | object | Workflow item object |
| items.workflowItem.workflowItemId | string | Workflow item id |
| items.workflowItem.workflowRound | string | Workflow round |
| items.workflowItem.type | string | Workflow type |
| items.workflowItem.currentState | object | Current state of the workflow |
| items.workflowItem.currentState.stateId | string | Id of the current state |
| items.workflowItem.currentState.stateName | string | Current state name |
| items.workflowItem.currentState.isEndState | string | Is the current state the final state? |
| items.workflowItem.currentState.modifiedDate | string | Date the workflow item is modified |
| items.workflowItem.availableTransitions | array | Collection of available workflow states |
| items.workflowItem.availableTransitions.id | string | Id of the available workflow state |
| items.workflowItem.availableTransitions.name | string | Name of the available workflow state |
| items.workflowItem.availableTransitions.isPersistable | string | Defines if the workflow item is persistable |
| items.blocked | string | Defines if emails will be sent out. If blocked = true, then emails will not be sent. |
| | | |
400_OrderByInvalid | | | The GET request parameter - $OrderBy is invalid and thus the request cannot be processed. |
| message | string | The GET request parameter - $OrderBy is invalid and thus the request cannot be processed. |
| errorcode | string | Error code for the exception (10000) |
| | | |
400_OperatorNotSupported | | | The operator 'neq' is not supported. |
| message | string | The operator 'neq' is not supported. |
| errorcode | string | Error code for the exception (10000) |
| | | |
400_FilterInvalid | | | The GET request filter parameter is invalid and thus the request cannot be processed. |
| message | string | The GET request filter parameter is invalid and thus the request cannot be processed |
| errorcode | string | Error code for the exception (10000) |