REST API for Configurator v1.0

Resource: jobs

All scheduled/inprogress/completed job list.

http://{device}/api/cmc.configurator/1.0/jobs{?job_status,feature_id,after,before}

JSON

[ job ]

[ job ]

Property Name	Type	Description	Notes
jobs	<array of <job>>	All scheduled/inprogress/completed job list.
jobs[items]	<job>	Job Scheduling resource.

Links

jobs: get

Retrieve all push config job details.

GET http://{device}/api/cmc.configurator/1.0/jobs{?job_status,feature_id,after,before}

Response Body

Returns a jobs data object.

jobs: create

Schedule a push config job.

POST http://{device}/api/cmc.configurator/1.0/jobs{?job_status,feature_id,after,before}

Request Body

Provide a job data object.

Response Body

Returns a job data object.

Resource: job

Job Scheduling resource.

http://{device}/api/cmc.configurator/1.0/jobs/items/{id}

JSON

{
  "id": integer,
  "site_ids": [
    integer
  ],
  "appliance_serial_numbers": [
    string
  ],
  "operation": string,
  "idx": integer,
  "timestamp": integer,
  "site_type_ids": [
    integer
  ],
  "feature_ids": [
    integer
  ],
  "creation_time": integer,
  "push_time": multiple,
  "completion_time": multiple,
  "error_text": multiple,
  "job_status": string,
  "backup": boolean,
  "detailed_status": [
    {
      "feature_id": integer,
      "status": interpreter_job_status,
      "serialnum": string,
      "result": interpreter_job_result,
      "error_text": multiple
    }
  ]
}

{
  "id": integer,
  "site_ids": [
    integer
  ],
  "appliance_serial_numbers": [
    string
  ],
  "operation": string,
  "idx": integer,
  "timestamp": integer,
  "site_type_ids": [
    integer
  ],
  "feature_ids": [
    integer
  ],
  "creation_time": integer,
  "push_time": multiple,
  "completion_time": multiple,
  "error_text": multiple,
  "job_status": string,
  "backup": boolean,
  "detailed_status": [
    {
      "feature_id": integer,
      "status": interpreter_job_status,
      "serialnum": string,
      "result": interpreter_job_result,
      "error_text": multiple
    }
  ]
}

Property Name	Type	Description	Notes
job	<object>	Job Scheduling resource.	Required properties: [feature_ids];
job.id	<integer>		Read-only; Optional;
job.site_ids	<array of <integer>>	Array of site ids.	Optional; Minimum: 1 items;
job.site_ids[items]	<integer>
job.appliance_serial_numbers	<array of <string>>	Array of appliance serial number.	Optional; Minimum: 1 items;
job.appliance_serial_numbers[items]	<string>
job.operation	<string>		Optional;
job.idx	<integer>		Optional;
job.timestamp	<integer>		Optional;
job.site_type_ids	<array of <integer>>	Array of site types to push onto.	Optional; Minimum: 1 items;
job.site_type_ids[items]	<integer>
job.feature_ids	<array of <integer>>	Array of feature ids.	Minimum: 1 items;
job.feature_ids[items]	<integer>
job.creation_time	<integer>	Creation time of the job.	Read-only; Optional;
job.push_time	<multiple>	Push time of the job. This will be present for jobs whose state is one of 'IN_PROGRESS', 'FAILED', 'SUCCESS'	Optional;
job.push_time.anyOf[0]	<integer>		Read-only;
job.push_time.anyOf[1]	<null>
job.completion_time	<multiple>	Completion time of the job.	Optional;
job.completion_time.anyOf[0]	<integer>		Read-only;
job.completion_time.anyOf[1]	<null>
job.error_text	<multiple>	Error text if pre push failed. Key needs to be checked if it exist before you try to access it.	Optional;
job.error_text.anyOf[0]	<string>		Read-only;
job.error_text.anyOf[1]	<null>
job_status	<string>	Status of the submitted job.	Read-only; Values: Queued, InProgress, Failed, Success, Canceled;
job.backup	<boolean>	Flag to indicate if the user wants to take a back up or not.	Optional;
job.detailed_status	<array of <object>>		Read-only; Optional;
job.detailed_status[items]	<object>		Read-only;
job.detailed_status[items].feature_id	<integer>		Read-only; Optional;
job.detailed_status[items].status	<interpreter_job_status>	The status of the job submitted to the interpreter	Read-only; Values: Pending, Running, Completed;
job.detailed_status[items].serialnum	<string>		Read-only; Optional;
job.detailed_status[items].result	<interpreter_job_result>	the result of the job submitted to the interpreter	Read-only; Values: Fail, Success;
job.detailed_status[items].error_text	<multiple>	Error text if push pushed for a particular feature.	Read-only; Optional;
job.detailed_status[items].error_text. anyOf[0]	<string>		Read-only;
job.detailed_status[items].error_text. anyOf[1]	<null>		Read-only;
job.oneOf[0]	<object>		Required properties: [site_ids];
job.oneOf[0].<prop>	<any>		Optional;
job.oneOf[1]	<object>		Required properties: [appliance_serial_numbers];
job.oneOf[1].<prop>	<any>		Optional;
job.oneOf[2]	<object>		Required properties: [site_type_ids];
job.oneOf[2].<prop>	<any>		Optional;

Links

job: get

Retrieve a push config job deatils

GET http://{device}/api/cmc.configurator/1.0/jobs/items/{id}

Response Body

Returns a job data object.

job: cancel

Cancel a push config job details

POST http://{device}/api/cmc.configurator/1.0/jobs/items/{id}/cancel

Request Body

Do not provide a request body.

Response Body

Returns a job data object.

Relations

job: instances

Related resource

jobs

Resource: feature

Resource to get a particular feature.

http://{device}/api/cmc.configurator/1.0/features/items/{id}

JSON

{
  "id": integer,
  "name": string,
  "pretty_name": string,
  "description": string,
  "push_enable": boolean
}

{
  "id": integer,
  "name": string,
  "pretty_name": string,
  "description": string,
  "push_enable": boolean
}

Property Name	Type	Description	Notes
feature	<object>	Resource to get a particular feature.	Required properties: [push_enable];
feature.id	<integer>		Read-only; Optional;
feature.name	<string>	Name of the feature.	Read-only; Optional;
feature.pretty_name	<string>	Pretty name of the feature.	Read-only; Optional;
feature.description	<string>	Description of the feature.	Read-only; Optional;
feature.push_enable	<boolean>	Whether push should be enabled for this feature or not.

Links

feature: get

Retrieve the feature specific information.

GET http://{device}/api/cmc.configurator/1.0/features/items/{id}

Response Body

Returns a feature data object.

feature: set

Set a specific feature.

PUT http://{device}/api/cmc.configurator/1.0/features/items/{id}

Request Body

Provide a feature data object.

Response Body

Returns a feature data object.

Resource: features

Resource to get the features supported.

http://{device}/api/cmc.configurator/1.0/features{?name}

JSON

[ feature ]

[ feature ]

Property Name	Type	Description	Notes
features	<array of <feature>>	Resource to get the features supported.
features[items]	<feature>	Resource to get a particular feature.

Links

features: get

Retrieve the features supported for push.

GET http://{device}/api/cmc.configurator/1.0/features{?name}

Response Body

Returns a features data object.

Type: job_status

The status of the job

JSON

string

string

Property Name	Type	Description	Notes
job_status	<string>	The status of the job	Read-only; Values: Queued, InProgress, Failed, Success, Canceled;

Type: interpreter_job_status

The status of the job submitted to the interpreter

JSON

string

string

Property Name	Type	Description	Notes
interpreter_job_status	<string>	The status of the job submitted to the interpreter	Read-only; Values: Pending, Running, Completed;

Type: interpreter_job_result

the result of the job submitted to the interpreter

JSON

string

string

Property Name	Type	Description	Notes
interpreter_job_result	<string>	the result of the job submitted to the interpreter	Read-only; Values: Fail, Success;