Approval Comments Query APIAPI Explorer
Introduction
The API is used to access approval comments for one workflow form record.
API Calling
The API is used to access approval comments for one workflow form record.
Request URL: https://api.jodoo.com/api/v1/app/{app_id}/entry/{entry_id}/data/{data_id}/approval_comments
Request Frequency: 30 times/second
Request Method: POST
URL Parameter:
Parameter | Type | Description |
appId | String | App ID |
entryId | String | Form ID |
dataId | String | Workflow form data ID |
Request Parameter:
Parameter | Type | Description |
skip | Number | Offset refers to the number of approval comments you skipped. If you want to query results after the 100th comment, you need to set the "skip" parameter to 100 because a maximum of 100 approval comments can be returned at a time. If you want to query results after the 200th comment, you need to set the "skip" parameter to 200, and so on. |
Property Description:
Property | Type | Description |
approveCommentList | [JSON] | Approval comment list |
approveCommentList[*].flowNodeName | String | Workflow node name |
approveCommentList[*].flowAction | String | Actions taken in the approval process: forward — submit transfer — hand over back — return close — end sign_before — add a pre-approver sign_after — add a post-approver sign_parallel — add a parallel approver |
approveCommentList[*].comment | String | Approval comment |
approveCommentList[*].signature_url? | String | The "signature_url" attribute is optional and contains the URL of a signature for the approval comment. This URL is valid for 15 days. |
Sample Response:
POST - /api/v1/app/{app_id}/entry/{entry_id}/data/{data_id}/approval_comments
{
"approveCommentList": [
{
"operator": {
"_id": "5ed78abead7b951a243cc828",
"username": "jdy-y69rlimdfquz",
"status": 1,
"name": "AngelMsger"
},
"flowAction": "forward",
"comment": "One approval comment",
"flowNodeName": "Signature is required",
"signature_url": "https://files.jodoo.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
}
]
}