Get all job executions within a time range
get
/iam/governance/selfservice/api/v1/scheduler/history/
Retrieves a paginated list of all execution history within a specified time range.
Request
Query Parameters
-
endDate: string(date-time)
End of the time range in the format - yyyy-MM-dd'T'HH:mm:ss'Z'
-
limit: integer
The numbers of items to return.
-
offset: string
The number of items to skip before starting to collect the result set.
-
orderBy: string
The sort field and the sort order in the format `field:order`. Available values of `field` are *startTime*, *endTime* and *status*. Available values of `order` are *desc* and *asc*.
-
startDate: string(date-time)
Start of the time range in the format - yyyy-MM-dd'T'HH:mm:ss'Z'
-
status: integer
Filter by the status of job execution.
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : History
Type:
Show Source
object-
customStatus(optional):
string
-
errorMessage(optional):
string
-
exceptionObject(optional):
string
-
id(optional):
integer(int32)
-
jobEndTime(optional):
string(date-time)
Format: yyyy-MM-dd'T'HH:mm:ss'Z'
-
jobName(optional):
string
-
jobStartTime(optional):
string(date-time)
Format: yyyy-MM-dd'T'HH:mm:ss'Z'
-
params(optional):
array params
-
status(optional):
string
Allowed Values:
[ "STOPPED", "RUNNING", "INTERRUPTED", "FAILED" ]
400 Response
Invalid input
Examples
The following example shows how to retrieve a paginated list of all execution history within a specified time range by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.
The sort field and the sort order are in the format `field: order`. The available values of field are startTime, endTime, and status. The available values of order are desc and asc.
cURL Example
curl -i -X GET -u username:password \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ 'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/history?limit=10&offset=0'
Example of Response Body
The following example shows the JSON response for a request to retrieve a paginated list of all execution history within a specified time range:
{"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history"
},
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history?offset=0&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history?offset=1&limit=10"
},
{
"rel": "prev",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history?offset=1&limit=10"
},
{
"rel": "next",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog%20Synchronization%20Job/history?offset=10&limit=10"
}
],
"count": 10,
"hasMore": true,
"totalResult": 240,
"histories": [
{
"id": 19994,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T11:43:51Z",
"jobEndTime": "2022-08-22T11:43:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 11:28:51"
}
},
{
"id": 19986,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T11:28:51Z",
"jobEndTime": "2022-08-22T11:28:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 11:13:51"
}
},
{
"id": 19972,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T11:13:51Z",
"jobEndTime": "2022-08-22T11:13:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 10:58:51"
}
},
{
"id": 19965,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T10:58:51Z",
"jobEndTime": "2022-08-22T10:58:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 10:43:51"
}
},
{
"id": 19953,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T10:43:51Z",
"jobEndTime": "2022-08-22T10:43:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 10:28:51"
}
},
{
"id": 19945,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T10:28:51Z",
"jobEndTime": "2022-08-22T10:28:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 10:13:51"
}
},
{
"id": 19931,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T10:13:51Z",
"jobEndTime": "2022-08-22T10:13:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 09:58:51"
}
},
{
"id": 19924,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T09:58:51Z",
"jobEndTime": "2022-08-22T09:58:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 09:43:51"
}
},
{
"id": 19912,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T09:43:51Z",
"jobEndTime": "2022-08-22T09:43:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 09:28:51"
}
},
{
"id": 19904,
"jobName": "Catalog Synchronization Job",
"infotype": "S",
"jobStartTime": "2022-08-22T09:28:51Z",
"jobEndTime": "2022-08-22T09:28:51Z",
"status": "STOPPED",
"params": {
"Process Entitlements": "true",
"Mode": "Incremental",
"Update Date": "",
"Process Roles": "false",
"Process Application Instances": "true",
"File Path": "",
"Updated Date": "08/22/2022 09:13:51"
}
}
],
"offset": 0,
"limit": 10
}