Entity Alarm API

Jan 1 2022 at 12:00 AM

APIs within Entity Alarm API
1. EntityAlarm
  1. API Calls

This service is responsible for managing alarm entities and their metadata.

APIs within Entity Alarm API

EntityAlarm

API Calls

Get

Permission

ENTITIES_GET

Accessible

Tenant only. See response and accessibility information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/Get

URL Params

None

Data Params

{
    "id": "text"
}

id: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetMany

Permission

ENTITIES_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/GetMany

URL Params

None

Data Params

{
    "ids": ["text","text"]
}

ids: List (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetNext1000

Permission

ENTITIES_GET

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/GetNext1000

URL Params

None

Data Params

{
    "lastFetchedId": "text"
}

lastFetchedId: text

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Add

Permission

Checks Entity Path Access and “entities.calendar:add”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/Add

URL Params

None

Data Params

{
    "data":{
          "Id": "text",
          "RowVersion" : "text",
          "ManagedBy" : "text",
          "Priority": "High",
          "AlarmAcknowledgementPolicy" : " AcknowledgeAndKeepActive",
          "AlarmType" : "text",
          "Associated": "text",
          "RequiresPinForAcknowledgement" : "text"
        }

}

data: TDto (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

AddMany

Permission

Checks Entity Path Access and “entities.calendar:add”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/AddMany

URL Params

None

Data Params

{
    "data":[{
          "Id": "text",
          "RowVersion" : "text",
          "ManagedBy" : "text",
          "Priority": "High",
          "AlarmAcknowledgementPolicy" : " AcknowledgeAndKeepActive",
          "AlarmType" : "text",
          "Associated": "text",
          "RequiresPinForAcknowledgement" : "text"
}]

}

data: List (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Update

Permission

Checks Entity Path Access and “entities.calendar:edit”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/Update

URL Params

None

Data Params

{
   "data":{
            "OldDataRowVersion":"text",
            "NewData":{
                "Id": "text",
                "RowVersion" : "text",
                "ManagedBy" : "text",
                "Priority": "High",
                "AlarmAcknowledgementPolicy" : " AcknowledgeAndKeepActive",
                "AlarmType" : "text",
                "Associated": "text",
                "RequiresPinForAcknowledgement" : "text"
            }
        }
}

data: UpdateModel (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

UpdateMany

Permission

Checks Entity Path Access and “entities.calendar:edit”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/UpdateMany

URL Params

None

Data Params

{
   "data":[
       {
            "OldDataRowVersion":"text",
            "NewData":{
                "Id": "text",
                "RowVersion" : "text",
                "ManagedBy" : "text",
                "Priority": "High",
                "AlarmAcknowledgementPolicy" : " AcknowledgeAndKeepActive",
                "AlarmType" : "text",
                "Associated": "text",
                "RequiresPinForAcknowledgement" : "text"
            }
        }
    ]
}

data: List<UpdateModel> (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

AddOrUpdate

Permission

Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/AddOrUpdate

URL Params

None

Data Params

{
   "data":{
"OldDataRowVersion":"text",
"NewData":{
          "Id": "text",
          "RowVersion" : "text",
          "ManagedBy" : "text",
          "Priority": "High",
          "AlarmAcknowledgementPolicy" : " AcknowledgeAndKeepActive",
          "AlarmType" : "text",
          "Associated": "text",
          "RequiresPinForAcknowledgement" : "text"
}
}
}

data: UpdateModel (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

AddOrUpdateMany

Permission

Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/AddOrUpdateMany

URL Params

None

Data Params

{
   "data":[
       {
        "OldDataRowVersion":"text",
        "NewData":{
            "Id": "text",
            "RowVersion" : "text",
            "ManagedBy" : "text",
            "Priority": "High",
            "AlarmAcknowledgementPolicy" : "   AcknowledgeAndKeepActive",
            "AlarmType" : "text",
            "Associated": "text",
            "RequiresPinForAcknowledgement" : "text"
            }
       }
    ]
}

data: List<UpdateModel> (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Remove

Permission

Checks Entity Path Access and “entities.calendar:delete”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/Remove

URL Params

None

Data Params

{
    "id": "text"
}

id: text (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Copy

Permission

Checks Entity Path Access and “entities.calendar:edit”.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/Copy

URL Params

None

Data Params

{
    "masterId": "string",
    "targetId": "string" 

}

masterId: string (Required)
targetId: string

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

CopyMany

Permission

Checks Entity Path Access and “entities.calendar:edit”

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/CopyMany

URL Params

None

Data Params

{
    "masterToTargetIds": [{"string": "string", "string": "string"}]

}

masterToTargetIds: Dictionary<string, string> (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

RemoveMany

Permission

Checks Entity Path Access and “entities.calendar:delete”

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityAlarm/RemoveMany

URL Params

None

Data Params

{
    "ids": ["text", "text"]
}

ids: List (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Entity Alarm API

APIs within Entity Alarm API

EntityAlarm

API Calls

Continue reading

Community

Questions

Website