Blueprint Aggregate API

Jan 1 2022 at 12:00 AM

APIs within Blueprint Aggregate API
1. BlueprintAggregateApi
  1. API Calls

This service acts as a bridge between the Entity CRUD APIs for managing blueprints. Applying blueprints is managed by this service.

APIs within Blueprint Aggregate API

BlueprintAggregateApi

API Calls

ApplyToEntity

Permission

blueprints:apply

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

{
    "EntityId" : "string" 
    "BlueprintName": "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

Apply

Permission

blueprints:apply

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

{
    "BlueprintName": "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

GetTaggedEntities

Permission

tags:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GetTaggedEntities

URL Params

None

Data Params

Example:
{
    "tag": "string"
    "ancestorId": "string" 
    "appliedTagsOnly": true
}

tag: string
ancestorId: string
appliedTagsOnly: bool

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

ResolveBlueprintPropertiesForEntity

Permission

entities:get

blueprints:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/ResolveBlueprintPropertiesForEntity

URL Params

None

Data Params

{
    "blueprint": "string" 
    "entityId": "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

AddManagedBlueprint

Permission

blueprints:add

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

Example:
{
    "blueprint":{
        "Id":"text",
        "RowVersion":"text",
        "Name":"text",
        "DisplayName":"text",
        "ManagedBy":"text",
        "Properties":{"Enabled":true,
            "PropertyName":"text",
            "PropertyDisplayName":"text",
            "DataType":" Undefined",
            "Blueprint":"text",
            "PropertyType":" Endpoint"
        }
        "IconUrl":"text",
    }
}

blueprint: EntityBlueprint.API.Abstractions.Models.Blueprints.EntityBlueprint

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

AddManagedBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/AddManagedBlueprintProperty

URL Params

None

Data Params

Example:
{
    "clientId":"text",
    "Blueprint":"text",
    "Property":
    {
        "Enabled": "true",
        "PropertyName": "text",
        "PropertyDisplayName": "text",
        "DataType": "Undefined",
        "Blueprint": "text",
        "PropertyType": "Endpoint",
    },
    "ApplyToEntities": "true",
    "EntitiesToApplyOn":{"text","text"}
}

clientId: string
Blueprint: string
Property: EntityBlueprintProperty
ApplyToEntities: bool (optional)
EntitiesToApplyOn: List (optional)

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

AddBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

Example:
{
    "blueprint" : "text"
    "Property":
    {
        "Enabled" : true,
        "PropertyName" : "text",
        "PropertyDisplayName" : "text",
        "DataType" : " Undefined",
        "Blueprint" : "text",
        "PropertyType" : " Endpoint",
    },
    "applyToEntities" : false
    "entitiesToApplyOn" : {"text","text"}
}

blueprint: string
property: EntityBlueprintProperty
applyToEntities:bool (optional)
entitiesToApplyOn : List (optional)

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

UpdateManagedBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/UpdateManagedBlueprintProperty

URL Params

None

Data Params

Example:
{
    "blueprint": "string",
    "propertyName": "string",
    "property": 
    {
        "Enabled" : "true",
        "PropertyName" : "text",
        "PropertyDisplayName" : "text",
        "DataType" : " Undefined",
        "Blueprint" : "text",
        "PropertyType" : "Endpoint",
    },
    "applyToEntities": "false",
    "entitiesToApplyOn": {"text","text"}
}

blueprint: string
propertyName: string
property: EntityBlueprintProperty
applyToEntities: bool (optional)
entitiesToApplyOn: List (optional)

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

UpdateBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

Example:
{
    "blueprint": "string",
    "propertyName": "string",
    "property": 
    {
        "Enabled" : "true",
        "PropertyName" : "text",
        "PropertyDisplayName" : "text",
        "DataType" : " Undefined",
        "Blueprint" : "text",
        "PropertyType" : "Endpoint",
    },
    "applyToEntities": "false",
    "entitiesToApplyOn": {"text","text"}
}

blueprint: string
propertyName: string
property: EntityBlueprintProperty
applyToEntities: bool (optional)
entitiesToApplyOn : List (optional)

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

RenameManagedBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RenameManagedBlueprintProperty

URL Params

None

Data Params

Example:
{
    "blueprint": "text",
    "oldPropertyName": "text",
    "newPropertyName": "text",
    "entitiesToApplyOn": {"text", "text"}
}

blueprint: string
oldPropertyName: string
newPropertyName: string
entitiesToApplyOn: List (optional)

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

RemoveManagedBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RemoveManagedBlueprintProperty

URL Params

None

Data Params

Example:
{
    "blueprint": "text",
    "propertyName": "text",
    "removeEntities": false
}

blueprint: string
propertyName: string
removeEntities: bool

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

GetLimitedTaggedEntities

Permission

tags:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GetLimitedTaggedEntities

URL Params

None

Data Params

{
    "tag": "text",
    "ancestorId": "text",
    "appliedTagsOnly": false,
    "pageSize": 25,
    "thresholdId" : "text"
}

tag: string
ancestorId: string (optional)
appliedTagsOnly: bool (optional)
pageSize: int? (optional)
thresholdId : string (optional)

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

GetBlueprintPropertyEntities

Permission

blueprints:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GetBlueprintPropertyEntities

URL Params

None

Data Params

Example:
{
    "blueprint": "text",
    "property": "text"
}

blueprint: string
property: 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

GetTaggedEntityPaths

Permission

entity access on entities

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GetTaggedEntityPaths

URL Params

None

Data Params

Example:
{
    "tag":"text",
    "ancestorId" : "text",
    "appliedTagsOnly" : false
}

tag: string
ancestorId : string (optional)
appliedTagsOnly : bool (optional)

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

RemoveBlueprintProperty

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

Example:
{
    "blueprint": "text",
    "propertyName": "text",
    "removeEntities": false
}

blueprint: string
propertyName: string
removeEntities: bool (optional)

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

RemoveManagedBlueprint

Permission

blueprints:delete

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RemoveManagedBlueprint

URL Params

None

Data Params

Example:
{
    "name":"text"
}

name: 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

GenerateBlueprintFromEntityGroup

Permission

entities:add

blueprints:add

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GenerateBlueprintFromEntityGroup

URL Params

None

Data Params

{
    "name": "text",
    "blueprintName": "text"
}

name: string
blueprintName: 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

UpdateBlueprintDisplayName

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/UpdateBlueprintDisplayName

URL Params

None

Data Params

Example:
{
    "blueprintName":"text",
    "newDisplayName": "text"
}

blueprintName: string
newDisplayName: 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

UpdateManagedBlueprintDisplayName

Permission

blueprints:edit

Accessible

Tenant only. See response and accessiblity information for more

URL

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

URL Params

None

Data Params

Example:
{
    "blueprintName":"text",
    "newDisplayName": "text"
}

blueprintName: string
newDisplayName: 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

RecalculateBlueprint

Permission

FULL_ACCESS

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RecalculateBlueprint

URL Params

None

Data Params

Example:
{
    "blueprintName":"text"
}

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

RecalculateManyBlueprints

Permission

FULL_ACCESS

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RecalculateManyBlueprints

URL Params

None

Data Params

Example:
{
    "blueprintName": {"text","text"},
    "blueprintsPerBatch": 10
}

blueprintName: IEnumerable
blueprintsPerBatch: int (optional)

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

RecalculateAllBlueprints

Permission

FULL_ACCESS

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/RecalculateAllBlueprints

URL Params

None

Data Params

Example:
{
    "blueprintsPerBatch":10
}

blueprintPerBatch: int

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

GetEntityBasicInfoByTagAndTaggedState

Permission

ADMINISTRATOR

“entities.blueprint_tagged:view”

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/BlueprintAggregateApi/GetEntityBasicInfoByTagAndTaggedState

URL Params

None

Data Params

Example:
{
    "blueprintName": "Hello1",
    "state": 0,
    "limit": 10,
    "skip": 0
}

blueprintName: string (optional)
state: TaggedStateType (optional)
limit: int (optional)
skip: int (optional)

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

Blueprint Aggregate API

APIs within Blueprint Aggregate API

BlueprintAggregateApi

API Calls

Continue reading

Community

Questions

Website