Configurations

get__configurations_list

Code samples

GET /configurations/list HTTP/1.1

Accept: application/json

GET /configurations/list

View server configurations.

Parameters

Name	In	Type	Required	Description
pending	query	boolean	false	Filter pending configurations.
inProgress	query	boolean	false	Filter in progress server configurations.
success	query	boolean	false	Filter successful configurations.
failure	query	boolean	false	Filter unsuccessful configurations.
allSystems	query	boolean	false	Show configurations for all systems.
top	query	integer(int64)	false	Show top configurations.
descendingOrder	query	boolean	false	Sort the results in a descending order.

Example responses

200 Response

{
  "Data": [
    {
      "Id": 0,
      "System": "string",
      "PlatformVersion": 0,
      "ServiceConfigId": 0,
      "State": "Unknown",
      "Type": "UnversionedConfig",
      "Description": "string",
      "StartTime": "2019-08-24T14:15:22Z",
      "EndTime": "2019-08-24T14:15:22Z",
      "ErrorMessage": "string",
      "Async": true
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	ConfigurationElementApiResult
400	Bad Request	Bad Request	string

get__configurations_session_list

Code samples

GET /configurations/session/list HTTP/1.1

Accept: application/json

GET /configurations/session/list

View current session configurations.

Parameters

Name	In	Type	Required	Description
jobids	query	array[integer]	false	Filter specified jobs by ids.
sync	query	boolean	false	Filter sync only configurations.
async	query	boolean	false	Filter async only configurations.
top	query	integer(int64)	false	Show top configurations.
includeDummy	query	boolean	false	Include dummy jobs.
descendingOrder	query	boolean	false	Sort the results in a descending order.

Example responses

200 Response

{
  "Data": [
    {
      "Id": 0,
      "System": "string",
      "PlatformVersion": 0,
      "ServiceConfigId": 0,
      "State": "Unknown",
      "Type": "UnversionedConfig",
      "Description": "string",
      "StartTime": "2019-08-24T14:15:22Z",
      "EndTime": "2019-08-24T14:15:22Z",
      "ErrorMessage": "string",
      "Async": true
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	ConfigurationElementApiResult
400	Bad Request	Bad Request	string