Matching results

Operations


Operations are created when responses may take some time to be processed. In this case, execution is done asynchronously. An operation gives the possibility to trace this execution and to know whether the response is already available or not. Operations may manipulate several entities. For each entity a task is created. Once the operation finished, a report is generated where it is possible to see all successful tasks and those who have failed.

Operation triggers give the possibility to automatically create new operation when some conditions are met. For now, the only available conditions are:

  • The reception of an alert for a given rule,
  • The reception of an alert state change for a given rule.
The created operation only applies on the target referenced in the alert or alert state change event.


Read only fields are computed by AirVantage and can only be seen on response fragments sent by find request.

Operation fields

Field Description Read Only Type
uid Operation's unique identifier. true uid
state Shows the state of the operation. Possible values are:
SCHEDULED, IN_PROGRESS, FINISHED.
true enum
category [DEPRECATED] Operation's category. The only possible value is TASK. true enum
entity The entity type the operation is working on. Possible values are:
APPLICATION, SYSTEM, GATEWAY, SUBSCRIPTION, ALERT, PARTNER.
true enum
type [DEPRECATED] The type of operation launched. For instance:
ACTIVATE, SYNCHRONIZE, IMPORT, ...
This attribute is deprecated. Use 'operationType' attribute.
true enum
operationType The type of operation launched. For instance:
SYSTEM_ACTIVATE, SYSTEM_SYNCHRONIZE, SYSTEM_IMPORT, SUBSCRIPTION_ACTIVATE, ...
true enum
report [DEPRECATED] URL to download the operation's report. true string
createdAt Date time when this operation was created. true timestamp
startDate Date time when this operation was scheduled. true timestamp
cancelDate Date time when this operation was cancelled. true timestamp
timeoutDate Date time when this operation is considered as expired. true timestamp
endDate Date time when this operation finished its execution. true timestamp
counters Show how many tasks are in each state. true
total Total number of tasks launched by this operation. true int
target Entity's unique identifier the operation is working on. It is null when the operation works on several entities. true uid
targetCount [DEPRECATED] Total number of entities the operation is working on.
This attribute is deprecated. Use 'total' attribute.
true int
user User having launched this operation. Email is shown. true string
company Context company. true uid
input Input used to create the operation:
  • the list of target's uids
  • the label
  • the file name
  • the identifier of the parent operation
true object
details Details of the operation. The content is specific to a type of operation. Can be null. true object
messages List of messages. Each message is formatted with a date, type (INFO, WARNING, ERROR), and a description. true object array

Task fields

Field Description Read Only Type
uid Task's unique identifier. true uid
state State of the task. Possible values are:
PENDING, IN_PROGRESS, CANCELLED, FAILURE, SUCCESS.
true enum
createdAt Date time when the task was created. true timestamp
executedAt Date time when the task was executed. true timestamp
date Date time when the task was updated for the last time. true timestamp
target The unique identifier of the entity related to this task. This field will remain null until the task is executed. Can be null in case of failure. true uid
targetDescription Description of the target linked to the task.
The description depends on the target type (system, gateway, ...).
true object
rank The rank of the task.
If a file is used as input of the operation, the rank represents a line number.
The tasks of an operation are processed by rank order.
true int
input Shows the input of this task. Generally, it contains information about the entity processed by this task.
If a file is used as input of the operation, this field contains the line having for line number the value defined by the field 'rank'.
true string
messages List of messages. Each message is formatted with a date, type (INFO, WARNING, ERROR), and a description. true object array
operation Simple description (UID and type) of the operation owning the task.
Only returned by Find Tasks of a Target API
true object

Operation trigger fields

Field Description Read Only Type
uid Trigger's unique identifier. true uid
type The type of event for which a new operation must be created. Possible values are:
  • ON_ALERT: on alert reception,
  • ON_ALERT_STATE_CHANGE: on alert state change reception, whatever the state is,
  • ON_ALERT_STATE_CHANGE_TRUE: on alert state change reception, when state becomes true,
  • ON_ALERT_STATE_CHANGE_FALSE: on alert state change reception, when state becomes false.
false enum
filter The alert rule id used to filter alert/alert state change events. false string
operationType The type of the operation to create:
  • SYSTEM_SEND_COMMAND,
  • SYSTEM_APPLY_SETTINGS,
  • SYSTEM_SUSPEND,
  • SYSTEM_CHANGE_OFFER,
  • SYSTEM_CHANGE_LABEL.
false enum
email The email of the user who will be notified of operation final status false string
notify True if the user has to be notified, false otherwise. false boolean
callback The url that will be called when the operation state changes. false string
parameters The specific parameters of the operation to create. See system page for more information about operations parameters. false object

This is a complete representation of an Operation. This fragment can be used for create or edit requests. Please refer to the fields section to know which fields can be modified.

{
   "uid": "",
   "state": "",
   "category": "",
   "entity": "",
   "type": "",
   "operationType": "",
   "report": "",
   "createdAt": ,
   "startDate": ,
   "cancelDate": ,
   "timeoutDate": ,
   "endDate": ,
   "counters":       [
               {
         "state": "PENDING",
         "count": 0
      },
               {
         "state": "IN_PROGRESS",
         "count": 1
      },
               {
         "state": "CANCELLED",
         "count": 0
      },
               {
         "state": "FAILURE",
         "count": 0
      },
               {
         "state": "SUCCESS",
         "count": 2
      }
   ],
   "total": ,
   "target": "",
   "targetCount": ,
   "user": "",
   "company": "",
   "input":    {},
   "details": {},
   "messages": []
}

This is a complete representation of a task.

{
    "state": "FAILURE",
    "target": "9196f4944c294a168ae5d72f5d0007bf",
    "operation": {
        "operationType": "SYSTEM_RETRIEVE_DATA",
        "uid": "138a50ec5d014db0ace31de5257fb73a"
    },
    "date": 1503325920743,
    "input": null,
    "targetDescription": {
        "uid": "9196f4944c294a168ae5d72f5d0007bf",
        "name": "My System"
    },
    "messages": [
        {
            "date": 1503325920741,
            "type": "ERROR",
            "message": "operation.on.system.missing.comm.identifiers"
        }
    ],
    "createdAt": 1503325920647,
    "executedAt": 1503325920686,
    "rank": 0,
    "uid": "015e05351d86485980a19d068a84ca84"
}

This is a complete representation of an operation trigger. This fragment can be used for create or edit requests.

{
    "type": "ON_ALERT",
    "filter": "0f3919fd1ac0403ab9e70ae2c3729a21",
    "operationType": "SYSTEM_SEND_COMMAND",
    "notify": true,
    "callback": "http://blabla.com",
    "parameters": {
        "commandId": "home.ChangeTemperature",
        "protocol": "REST",
        "parameters": {"Temperature": 20},
        "application": {
            "uid": "333ea6a2d6e44a00aee2804ed519128a"
        },
        "requestConnection": false
    }
}

/api/v1/operations

Returns a paginated list of operations with their complete details sorted by startDate descending.

It is possible to restrain the result list using criteria parameters.

The fields parameter has to be defined in order to specify the attributes of the operation which will be returned.
If fields parameter is missing, only the following attributes of the operation are returned: uid, state, category, entity, type, operationType, createdAt, startDate, endDate, timeoutDate, cancelDate.

More information about paging, filtering, and sorting here

Request

GET https://na.airvantage.net/api/v1/operations?fields=uid,state,category,operationType,createdAt

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "items": [   {
      "uid": "0f3919fd1ac0403ab9e70ae2c3729a21",
      "state": "FINISHED",
      "category": "TASK",
      "operationType": "GATEWAY_IMPORT",
      "createdAt": 1362489511437
   }],
   "count": 1,
   "size": 1,
   "offset": 0
}
Name Description Use Default Type Operand
uid Return operation whose uid match with the specified id. optional null uid =
user Returns all operations created by the user whose the email contains the specified string. optional null string like
category [DEPRECATED] Returns all operations matching the given category. The only possible value is TASK. optional null string =
entities Returns all operations whose entity is in the given list. Entities are APPLICATION, SYSTEM, GATEWAY, SUBSCRIPTION, PARTNER, ALERT. optional null string list in
types [DEPRECATED] Returns all operations whose type is in the given list.
This criteria is deprecated. Use 'operationTypes' criteria.
optional null string list in
operationTypes Returns all operations whose operation type is in the given list. optional null string list in
states Returns all operations whose state is in the given list. States are SCHEDULED, IN_PROGRESS, FINISHED. optional null string list in
startedAfter Return all operations started after the given date. The specified date is included. optional null timestamp >=
startedBefore Return all operations started before the given date. The specified date is included. optional null timestamp <=
endedAfter Return all operations ended after the given date. The specified date is included. optional null timestamp >=
endedBefore Return all operations ended before the given date. The specified date is included. optional null timestamp <=
target Returns all operations linked to the specified target uid. Target can be application, system, gateway, subscription. optional null string =
company Set the context company. optional caller's company uid =
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view
Fields uid, state, category, entity, type, operationType, createdAt, startDate, endDate, timeoutDate, cancelDate, counters, total, target, targetCount, report, user, company

/api/v1/operations/{uid}

Gets the details of an operation.

Request

GET https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "0f3919fd1ac0403ab9e70ae2c3729a21",
   "state": "FINISHED",
   "category": "TASK",
   "entity": "GATEWAY",
   "type": "IMPORT",
   "startDate": 1362489511437,
   "endDate": 1362489512865,
   "counters":    [
            {
         "state": "PENDING",
         "count": 0
      },
            {
         "state": "IN_PROGRESS",
         "count": 0
      },
            {
         "state": "CANCELLED",
         "count": 0
      },
            {
         "state": "FAILURE",
         "count": 0
      },
            {
         "state": "SUCCESS",
         "count": 2
      }
   ],
   "total": 2,
   "target": null,
   "targetCount": 2,
   "user": "user@airvantage.net",
   "company": "3d259644960649d99b09a85cad44f976",
   "operationType": "GATEWAY_IMPORT",
   "createdAt": 1362489511437,
   "cancelDate": null,
   "timeoutDate": 1370261911437,
   "input":    {
      "uids": null,
      "label": null,
      "filename": "gateways.csv",
      "dependsOn": null
   },
   "details": {"header": "IMEI,SERIAL NUMBER,MAC ADDRESS,TYPE"},
   "messages": []
}
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view

/api/v1/operations/{uid}/tasks

Returns, for an operation, a paginated list of tasks with their complete details sorted by rank.

It is possible to restrain the result list using criteria parameters.

The fields parameter has to be defined in order to specify the attributes of the operation which will be returned.
If fields parameter is missing, only the following attributes of the operation are returned: uid, date, rank, state, target.

More information about paging, filtering, and sorting here

Request

GET https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/tasks

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "items":    [
            {
         "uid": "e7ded7e286924d37b0db3ebc7d74edc1",
         "date": 1362489512832,
         "rank": 2,
         "state": "SUCCESS",
         "target": "da7032315d644f62aee3809a9ad5610d",
         "targetDescription":          {
            "uid": "da7032315d644f62aee3809a9ad5610d",
            "serialNumber": null,
            "imei": "353270040002745",
            "macAddress": "0C:12:24:F1:A0:A1",
            "type": "M2MBoxPro"
         },
         "input": "353270040002745,,0C:12:24:F1:A0:A1,M2MBoxPro,OpenAT",
         "messages": []
      },
            {
         "uid": "c8c19122dbb44ec99655036a78888c26",
         "date": 1362489512832,
         "rank": 3,
         "state": "SUCCESS",
         "target": "b7a6779b69994809b7f17fae0372047b",
         "targetDescription":          {
            "uid": "b7a6779b69994809b7f17fae0372047b",
            "serialNumber": null,
            "imei": "353270040002746",
            "macAddress": "0C:12:24:F1:A1:A1",
            "type": null
         },
         "input": "353270040002746,,0C:12:24:F1:A1:A1,,",
         "messages": []
      }
   ],
   "count": 2,
   "size": 2,
   "offset": 0
}
Name Description Use Default Type Operand
uid Return the task whose uid match with the specified id. optional null uid =
states Returns all tasks whose state is in the given list. States are PENDING, IN_PROGRESS, CANCELLED, FAILURE, SUCCESS. optional null string list in
target Returns the task linked to the specified target uid. Target can be application, system, gateway, subscription, alert, partner. optional null string =
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view
Fields uid, date, rank, state, target, targetDescription, input, messages

/api/v1/operations/{operation-uid}/tasks/{task-uid}

Gets the details of a task owned by an operation.

Request

GET https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/tasks/e7ded7e286924d37b0db3ebc7d74edc1

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "e7ded7e286924d37b0db3ebc7d74edc1",
   "date": 1362489512832,
   "rank": 2,
   "state": "SUCCESS",
   "target": "da7032315d644f62aee3809a9ad5610d",
   "targetDescription": {
      "uid": "da7032315d644f62aee3809a9ad5610d",
      "serialNumber": null,
      "imei": "353270040002745",
      "macAddress": "0C:12:24:F1:A0:A1",
      "type": "M2MBoxPro"
   },
   "input": "353270040002745,,0C:12:24:F1:A0:A1,M2MBoxPro,OpenAT",
   "messages": []
}
Name Description
operation.unknown Raised when the specified operation is unknown.
operation.task.unknown Raised when the specified task is unknown or is not owned by the specified operation.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view

/api/v1/operations/{uid}/report

Returns a complete report of an operation. It contains more information about the operation's execution like message errors, files exchanged, etc.
Deprecated API: use Get operation details and Get tasks

Request

GET https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/report?format=XML

Response
200 OK

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Disposition: attachment; filename=operation-report-0f3919fd1ac0403ab9e70ae2c3729a21.xml
...
Name Description Use Default Type
format Return operation report in the specific format. Possible formats are: XML or JSON optional XML string =
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view

/api/v1/operations/{uid}/result

Returns the generated file in case this operation was in charge to export some data.

Request

GET https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/result

Response
200 OK

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Disposition: attachment; filename=data_export_2013_03_05_16-46-10_UTC.csv
...
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view

/api/v1/operations/{uid}/cancel

Cancels a specific operation.
All tasks which are not terminated will be cancelled.
The operation will be finished when all its tasks will be terminated (SUCCESS, FAILURE or CANCELLED).

Request

POST https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/cancel

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "0f3919fd1ac0403ab9e70ae2c3729a21",
   "state": "FINISHED",
   "category": "TASK",
   "entity": "GATEWAY",
   "type": "IMPORT",
   "startDate": 1362502507692,
   "endDate": 1362502581091,
   "counters":    [
            {
         "state": "PENDING",
         "count": 0
      },
            {
         "state": "IN_PROGRESS",
         "count": 10
      },
            {
         "state": "CANCELLED",
         "count": 0
      },
            {
         "state": "FAILURE",
         "count": 1
      },
            {
         "state": "SUCCESS",
         "count": 2
      }
   ],
   "total": 13,
   "target": null,
   "targetCount": 2,
   "user": "user@airvantage.net",
   "company": "3d259644960649d99b09a85cad44f976",
   "operationType": "GATEWAY_IMPORT",
   "createdAt": 1362502507692,
   "cancelDate": 1362502540121,
   "timeoutDate": 1370274907692
}
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
operation.invalid.state The operation is finished. It cannot be cancelled.
operation.already.cancelled The operation is already cancelled
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions The same right which is required to launch the operation

/api/v1/operations/{operation-uid}/tasks/{task-uid}/cancel

Cancels a task of an operation.
A task already terminated (SUCCESS, FAILURE or CANCELLED) cannot be cancelled.

Request

POST https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/tasks/e7ded7e286924d37b0db3ebc7d74edc1/cancel

Response
200 OK

HTTP/1.1 200 OK
Content-Length: 0
Name Description
operation.unknown Raised when the specified operation is unknown.
operation.task.unknown Raised when the specified task is unknown or is not owned by the specified operation.
operation.invalid.state The operation is finished. The task cannot be cancelled.
operation.task.invalid.state The task is already finished. It cannot be cancelled.
operation.already.cancelled The operation is already cancelled
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions The same right which is required to launch the operation

/api/v1/operations/{uid}/retry

Retries an operation.
A new operation is created to perform the retry. This operation is based on the FAILURE and CANCELLED tasks of the operation to retry.
All operations can be retried except the operations using files (import, bulk edit, application release).

Request

POST https://na.airvantage.net/api/v1/operations/0f3919fd1ac0403ab9e70ae2c3729a21/retry

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
  "operation":"848d850a92994b089db07b3848faa6d4"
}
Name Description
operation.unknown Raised when the 'uid' points to an unknown operation.
operation.invalid.state The operation is running. It cannot be retried.
operation.not.retriable The operation cannot be retried.
operation.no.task.to.retry The operation cannot be retried: there is no failure or cancelled tasks
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions The same right which is required to launch the operation

/api/v1/operations/tasks

Returns, for a target, a paginated list of tasks sorted by createdAt descending.

It is possible to restrain the result list using criteria parameters.

The fields parameter has to be defined in order to specify the attributes of the operation which will be returned.
If fields parameter is missing, only the following attributes of the operation are returned: uid, date, createdAt, executedAt, rank, state, target.

More information about paging, filtering, and sorting here

Request

GET https://na.airvantage.net/api/v1/operations/tasks?target=9196f4944c294a168ae5d72f5d0007bf&fields=uid,state,createdAt,operation&size=1

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
    "items": [
        {
            "state": "FAILURE",
            "operation": {
                "operationType": "SYSTEM_RETRIEVE_DATA",
                "uid": "138a50ec5d014db0ace31de5257fb73a"
            },
            "createdAt": 1503325920647,
            "uid": "015e05351d86485980a19d068a84ca84"
        }
    ],
    "count": 4,
    "size": 1,
    "offset": 0
}
Name Description Use Default Type Operand
target Return tasks of the specified target. required null uid =
uid Return tasks whose uid match with the specified id. optional null uid =
operationUid Return the task matching the specified operation id. optional null uid =
operationTypes Returns all tasks whose operation type is in the given list. optional null string list in
states Returns all tasks whose state is in the given list. States are PENDING, IN_PROGRESS, CANCELLED, FAILURE, SUCCESS. optional null string list in
createdAfter Return all operations created after the given date. The specified date is included. optional null timestamp >=
createdBefore Return all operations created before the given date. The specified date is included. optional null timestamp <=
company Set the context company. optional caller's company uid =
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.applications.view
entities.gateways.view
entities.system.view
entities.subscriptions.view
accountNetwork.partner.view
Fields uid, date, createdAt, executedAt, rank, state, target, targetDescription, input, messages, operation

/api/v1/operations/triggers

Retrieves all the triggers of a company.

Request

GET https://na.airvantage.net/api/v1/operations/triggers

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
[
   {
      "uid":"984f47c347df411ea101f0f90ab65cd8",
      "type":"ON_ALERT",
      "filter":"34a1f6611d42487783014e6589c97e31",
      "operationType":"SYSTEM_APPLY_SETTINGS",
      "email":"bob@m2mop.net",
      "notify":true,
      "callback":null,
      "parameters":{
         "templateId":"75c012c806ab4ce8ad0a4e1171bda440"
      }
   },
   ...
]
Name Description Use Default Type
company Set the context company. optional caller's company string
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.operation.trigger

/api/v1/operations/triggers/{uid}

Gets the trigger identified by the given uid.

Request

GET https://na.airvantage.net/api/v1/operations/triggers/df411e4f47c39847a101f0fd890ab65c

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
    "uid": "df411e4f47c39847a101f0fd890ab65c"
    "type": "ON_ALERT_STATE_CHANGE_TRUE",
    "filter": "34a1f6611d42487783014e6589c97e31",
    "operationType": "SYSTEM_SEND_COMMAND",
    "notify": true,
    "callback": "http://blabla.com",
    "parameters": {
        "commandId": "home.ChangeTemperature",
        "protocol": "REST",
        "parameters": {"Temperature": 20},
        "application": {
            "uid": "333ea6a2d6e44a00aee2804ed519128a"
        },
        "requestConnection": false
    }
}
Name Description Use Default Type
company Set the context company. optional caller's company string
Name Description
operation.trigger.unknown Raised when the 'uid' points to an unknown operation trigger.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.operation.trigger

/api/v1/operations/triggers

Creates a new trigger.

Request

POST https://na.airvantage.net/api/v1/operations/triggers
Content-Type: application/json
...
{
    "type": "ON_ALERT_STATE_CHANGE",
    "filter": "47766a1366384dfdb1a45f8a283e2344",
    "operationType": "SYSTEM_SUSPEND",
    "parameters": {}
}

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid":"b0ea1e43e7164b69982ff99170f57dbf",
   "type":"ON_ALERT_STATE_CHANGE",
   "filter":"47766a1366384dfdb1a45f8a283e2344",
   "operationType":"SYSTEM_SUSPEND",
   "email":"user@airvantage.com",
   "notify":false,
   "callback":null,
   "parameters":{
   }
}
Name Description Use Default Type
company Set the context company. optional caller's company string

You can find more details here.

Name Description
operation.trigger.too.many Raised when there are more than 50 triggers in your company.
operation.trigger.type.unknown Raised when the given trigger type is unknown.
operation.trigger.operation.type.unknown Raised when the given operation type is unknown.
operation.trigger.parameters.invalid Raised when the given parameters are not ok for the specified operation type.
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.operation.trigger

/api/v1/operations/triggers/{uid}

Updates the trigger identified by the given uid.

Request

PUT https://na.airvantage.net/api/v1/operations/triggers/b0ea1e43e7164b69982ff99170f57dbf
Content-Type: application/json
...
{
    "type": "ON_ALERT",
    "filter": "47766a1366384dfdb1a45f8a283e2344",
    "operationType": "SYSTEM_SUSPEND",
    "parameters": {}
}

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid":"b0ea1e43e7164b69982ff99170f57dbf",
   "type":"ON_ALERT",
   "filter":"47766a1366384dfdb1a45f8a283e2344",
   "operationType":"SYSTEM_SUSPEND",
   "email":"user@airvantage.com",
   "notify":false,
   "callback":null,
   "parameters":{
   }
}
Name Description Use Default Type
company Set the context company. optional caller's company string

You can find more details here.

Name Description
operation.trigger.unknown Raised when the 'uid' points to an unknown operation trigger.
operation.trigger.type.unknown Raised when the given trigger type is unknown.
operation.trigger.operation.type.unknown Raised when the given operation type is unknown.
operation.trigger.parameters.invalid Raised when the given parameters are not ok for the specified operation type.
HTTP Method PUT
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.operation.trigger

/api/v1/operations/triggers/{uid}

Deletes the trigger identified by the given uid.

Request

DELETE https://na.airvantage.net/api/v1/operations/triggers/b0ea1e43e7164b69982ff99170f57dbf
...

Response
200 OK

HTTP/1.1 200 OK
Content-Length: 0
Name Description Use Default Type
company Set the context company. optional caller's company string
Name Description
operation.trigger.unknown Raised when the 'uid' points to an unknown operation trigger.
HTTP Method DELETE
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions entities.operation.trigger
TOP