CZERTAINLY Approvals API (2.13.1)
Download OpenAPI specification:Download
REST API for approvals in the platform
Get Approval Profile Details
path Parameters
| uuid required | string Approval profile UUID |
query Parameters
required | object (ApprovalProfileForVersionDto) Select specific version of the approval profile |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "ApprovalProfile1",
- "version": 1,
- "description": "Detail description of the approval profile",
- "enabled": true,
- "expiry": 30,
- "numberOfSteps": 2,
- "associations": 0,
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "username": "string",
- "roleName": "string",
- "groupName": "string"
}
]
}Edit an Approval profile
path Parameters
| uuid required | string Approval profile UUID |
Request Body schema: application/jsonrequired
| description | string Description of the Approval profile |
| expiry | integer <int32> Expiration of the Approval profile in hours |
required | Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "Detail description of the approval profile",
- "expiry": 30,
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0
}
]
}Response samples
- 200
- 400
- 403
- 404
- 422
Content type
application/json
{ }Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvalProfiles": [
- {
- "uuid": "string",
- "name": "ApprovalProfile1",
- "version": 1,
- "description": "Detail description of the approval profile",
- "enabled": true,
- "expiry": 30,
- "numberOfSteps": 2,
- "associations": 0
}
]
}Create a Approval profile
Request Body schema: application/jsonrequired
| name required | string Name of the Approval profile |
| description | string Description of the Approval profile |
| enabled required | boolean Enable of the Approval profile |
| expiry | integer <int32> Expiration of the Approval profile in hours |
required | Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "ApprovalProfile1",
- "description": "Detail description of the approval profile",
- "enabled": true,
- "expiry": 30,
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0
}
]
}Response samples
- 200
- 400
- 403
- 404
- 422
Content type
application/json
{- "uuid": "string"
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvals": [
- {
- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string"
}
]
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string",
- "expiry": 0,
- "description": "string",
- "approvalSteps": [
- {
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
- "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
- "description": "string",
- "order": 0,
- "requiredApprovals": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "username": "string",
- "roleName": "string",
- "groupName": "string",
- "approvalStepRecipients": [
- {
- "approvalRecipientUuid": "string",
- "userUuid": "string",
- "username": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "comment": "string"
}
]
}
]
}List of User's Approvals
query Parameters
required | object (PaginationRequestDto) |
required | object (ApprovalUserDto) Select if you want to list all history of approvals by user |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "approvals": [
- {
- "approvalUuid": "string",
- "creatorUuid": "string",
- "creatorUsername": "string",
- "version": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiryAt": "2019-08-24T14:15:22Z",
- "closedAt": "2019-08-24T14:15:22Z",
- "status": "PENDING",
- "resource": "NONE",
- "resourceAction": "string",
- "objectUuid": "string",
- "approvalProfileName": "string",
- "approvalProfileUuid": "string"
}
]
}