Create job (New API)

post

https://icc-dev.aylanetworks.com/icc/v2/jobs

This API creates a job. This single API covers filter, schedule, and OTA/Property/File Transfer jobs. This API provides efficient solution (when compared to the existing solution) to create a new job and better customer experience.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Job name.

type_id

int32

required

Job type identifier number. Any one of the following:
1: Set properties
2: OTA
3: File transfer

filter_id

int32

required

Unique filter identifier number

exec_method

string

required

Execution method: "ONE_TIME" or "CONTINUOUS".

delivery_option

string

Delivery option: "SYSTEM_PUSH" or "USER_CONSENT".

oem_model

string

OEM Model (required for Job or Filter)

description

string

Short description of the job.

job_metadata

object

List of data objects.

retries

int32

Defaults to 0

Number of retry if one of the action of the device is failure, how many times should retry the action.

action_payload

json

An object that is used for job action, the payload depends on different type of action.

stage_config

json

A JSON string containing the stage configuration for the job.
Example:
stage_config: [ { stage: 1, devices: 10 }, { stage: 2, devices: * } ]

filter

json

filter_id or filter. This is same as Filter Creation payload. For more information, please refer: Create filter

schedule

json

This is same as Schedule Creation payload. For more information, please refer: Create schedule

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created