Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/jobService/runhistory
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
Time when the run instance finishes.
|
lastStartTime
Date
|
Time when the run instance starts.
|
resultStatus
ResultState
|
Result status of the run instance.
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
PAUSED
PARTIALFAILURE
|
results
PropertyAndValue[]
|
Result list of the run instance.
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Run status of the run instance.
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
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 Response Payload
https://localhost/webacs/api/v1/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v1/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2018-04-06T16:39:56.188Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.188Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.188Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/jobService\/runhistory?jobType="Wireless System"",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"job" : {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : "2018-04-06T16 : 39 : 56.188Z",
"runInstances" : {
"runInstance" : {
"completionTime" : "2018-04-06T16 : 39 : 56.188Z",
"lastStartTime" : "2018-04-06T16 : 39 : 56.188Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : {
"property" : "String value",
"value" : "String value"
}
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/jobService/runhistory
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
Time when the run instance finishes.
|
lastStartTime
Date
|
Time when the run instance starts.
|
resultStatus
ResultState
|
Result status of the run instance.
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
PAUSED
PARTIALFAILURE
|
results
PropertyAndValue[]
|
Result list of the run instance.
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Run status of the run instance.
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
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 Response Payload
https://localhost/webacs/api/v2/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v2/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2018-04-06T16:39:56.192Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.192Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.192Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/jobService/runhistory?jobType="Wireless System"",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"job" : [ {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : 1523032796192,
"runInstances" : {
"runInstance" : [ {
"completionTime" : 1523032796192,
"lastStartTime" : 1523032796192,
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/jobService/runhistory
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
Time when the run instance finishes.
|
lastStartTime
Date
|
Time when the run instance starts.
|
resultStatus
ResultState
|
Result status of the run instance.
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
PAUSED
PARTIALFAILURE
|
results
PropertyAndValue[]
|
Result list of the run instance.
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Run status of the run instance.
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
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 Response Payload
https://localhost/webacs/api/v3/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v3/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2018-04-06T16:39:56.194Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.194Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.194Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
<runInstance>
<completionTime>2018-04-05T16:39:56.194Z</completionTime>
<lastStartTime>2018-04-05T16:39:56.194Z</lastStartTime>
<resultStatus>SUCCESS</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>12</runId>
<runStatus>CREATED</runStatus>
</runInstance>
</runInstances>
</job>
<job>
<description>Another string value</description>
<jobId>12</jobId>
<jobName>Another string value</jobName>
<jobStatus>COMPLETED</jobStatus>
<jobType>Another string value</jobType>
<nextRunTime>2018-04-05T16:39:56.195Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.195Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.195Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
<runInstance>
<completionTime>2018-04-05T16:39:56.195Z</completionTime>
<lastStartTime>2018-04-05T16:39:56.195Z</lastStartTime>
<resultStatus>SUCCESS</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>12</runId>
<runStatus>CREATED</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/jobService/runhistory?jobType="Wireless System"",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"job" : [ {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : "2018-04-06T16:39:56.194Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2018-04-06T16:39:56.194Z",
"lastStartTime" : "2018-04-06T16:39:56.194Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}, {
"completionTime" : "2018-04-05T16:39:56.194Z",
"lastStartTime" : "2018-04-05T16:39:56.194Z",
"resultStatus" : "SUCCESS",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 12,
"runStatus" : "CREATED"
} ]
}
}, {
"description" : "Another string value",
"jobId" : 12,
"jobName" : "Another string value",
"jobStatus" : "COMPLETED",
"jobType" : "Another string value",
"nextRunTime" : "2018-04-05T16:39:56.195Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2018-04-06T16:39:56.195Z",
"lastStartTime" : "2018-04-06T16:39:56.195Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}, {
"completionTime" : "2018-04-05T16:39:56.195Z",
"lastStartTime" : "2018-04-05T16:39:56.195Z",
"resultStatus" : "SUCCESS",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 12,
"runStatus" : "CREATED"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/jobService/runhistory
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
Time when the run instance finishes.
|
lastStartTime
Date
|
Time when the run instance starts.
|
resultStatus
ResultState
|
Result status of the run instance.
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
PAUSED
PARTIALFAILURE
|
results
PropertyAndValue[]
|
Result list of the run instance.
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Run status of the run instance.
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
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 Response Payload
https://localhost/webacs/api/v4/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v4/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2018-04-06T16:39:56.197Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.197Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.197Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
<runInstance>
<completionTime>2018-04-05T16:39:56.197Z</completionTime>
<lastStartTime>2018-04-05T16:39:56.197Z</lastStartTime>
<resultStatus>SUCCESS</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>12</runId>
<runStatus>CREATED</runStatus>
</runInstance>
</runInstances>
</job>
<job>
<description>Another string value</description>
<jobId>12</jobId>
<jobName>Another string value</jobName>
<jobStatus>COMPLETED</jobStatus>
<jobType>Another string value</jobType>
<nextRunTime>2018-04-05T16:39:56.197Z</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2018-04-06T16:39:56.197Z</completionTime>
<lastStartTime>2018-04-06T16:39:56.197Z</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
<runInstance>
<completionTime>2018-04-05T16:39:56.197Z</completionTime>
<lastStartTime>2018-04-05T16:39:56.197Z</lastStartTime>
<resultStatus>SUCCESS</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
<result>
<property>Another string value</property>
<value>Another string value</value>
</result>
</results>
<runId>12</runId>
<runStatus>CREATED</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/jobService/runhistory?jobType="Wireless System"",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"job" : [ {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : "2018-04-06T16:39:56.197Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2018-04-06T16:39:56.197Z",
"lastStartTime" : "2018-04-06T16:39:56.197Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}, {
"completionTime" : "2018-04-05T16:39:56.197Z",
"lastStartTime" : "2018-04-05T16:39:56.197Z",
"resultStatus" : "SUCCESS",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 12,
"runStatus" : "CREATED"
} ]
}
}, {
"description" : "Another string value",
"jobId" : 12,
"jobName" : "Another string value",
"jobStatus" : "COMPLETED",
"jobType" : "Another string value",
"nextRunTime" : "2018-04-05T16:39:56.197Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2018-04-06T16:39:56.197Z",
"lastStartTime" : "2018-04-06T16:39:56.197Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}, {
"completionTime" : "2018-04-05T16:39:56.197Z",
"lastStartTime" : "2018-04-05T16:39:56.197Z",
"resultStatus" : "SUCCESS",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
}, {
"property" : "Another string value",
"value" : "Another string value"
} ]
},
"runId" : 12,
"runStatus" : "CREATED"
} ]
}
} ]
}
}