DeviceOperations [alpha]

APIs to get information about device operations

Get all DeviceOperations for a specific Operation

SecurityapiKey

Request

path Parameters

operationsId

required

string <uuid>

ID of the Operation

Example: 5743470f-7dcc-4a92-8a4b-f41b1cea69ed

query Parameters

limit	integer
offset	integer

Responses

200

Device Operation information for the Operation

get/v0/operations/{operationsId}/devices/

Request samples

curl

Response samples

application/json

{"content": {"count": 0,
"previous": "string",
"next": "string",
"results": [{"device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
"state": "CREATED",
"reason": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"command_status": [{"external_domain_operation_id": "4f10c1fa-7078-4edf-ab78-ed83db938797",
"external_domain_state": "QUEUED",
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
}

Get a Operations for a device

SecurityapiKey

Request

path Parameters

deviceId

required

string <uuid>

ID of the Device

Example: 17d384d3-29bd-4dd4-af64-d02b9d6d54ee

Responses

200

Operations information for the Device

get/v0/devices/{deviceId}/operations/

Request samples

curl

Response samples

application/json

{"count": 0,
"previous": "string",
"next": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"operation": "CONVERGE",
"state": "CREATED",
"schedule_type": "IMMEDIATE",
"schedule_args": {"start_datetime": "2019-08-24T14:15:22Z",
"end_datetime": "2019-08-24T14:15:22Z",
"time_type": "console",
"window_start_time": "2019-08-24T14:15:22Z",
"window_end_time": "2019-08-24T14:15:22Z",
"days": [0
]
},
"device_query": { },
"arguments": {"converge_with_provision": true,
"sample_key": "string"
},
"reason": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}
]
}

Get a specific DeviceOperations for a specific Operation

SecurityapiKey

Request

path Parameters

operationsId required	string <uuid> ID of the Operation Example: 5743470f-7dcc-4a92-8a4b-f41b1cea69ed
deviceId required	string <uuid> ID of the Device Example: 17d384d3-29bd-4dd4-af64-d02b9d6d54ee

Responses

200

Device Operation information for the Operation

get/v0/operations/{operationsId}/devices/{deviceId}/

Request samples

curl

Response samples

application/json

{"content": {"operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52",
"device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
"state": "CREATED",
"reason": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"external_domain_operation_status": [{"external_domain_operation_id": "4f10c1fa-7078-4edf-ab78-ed83db938797",
"external_domain_state": "QUEUED",
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"stats": [[{"state": "INITIATED",
"status": "in_progress",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z"
}
]
]
}
}

➔ Next to VPP License Management