Skip to content

Create an Operation for Operation List
Stable

Request

Adds a new Operation to an existing Operation List in Esper's Pipelines system.

Send the operation_type (e.g. LOCK, REBOOT, WIPE, INSTALL, SIMPLE_INSTALL, UNINSTALL, SET_KIOSK_APP, SET_WALLPAPER) and its args in the request body; the created Operation is returned and becomes one of the actions performed when the parent Stage runs.

This is the Pipelines Operations endpoint. Use the Operations API for command operations (dispatch commands).

About Operation Lists

An Operation List holds one or more Operations — the individual device actions a Pipeline Stage performs against its targeted devices. Grouping Operations into a list lets a single stage execute multiple actions in sequence when its Stage Run processes. This is an authenticated SCAPI endpoint.

Key Fields / Query Parameters

  • operation_type — the action to perform (e.g. LOCK, REBOOT, WIPE, INSTALL, SET_KIOSK_APP, etc.)
  • args — object containing the arguments for the selected operation_type

Common Use Cases

  • Adding a device action to a stage's operation list while building out a pipeline
Security
pipelines_SCAPIAuthToken
Path
operationlist_idstringrequired

ID of the Operation List

Bodyapplication/jsonrequired
argsobject

Arguments for the operation

operation_typestring
Enum:"LOCK""REBOOT""SET_NEW_POLICY""UPDATE_HEARTBEAT""REQUEST_BUGREPORT""REQUEST_DPCLOG""ADD_TO_WHITELIST""REMOVE_FROM_WHITELIST""SET_APP_PERMISSION""WIPE"
cURL
curl -i -X POST \
  'https://api.esper.io/_mock/openapi/pipelines/v0/operationlists/{operationlist_id}/operations/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "args": {},
    "operation_type": "LOCK"
  }'

Responses

Created operation

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_Operation)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "operation_list_id": "string",
    "pipeline_id": "string",
    "operation_type": "string",
    "args": "string",
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}