Get Quantity Access Control List

Gets the ACL of the specified quantity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Response

Example response body

200 Response (AccessControlList)

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

Update Quantity Access Control List

Updates the ACL of the specified quantity

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Response

Patch Quantity Access Control List

Updates the ACL for the specified quantity using an RFC 6902 compliant JSON Patch document. This allows the ACL to be modified without submitting the entire Access Control List.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Request Headers

Response

Example response body

200 Response (AccessControlList)

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

Get Quantity Owner

Gets the Owner of the specified quantity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Response

Example response body

200 Response (Trustee)

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

Update Quantity Owner

Updates the Owner of the specified quantity

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Response

List Quantity Access Rights

Gets the Access Rights associated with the specified quantity for the requesting identity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

Response

Example response body

200 Response

HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]

400 Response (ErrorResponseBody)

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

Get Quantity Unit of Measure Access Control List

Gets the ACL of the specified unit of measure

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Response

Example response body

200 Response (AccessControlList)

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

Update Quantity Unit of Measure Access Control List

Updates the ACL of the specified unit of measure

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Response

Patch Quantity Unit of Measure Access Control List

Updates the ACL for the specified unit of measure using an RFC 6902 compliant JSON Patch document. This allows the ACL to be modified without submitting the entire Access Control List.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Request Headers

Response

Get Quantity Unit of Measure Owner

Gets the Owner of the specified unit of measure

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Response

Example response body

200 Response (Trustee)

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

Update Quantity Unit of Measure Owner

Updates the Owner of the specified unit of measure

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Response

List Quantity Unit of Measure Access Rights

Gets the Access Rights associated with the specified unit of measure for the requesting identity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Quantities/{quantityId}/Units/{uomId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string quantityId
The quantity identifier

string uomId
The unit of measure identifier

Response

Example response body

200 Response

HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]

400 Response (ErrorResponseBody)

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

Access Control List

Get Stream Access Control List

Returns the ACL of the specified stream.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Example response body

200 Response (AccessControlList)

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

Update Stream Access Control List

Updates the ACL of the specified stream.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Patch Stream Access Control List

Updates the ACL of the specified stream using an RFC 6902 compliant JSON Patch document. This allows the ACL to be modified without submitting the entire Access Control List.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Request Headers

Response

Get Stream Access Control List Bulk

Returns the ACL information associated with provided streams. The list of stream identifiers needing ACL information should be supplied as a list of stream IDs in the request body. HTTP 207 is returned regardless of partial or complete success of stream resolution. Any stream where ACL information cannot be fetched will be included in the Errors property of the BulkResults<T>.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Streams/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Example response body

207 Response (BulkResultsOfObjectAcl)

{
  "Results": [
    {
      "Id": "string",
      "AccessControlList": {
        "RoleTrusteeAccessControlEntries": [
          {
            "Trustee": {
              "Type": 1,
              "ObjectId": "string",
              "TenantId": "string"
            },
            "AccessType": 0,
            "AccessRights": 0
          }
        ]
      }
    }
  ],
  "Errors": [
    {
      "Id": "string",
      "OperationStatus": 0,
      "Error": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Get Stream Owner

Returns the Owner of the specified stream.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Example response body

200 Response (Trustee)

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

Update Stream Owner

Updates the Owner of the specified stream.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Get Stream Owner Bulk

Returns the owner information associated with provided streams. The list of stream identifiers needing owner information should be supplied as a list of stream IDs in the request body. HTTP 207 is returned regardless of partial or complete success of stream resolution. Any stream where owner information cannot be fetched will be included in the Errors property of the BulkResults<T>.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/Streams/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Example response body

207 Response (BulkResultsOfObjectOwner)

{
  "Results": [
    {
      "Id": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      }
    }
  ],
  "Errors": [
    {
      "Id": "string",
      "OperationStatus": 0,
      "Error": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

List Stream Access Rights

Returns the access rights associated with the specified stream for the requesting identity.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Example response body

200 Response

HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]

400 Response (ErrorResponseBody)

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

Access Control List

Get Type Access Control List

Gets the ACL of the specified type

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Response

Example response body

200 Response (AccessControlList)

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

Update Type Access Control List

Updates the ACL of the specified type

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Response

Patch Type Access Control List

Updates the ACL for the specified type using an RFC 6902 compliant JSON Patch document. This allows the ACL to be modified without submitting the entire Access Control List.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Request Headers

Response

Get Type Owner

Gets the Owner of the specified type

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Response

Example response body

200 Response (Trustee)

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

Update Type Owner

Updates the Owner of the specified type

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Response

List Type Access Rights

Gets the Access Rights associated with the specified type for the requesting identity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Types/{typeId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
Type identifier.

Response

Example response body

200 Response

HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]

400 Response (ErrorResponseBody)

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

Access Control List

Get Stream View Access Control List

Gets the ACL of the specified stream view

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Response

Example response body

200 Response (AccessControlList)

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

Update Stream View Access Control List

Updates the ACL of the specified stream view

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Response

Patch Stream View Access Control List

Updates the ACL of the specified stream view using an RFC 6902 compliant JSON Patch document. This allows the ACL to be modified without submitting the entire Access Control List.

Request

PATCH /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/AccessControl

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Request Headers

Response

Get Stream View Owner

Gets the Owner of the specified stream view

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Response

Example response body

200 Response (Trustee)

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

Update Stream View Owner

Updates the Owner of the specified stream view

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/Owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Response

List Stream View Access Rights

Gets the Access Rights associated with the specified stream view for the requesting identity

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/StreamViews/{streamViewId}/AccessRights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamViewId
Stream view identifier.

Response

Example response body

200 Response

HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]

400 Response (ErrorResponseBody)

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

Definitions

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
}

Trustee

Properties

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

TrusteeType

Enumerated Values

AccessType

Enumerated Values

ErrorResponseBody

The error response contains standard details on the cause and resolution of the error.

Properties

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

CommonAccessRights

Enumerated Values

BulkResultsOfObjectAcl

Properties

{
  "Results": [
    {
      "Id": "string",
      "AccessControlList": {
        "RoleTrusteeAccessControlEntries": [
          {
            "Trustee": {
              "Type": 1,
              "ObjectId": "string",
              "TenantId": "string"
            },
            "AccessType": 0,
            "AccessRights": 0
          }
        ]
      }
    }
  ],
  "Errors": [
    {
      "Id": "string",
      "OperationStatus": 0,
      "Error": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

ObjectAcl

Properties

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

ObjectError

Properties

{
  "Id": "string",
  "OperationStatus": 0,
  "Error": {
    "property1": null,
    "property2": null
  }
}

BulkResultsOfObjectOwner

Properties

{
  "Results": [
    {
      "Id": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      }
    }
  ],
  "Errors": [
    {
      "Id": "string",
      "OperationStatus": 0,
      "Error": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

ObjectOwner

Properties

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