Provides a consolidated view of the latest status of all scheduled jobs. Use this resource to get a quick job status check. To query system jobs , specify username=SYSTEM
Since Product Version: 2.2
Resource URL
/webacs/api/v1/data/JobSummaryResponse Parameters
Type | Attribute Name | Description |
---|---|---|
Date |
completionTime |
The time when the latest job run instance finishes |
String |
description |
|
String |
duration |
The timespan of the latest run instance in seconds |
String |
instanceUuid |
This is a uuid for this instance. |
String |
jobName |
The job name. The job name and job type should be unique. |
JobSpecState |
jobStatus |
The job status Allowed values:
|
String |
jobType |
The job type |
Date |
lastStartTime |
The time when the latest job run instance starts |
Date |
nextRunTime |
The time when the next job run instance starts |
ResultState |
resultStatus |
The result of the latest job run instance Allowed values:
|
String |
runId |
The latest run instance id of the job |
WorkState |
runStatus |
The run status of the latest job run instance Allowed values:
|
String |
username |
Who creates the job. For system jobs the value is SYSTEM |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://172.25.123.114/webacs/api/v1/data/JobSummary/15
<?xml version="1.0" ?> <queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/JobSummary/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://172.25.123.114/webacs/api/v1/data/JobSummary/15"> <jobSummaryDTO displayName="String value" id="15" uuid="String value"> <completionTime>2020-07-28T20:29:54.009Z</completionTime> <description>String value</description> <duration>String value</duration> <jobName>String value</jobName> <jobStatus>SCHEDULED</jobStatus> <jobType>String value</jobType> <lastStartTime>2020-07-28T20:29:54.009Z</lastStartTime> <nextRunTime>2020-07-28T20:29:54.009Z</nextRunTime> <resultStatus>UNKNOWN</resultStatus> <runId>String value</runId> <runStatus>UNKNOWN</runStatus> <username>String value</username> </jobSummaryDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/JobSummary/15.json
{ "queryResponse" : { "@type" : "JobSummary", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/JobSummary\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "jobSummaryDTO", "@type" : "JobSummary", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/JobSummary\/15", "jobSummaryDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "completionTime" : "2020-07-28T20 : 29 : 54.009Z", "description" : "String value", "duration" : "String value", "jobName" : "String value", "jobStatus" : "SCHEDULED", "jobType" : "String value", "lastStartTime" : "2020-07-28T20 : 29 : 54.009Z", "nextRunTime" : "2020-07-28T20 : 29 : 54.009Z", "resultStatus" : "UNKNOWN", "runId" : "String value", "runStatus" : "UNKNOWN", "username" : "String value" } } } }