2.6.2 Acquisition of schedule information

Function

Acquires information about the specified schedule.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

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.

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",
  "status" : "status-of-schedule",
  "scheduleType" : "type-of-schedule",
  "createTime" : "created-date-and-time",
  "modifyTime" : "updated-date-and-time",
  "description" : "description-text",
  "scheduledStartTime" : "scheduled-start-time",
  "recurrenceInterval" : "interval-type",
  "recurrenceDayOfWeek" : "interval-of-weekly-job",
  "recurrenceDayOfMonth" : "interval-of-monthly-job",
  "recurrenceLastDayOfMonth" : {true|false},
  "recurrenceStartDate" : "recurrence-start-date",
  "recurrenceTime" : "exec-time-of-day",
  "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
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

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 55fb30b1218f2ceec1b52d59d1b77b267895821_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810
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
}