CZERTAINLY Scheduler API (2.13.1)
Download OpenAPI specification:Download
REST API for managing Scheduler and its jobs in the platform
Response samples
- 200
Content type
application/json
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "objectData": { }
}Edit Scheduled job
path Parameters
| uuid required | string Scheduled job UUID |
Request Body schema: application/jsonrequired
| cronExpression | string Cron expression for job schedule |
Responses
Request samples
- Payload
Content type
application/json
{- "cronExpression": "string"
}Response samples
- 200
Content type
application/json
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
- "objectData": { }
}Response samples
- 200
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "scheduledJobs": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "jobName": "string",
- "jobType": "string",
- "cronExpression": "string",
- "enabled": true,
- "oneTime": true,
- "system": true,
- "lastExecutionStatus": "started"
}
]
}Scheduled job history
path Parameters
| uuid required | string Scheduled job UUID |
query Parameters
required | object (PaginationRequestDto) |
Responses
Response samples
- 200
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "scheduledJobHistory": [
- {
- "jobUuid": "f6cd1d43-0519-40a4-895b-ab314e905ac3",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "status": "started",
- "resultMessage": "string",
- "resultObjectType": "NONE",
- "resultObjectIdentification": [
- "string"
]
}
]
}