9.5.2 Acquisition of schedule information

Function

Acquires information about the specified schedule.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

GET http://host:port/Automation/version/objects/Schedules/id

Status code

The following table describes the various status codes that can be returned as the response to a request.

Status code	Message	Description
200	OK	Processing has been successfully completed.
401	Unauthorized	The user does not have login permission.
404	Not found	The permission is invalid, or the resource does not exist.
412	Precondition failed	The server is not available.
500	Server-side error	A server processing error occurred.

Response schema

The following shows the structure of the response body for a request.

{
  "instanceID" : instance-id,
  "name" : "registered-service-name",
  "submitter" : "submit-user-name",
  "scheduleType" : "type-of-schedule",
  "createTime" : "created-date-and-time",
  "modifyTime" : "updated-date-and-time",
  "description" : "description-text",
  "serviceState" : "service-state",
  "serviceID" : service-id
}

Usage example

In the following example, the API acquires information about the schedule whose instanceID is 2060.

Request header:

GET /Automation/v1/objects/Schedules/2060 HTTP/1.1
Host:10.196.184.238:22015
Accept:application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:26:19 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 32bd25936120d68dceabcb49493079f8ef82a4_V0300
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json

Response body:

{
  "instanceID" : 2060,
  "name" : "testService1_20140714044426_Resubmit",
  "submitter" : "System",
  "scheduleType" : "immediate",
  "createTime" : "2014-07-14T05:19:39.000-0700",
  "modifyTime" : "2014-07-14T05:19:39.000-0700",
  "description" : "",
  "serviceState" : "release",
  "serviceID" : 2015
}

To Page Top