Retrieve Periods with a Specific Status

REST Resource

GET       /armARCS/rest/periods?status={status}

Required Roles

Service Administrator, Power User, or Viewer

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this API.

Table 17-7 GET PERIODS

Name	Description	Required	Type
`status`	Status of the periods to be retrieved. The value can be one of the following: OPEN - All open periods CLOSED - All closed periods LOCKED - All locked periods PENDING - All pending periods OPEN_PENDING - All open or pending periods ALL - All periods	Yes	Query

Example URLs

https://<BASE-URL>oraclecloud.com/armARCS/rest/periods?status=ALL

https://<BASE-URL>/armARCS/rest/periods?status=OPEN_PENDING

Response

Supported Media Types: application/json

Parameters:

Table 17-8 Parameters

Name	Description
`details`	In case of errors, details are published with the error string
`status`	Status of the request. See Migration Status Codes.
`links`	Detailed information about the link
`href`	Links to API call or status API
`action`	The HTTP call type
`items`	List of periods with the specified status. The format is: `{ "Status": <status code>, "Id": <internal period ID>, "Name": <name of the period> }` The status code can be one of the following: 51 - PENDING 52 - OPEN 53 - CLOSED 54 - LOCKED

Example of Response Body

The following is an example of the response body, in JSON format.

{
  "type": "ARCS",
  "items": [
    {
      "Status": "53",
      "Id": "100000000135004",
      "Name": "January 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135007",
      "Name": "February 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135009",
      "Name": "March 2022"
    },
    {
      "Status": "53",
      "Id": "100000000135011",
      "Name": "April 2022"
    }
  ],
  "status": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/armARCS/rest/periods",
      "action": "GET"
    }
  ]
}