Entity Blueprint API

Permission

blueprints:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
    “id”: "string"
}

• id: 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

Permission

blueprints:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
   “ids”: List<string>
}

• 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

Permission

blueprints:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
    “lastFetchedId”: “string”
}

• lastFetchedId: 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

Permission

blueprints:add

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
“data”: 
  {
      "id": “string”,
      "rowVersion": “string”,
      "name": “string”,
      "displayName": “string”,
      "managedBy": “string”,
      "properties":
    {
        {
            "enabled": false,
            "propertyName": “string”,
            "propertyDisplayName": “string”,
            "dataType": "Undefined"(enum),
            "blueprint": “string”,
            "propertyType": " Endpoint "(enum)
        }
    },
      "iconUrl": “string”
  }
}

• data: EntityBlueprint (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

Permission

blueprints:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
    “data”: {
        “OldDataRowVersion”:”string”,
        “NewData”: {
        {
            "id": “string”,
            "rowVersion": “string”,
            "name": “string”,
            "displayName": “string”,
            "managedBy": “string”,
            "properties":
            {
                {
                "enabled": false,
                "propertyName": “string”,
                "propertyDisplayName": “string”,
                "dataType": "Undefined"(enum),
                "blueprint": “string”,
                "propertyType": " Endpoint "(enum)
                }
            },
            "iconUrl": “string”
        }
        }
    }
}

• data: EntityBlueprint (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

Permission

blueprints:delete

Accessible

Tenant Only. See response and accessiblity information for more

URL

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

URL Params

NONE

Data Params

{
    id:”string”,
}

• id: 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

Permission

blueprints:add

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/AddManagedBlueprint

URL Params

NONE

Data Params

{
    “blueprint”: {
            "id": “string”,
            "rowVersion": “string”,
            "name": “string”,
            "displayName": null,
            "managedBy": “string”,
            "properties": {
                {
                      "enabled": false,
                      "propertyName": “string”,
                      "propertyDisplayName": “string”,
                      "dataType": “Undefined”(enum),
                      "blueprint": “string”,
                      "propertyType": “Endpoint”(enum)
                    }(list)
                    },
            "iconUrl": “string”
          }
}

• blueprint: EntityBlueprint (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

Permission

blueprints:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/UpdateManagedBlueprintDisplayName

URL Params

NONE

Data Params

{
    “blueprintName”: “string” 
    “newDisplayName”: “string“
}

• blueprintName: string (required)

• newDisplayName: 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

Permission

blueprints:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/AddBlueprintProperty

URL Params

NONE

Data Params

 {
    “blueprint”: “string”, 
        “property”: {
            "enabled": false,
            "propertyName": “string”,
            "propertyDisplayName": “string”,
            "dataType": “Undefined”(enum),
            "blueprint": “string”,
            "propertyType": “Endpoint”(enum)
        }
}

• blueprint: string (required)

• property: EntityBlueprintProperty (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

Permission

blueprints:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/UpdateBlueprintProperty

URL Params

NONE

Data Params

{
“blueprint”: “string”, 
    “property”: {
            "enabled": false,
            "propertyName": “string”,
            "propertyDisplayName": “string”,
            "dataType": “Undefined”(enum),
            "blueprint": “string”,
            "propertyType": “Endpoint”(enum)
        }
}

• blueprint: string (required)

• property: EntityBlueprintProperty (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

Permission

blueprints:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/RenameBlueprintProperty

URL Params

NONE

Data Params

{
    “blueprint”: “string”,
    “oldPropertyName”: “string”,
    “newPropertyName": “string”
}

• blueprint: string (required)

• oldPropertyName: string (required)

• newPropertyName: 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

Permission

blueprints:delete

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/RemoveBlueprintProperty

URL Params

NONE

Data Params

{
    “blueprint”: “string”,
    “propertyName”: “string”
}

• blueprint: string (required)

• propertyName: 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

Permission

tags:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetTags

URL Params

NONE

Data Params

NONE

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

Permission

tags:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetEmptyBlueprints

URL Params

NONE

Data Params

NONE

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

Permission

tags:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/HasTag

URL Params

NONE

Data Params

{
    "tag": "string"
}

• tag: 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

Permission

TAGS:GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetEntityTaggedEntityBlueprints

URL Params

NONE

Data Params

{
    "entityId": "string"
}

• entityId: 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

Permission

BLUEPRINTS:GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetBlueprintsManagedBy

URL Params

NONE

Data Params

{
    “managedBy”:”Entities”(enum)
}

• managedBy: ManagedByType

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

Permission

BLUEPRINTS:GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetBlueprintNames

URL Params

NONE

Data Params

NONE

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

Permission

blueprints:apply

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/Apply

URL Params

NONE

Data Params

{
    “clientId”: “string”,
    “blueprintName”: “string”
}

• clientId: string (required)

• blueprintName: 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

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/ApplyToEntity

URL Params

NONE

Data Params

{
    “entityId”: “string”,
    “blueprintName”: “string”
}

• entityId: string (required)

• blueprintName: 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

Permission

ENTITIES:GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint/GetEntityTagLinks

URL Params

NONE

Data Params

{
    “entityId”: “string”
}

• entityId: 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

Permission

FULL_ACCESS

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityBlueprint /MaintenanceActivateAllBlueprints

URL Params

NONE

Data Params

NONE

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