Skip to content

Create a new Operation

Request

Security
apiKey
Bodyapplication/jsonrequired
operation_typestring
Enum:"CONVERGE""INSTALL""UNINSTALL""INSTALL_APP""UNINSTALL_APP""REBOOT""LOCK""SHUT_DOWN""WIPE""ADD_EMM_ACCOUNT"
schedule_typestring

Following Schedule types are supported

* IMMEDIATE: Schedule the command to execcute Immediately
* WINDOW: Schedule the command to execute within the given window
Enum:"IMMEDIATE""WINDOW"
schedule_argsobject(ScheduleArgs)
operation_device_queryobject

A flexible JSON object to define device properties and filters.

argumentsobject
cURL
curl -i -X POST \
  https://develop-api.esper.io/_mock/openapi/v0/operations/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation_type": "CONVERGE",
    "schedule_type": "IMMEDIATE",
    "schedule_args": {
      "start_datetime": "2024-08-08T19:13:36.969Z",
      "end_datetime": "2024-08-08T19:13:36.969Z",
      "time_type": "console",
      "window_start_time": "2024-08-08T19:00:00Z",
      "window_end_time": "2024-08-08T20:00:00Z",
      "days": [
        0
      ]
    },
    "operation_device_query": {
      "device_ids": "460a4c28-b974-4c20-99b5-29aa6f10054f,560a4c28-b974-4c20-99b5-29aa6f10054e"
    },
    "arguments": {
      "converge_with_provision": true,
      "sample_key": "value"
    }
  }'

Responses

Operation information for the Tenant

Bodyapplication/json
contentobject(OperationWithStats)
Response
{
  "content": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "operation": "CONVERGE",
    "state": "CREATED",
    "schedule_type": "IMMEDIATE",
    "schedule_args": { … },
    "operation_device_query": {},
    "arguments": { … },
    "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",
    "operation_activity": [ … ],
    "operation_stats": { … }
  }
}