Get Asset Owner

Returns the owner of specified asset.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Example response body

200 Response

{
  "Type": 1,
  "TenantId": "55555555-5555-5555-5555-555555555555",
  "ObjectId": "44444444-4444-4444-4444-444444444444"
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Update Asset Owner

Updates the owner of specified asset.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Request Body

Updated owner.

{
  "Type": 1,
  "TenantId": "55555555-5555-5555-5555-555555555555",
  "ObjectId": "44444444-4444-4444-4444-444444444444"
}

Response

Get Asset Acl

Returns the access control list of the specified asset.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Example response body

200 Response

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "11111111-1111-1111-1111-111111111111"
      },
      "AccessRights": 3
    },
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "22222222-2222-2222-1111-111111111111"
      }
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Update Asset Access Control

Updates the access control of specified asset.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Request Body

Updated ACL.

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "11111111-1111-1111-1111-111111111111"
      },
      "AccessRights": 3
    },
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "22222222-2222-2222-1111-111111111111"
      }
    }
  ]
}

Response

List Asset Access Rights

Returns the access rights of specified asset.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Example response body

200 Response

[
  "Read",
  "Write",
  "Delete",
  "ManageAccessControl"
]

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Get Asset

Returns specified asset and the version ETag in the HTTP response header.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Get Or Create Asset

Creates a new asset. If the asset you are trying to create references an asset type (through the AssetTypeId property) and if the corresponding asset type has a metadata value with the same identifier, then the name and SDS type code of the metadata value on the asset must be null. If the asset type does not have metadata value with a corresponding Id, the name and SDS type code on the asset cannot be null. To support flexibility on creation and update, the following rules and behaviors are executed for metadata and stream references on a given asset when that asset is created from an asset type.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Request Body

Asset to create.

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

201 Response

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Create Or Update Asset

Creates or updates an asset with a specified identifier. If the asset already exists, you can specify an If-Match property in the HTTP request header to ensure that the asset is modified only if its version matches. To support flexibility on creation and update, the following rules and behaviors are executed for metadata and stream references on a given asset when that asset is from an asset type.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Request Body

Asset to create or update.

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

201 Response

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Patch Asset

Performs a Patch operation on the asset with the specified identifier. The request body is expected to be a JSON Patch (RFC 6902) document. For the purposes of Patch operations, Asset StreamReferences and Metadata are treated as dictionaries keyed by their identifiers, even though these properties are lists in the underlying Asset model. This permits individual StreamReferences and Metadata items to be indexed by their identifiers in the operation path.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Request Body

Asset patch document.

"SampleAssetName"

{
  "Id": "Id-vwxyz",
  "Name": "SerialNumber",
  "Description": "This is a static attribute on the asset which represents the serial number.",
  "SdsTypeCode": "String",
  "Value": "SN6845"
}

"Tag3"

Response

Response Headers

Example response body

200 Response

{
  "Id": "SampleAsset",
  "Name": "SampleAssetName",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    },
    {
      "Id": "Id-vwxyz",
      "Name": "SerialNumber",
      "Description": "This is a static attribute on the asset which represents the serial number.",
      "SdsTypeCode": "String",
      "Value": "SN6645"
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2",
    "Tag3"
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Delete Asset

Deletes the asset with a specified identifier.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets/{assetId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string assetId
Asset identifier.

Response

Assets

List Assets

Returns an array of assets in a given namespace and the total number of assets returned, specified as Total-Count in the HTTP response header.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets
?filter={filter}&skip={skip}&count={count}&orderBy={orderBy}&query={query}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string filter
String used to filter the asset search results. Filter strings are not case-sensitive. Filters can be applied for the AssetTypeName property, the Status property, and the asset metadata properties, using the syntax filter[property_name]=property_value.

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[optional] string orderBy
Optional parameter which returns assets ordered either by the asset Id or the asset Name. Specify asc or desc to return the results in ascending or descending order. If not specified, the default is ascending order.

[optional] string query
Query identifier.

Response

Response Headers

Example response body

200 Response

[
  {
    "Id": "SampleAsset",
    "Description": "This is a sample asset.",
    "Metadata": [
      {
        "Id": "fbd82b97-d29e-4022-968e-f8492cf86644",
        "Name": "ModelNumber",
        "Description": "This is a static attribute on the asset which represents the model number.",
        "SdsTypeCode": "Double",
        "Value": 0.01
      }
    ],
    "StreamReferences": [
      {
        "Id": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
        "Name": "Data",
        "Description": "This is reference to a stream. The stream Id is SdsStream_1.",
        "StreamId": "SdsStream_1"
      }
    ]
  },
  {
    "Id": "SecondSampleAsset",
    "Description": "This is a second sample asset.",
    "Metadata": [
      {
        "Id": "90ef6205-152b-40ed-8ffa-bac3feff6fa2",
        "Name": "ModelNumber",
        "Description": "This is a static attribute on the asset which represents the model number.",
        "SdsTypeCode": "Double",
        "Value": 900
      }
    ],
    "StreamReferences": [
      {
        "Id": "fdda0985-7dba-48aa-95fc-55620a9b59ad",
        "Name": "Data",
        "Description": "This is reference to a stream. The stream identifier is SdsStream_2.",
        "StreamId": "SdsStream_2"
      }
    ]
  }
]

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Head Assets

Returns the Headers corresponding to the GET Assets call, including a collection ETag and, optionally, Total-Count. The collection ETag changes whenever an asset type is created, updated, or deleted.

Request

HEAD /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets
?filter={filter}&query={query}&includeTotalCount={includeTotalCount}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string filter
String used to filter the asset search results. Filter strings are not case-sensitive. Filters can be applied for the AssetTypeName property, the Status property, and the asset metadata properties, using the syntax filter[property_name]=property_value.

[optional] string query
Search query. Defaults to all assets if unspecified.

[optional] boolean includeTotalCount
Optional parameter. If set to false, Total-Count header will not be included.

Response

Response Headers

Create Asset

Creates a new asset. If the asset you are trying to create references an asset type (through the AssetTypeId property) and if the corresponding asset type has a metadata value with the same identifier, then the name and SDS type code of the metadata value on the asset must be null. If the asset type does not have metadata value with a corresponding Id, the name and SDS type code on the asset cannot be null. To support flexibility on creation and update, the following rules and behaviors are executed for metadata and stream references on a given asset when that asset is created from an asset type.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Assets

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

Asset you want to create.

{
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

Response

Response Headers

Example response body

201 Response

{
  "Id": "6dad79ed-e0ea-423f-aed3-2ba2fccf5335",
  "Name": "6dad79ed-e0ea-423f-aed3-2ba2fccf5335",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Bulk Create Assets

Creates assets in bulk. Creates multiple assets in a single call.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Assets

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

List of assets you want to create.

Response

Example response body

200 Response (MultiStatusResultOfAssetAndChildErrorTemplate)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SampleAsset",
      "Description": "This is a sample asset.",
      "Metadata": [
        {
          "Id": "Id-abcde",
          "Name": "ModelNumber",
          "Description": "This is a static attribute on the asset which represents the model number.",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "StreamReferences": [
        {
          "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
          "Name": "Data",
          "Description": "This is the description for this stream reference.",
          "StreamId": "SdsStream_1"
        }
      ],
      "Tags": [
        "Tag1",
        "Tag2"
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

Bulk Delete Assets

Deletes all assets with the specified identifiers. This API can delete up to a maximum of 1000 assets in one API call.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Assets
?id={id}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] array id
Ampersand separated asset identifiers in the form of id={assetId_1}&id={assetId_2}

Response

Example response body

207 Response (MultiStatusResultOfStringAndChildErrorTemplate)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    "string"
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

Definitions

Trustee

Properties

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

ErrorTemplate

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

AccessControlList

Properties

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

AccessType

Enumerated Values

Asset

Represents an asset object.

Properties

{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}

MetadataItem

An asset or asset type metadata is static information associated with a given asset. A given metadata contains a list of individual metadata values. There is no limit on the number of metadata values defined by an asset. An asset or asset type metadata does not stand alone. It must be specified within an asset or asset type object and, therefore, there are no direct API routes to asset or asset type metadata.

Properties

{
  "Id": "Sample Metadata identifier",
  "Name": "Max Pressure",
  "Description": "This metadata represents the maximum pressure of a given asset.",
  "SdsTypeCode": "Double",
  "Value": 11.2,
  "Uom": "newton"
}

SdsTypeCode

Enumerated Values

SdsTypeCode2

Enumerated Values

StreamReference

An asset stream reference represents dynamic stream data associated with an asset. The references must either be an SDS stream or an SDS stream view. Asset-centric data routes provide direct access to dynamic data for a given asset. There are no limitations on the number of references an asset may contain. However, an asset cannot contain multiple references to the same SDS stream. An asset stream reference does not stand alone. It must be specified within an asset object and, therefore, asset references do not have direct API routes.

Properties

{
  "Id": "f1bf9da2-3858-4bcd-bf93-e7c26ab0d28e",
  "Name": "Data",
  "Description": "This is reference to a stream. The stream identifier is SdsStream_1.",
  "StreamId": "SdsStream_1"
}

StatusConfiguration

Status configuration is a property of an asset or asset type that defines the simple status of an asset or asset type.

Properties

{
  "DefinitionType": "StreamPropertyMapping",
  "Definition": {
    "StreamReferenceId": "StatusMappingOnAssetTypeCrudFunctionalTest_streamRef",
    "StreamPropertyId": "Value",
    "ValueStatusMappings": [
      {
        "Value": 3,
        "Status": "Bad",
        "DisplayName": "Bad"
      },
      {
        "Value": 1,
        "Status": "Good",
        "DisplayName": "Good"
      }
    ]
  }
}

StatusDefinitionType

Status definition type. Currently, only StreamPropertyMapping is supported.

Enumerated Values

JsonPatchDocumentOfPatchAsset

Properties

{
  "Operations": [
    {
      "value": null,
      "path": "string",
      "op": "string",
      "from": "string"
    }
  ]
}

OperationOfPatchAsset

Properties

{
  "value": null,
  "path": "string",
  "op": "string",
  "from": "string"
}

MultiStatusResultOfAssetAndChildErrorTemplate

A multi status result is returned to indicate a partial success.

Properties

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SampleAsset",
      "Description": "This is a sample asset.",
      "Metadata": [
        {
          "Id": "Id-abcde",
          "Name": "ModelNumber",
          "Description": "This is a static attribute on the asset which represents the model number.",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "StreamReferences": [
        {
          "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
          "Name": "Data",
          "Description": "This is the description for this stream reference.",
          "StreamId": "SdsStream_1"
        }
      ],
      "Tags": [
        "Tag1",
        "Tag2"
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}

ChildErrorTemplate

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "StatusCode": 0,
  "property1": null,
  "property2": null
}

MultiStatusResultOfStringAndChildErrorTemplate

A multi status result is returned to indicate a partial success.

Properties

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    "string"
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}