Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services developer documentation

TABLE OF CONTENTS

Reference Data Types

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 22, 2024
  • 15 minute read

List Reference Data Types

Returns an array of ReferenceDataTypes in a given namespace and the version ETag in the HTTP response header. The If-Match and If-None-Match headers are supported.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes
?skip={skip}&count={count}&filter={filter}&includeDeleted={includeDeleted}

Parameters

string tenantId

string namespaceId

[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 filter
Parameter representing the condition for results to be filtered by. If unspecified, results are not filtered.

[optional] boolean includeDeleted
Parameter indicating whether to include deleted ReferenceData properties. If unspecified, a default value of false is used.

Response

Status Code Body Type Description
200 ReferenceDataType[] Success.
304 None Not modified.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
412 AdhErrorResponse Precondition failed.

Example response body

200 Response

[
  {
    "Id": "SimpleReferenceData",
    "Name": "SimpleReferenceData",
    "GraphQLName": "SimpleReferenceData",
    "Category": "ReferenceData",
    "State": "Active",
    "Properties": [
      {
        "PropertyTypeCode": "String",
        "Id": "id",
        "Name": "id",
        "GraphQLName": "id",
        "Flags": "None",
        "State": "Active",
        "Description": "A unique identifier for the ReferenceData instance."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "modifiedDate",
        "Name": "modifiedDate",
        "GraphQLName": "modifiedDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The last modified date and time of the ReferenceData."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "createdDate",
        "Name": "createdDate",
        "GraphQLName": "createdDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The date and time at which the ReferenceData was created."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "createdByUser",
        "Name": "createdByUser",
        "GraphQLName": "createdByUser",
        "Flags": "None",
        "State": "Active",
        "Description": "The identity of the user that created the ReferenceData."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "authorizationTags",
        "Name": "authorizationTags",
        "GraphQLName": "authorizationTags",
        "Flags": "IsCollection",
        "State": "Active",
        "Description": "The list of tags used to authorize access to the ReferenceData."
      }
    ],
    "Version": 1,
    "CreatedDate": "0001-01-01T00:00:00Z",
    "ModifiedDate": "0001-01-01T00:00:00Z",
    "DefaultAuthorizationTag": "BaseAuthorizationTag",
    "Description": "This is a simple reference data type"
  }
]

400 Response (AdhErrorResponse)

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

Create Reference Data Type With Server Generated Id

Creates a new ReferenceDataType. Response includes ETag header.

Request

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

Parameters

string tenantId

string namespaceId

Request Body

A ReferenceDataType.

{
  "Name": "SimpleReferenceData",
  "Properties": [
    {
      "Id": "SourceId",
      "PropertyTypeCode": "String"
    },
    {
      "Id": "ResourceId",
      "PropertyTypeCode": "String"
    }
  ]
}

Response

Status Code Body Type Description
201 ReferenceDataType Created.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
409 AdhErrorResponse Conflict.

Example response body

201 Response

{
  "Id": "6B29FC40-CA47-1067-B31D-00DD010662DA",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

400 Response (AdhErrorResponse)

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

Get Reference Data Type By Id

Returns the specified ReferenceDataType and the version ETag in the HTTP response header. The If-Match and If-None-Match headers are supported.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}
?includeDeleted={includeDeleted}

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

boolean includeDeleted
Parameter indicating whether to include deleted ReferenceData properties. If unspecified, a default value of false is used.

Response

Status Code Body Type Description
200 ReferenceDataType Success.
304 None Not modified.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.
412 AdhErrorResponse Precondition failed.

Example response body

200 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

400 Response (AdhErrorResponse)

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

Get Or Create Reference Data Type

Creates a new ReferenceDataType or returns the current one if the body is equivalent to what is stored. Response includes ETag header.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Request Body

A ReferenceDataType.

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "Properties": [
    {
      "Id": "SourceId",
      "PropertyTypeCode": "String"
    },
    {
      "Id": "ResourceId",
      "PropertyTypeCode": "String"
    }
  ]
}

Response

Status Code Body Type Description
200 ReferenceDataType Success.
201 ReferenceDataType Created.
302 None Found.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
409 AdhErrorResponse Conflict

Example response body

200 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

201 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

400 Response (AdhErrorResponse)

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

Create Or Update Reference Data Type

Creates a new ReferenceDataType or updates an existing and adds its Etag in the HTTP response header. Updating the state of the properties to deleted is supported through this route. Hard Delete of the type however must be done with through the DELETE endpoint. The If-Match header is supported.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Request Body

A ReferenceDataType.

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "Properties": [
    {
      "Id": "SourceId",
      "PropertyTypeCode": "String"
    },
    {
      "Id": "ResourceId",
      "PropertyTypeCode": "String"
    }
  ]
}

Response

Status Code Body Type Description
200 ReferenceDataType Success.
201 ReferenceDataType Created.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
409 AdhErrorResponse Conflict.
412 AdhErrorResponse Precondition failed.

Example response body

200 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

201 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

400 Response (AdhErrorResponse)

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

Delete Reference Data Type By Id

Deletes the ReferenceDataType.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Response

Status Code Body Type Description
204 None Deleted.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.
409 AdhErrorResponse Conflict.

Bulk Create Reference Data Type

Creates multiple new ReferenceDataTypes and returns a list of any errors along with the created objects. Response includes ETag header.

Request

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

Parameters

string tenantId

string namespaceId

Request Body

A list of ReferenceDataType objects.

Response

Status Code Body Type Description
200 ReferenceDataType Success.
207 AdhErrorResponse Partial.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
409 AdhErrorResponse Conflict.

Example response body

200 Response

{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

207 Response (AdhErrorResponse)

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

Bulk Delete Reference Data Type

Deletes multiple ReferenceDataTypes and returns an Ok if successful. In the case where a deletion is invalid, it will be added to a child errors list while the ones that were successful will be returned in the data.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/ReferenceDataTypes

Parameters

string tenantId

string namespaceId

Request Body

A list of ReferenceDataType object ids.

Response

Status Code Body Type Description
200 ReferenceDataType[] Success.
207 MultiStatusResultOfReferenceDataTypeAndAdhErrorResponse Partial.
400 AdhErrorResponse Missing or invalid inputs.
403 AdhErrorResponse Forbidden.
409 AdhErrorResponse Conflict.

Example response body

200 Response

[
  {
    "Id": "SimpleReferenceData",
    "Name": "SimpleReferenceData",
    "GraphQLName": "SimpleReferenceData",
    "Category": "ReferenceData",
    "State": "Active",
    "Properties": [
      {
        "PropertyTypeCode": "String",
        "Id": "id",
        "Name": "id",
        "GraphQLName": "id",
        "Flags": "None",
        "State": "Active",
        "Description": "A unique identifier for the ReferenceData instance."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "modifiedDate",
        "Name": "modifiedDate",
        "GraphQLName": "modifiedDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The last modified date and time of the ReferenceData."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "createdDate",
        "Name": "createdDate",
        "GraphQLName": "createdDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The date and time at which the ReferenceData was created."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "createdByUser",
        "Name": "createdByUser",
        "GraphQLName": "createdByUser",
        "Flags": "None",
        "State": "Active",
        "Description": "The identity of the user that created the ReferenceData."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "authorizationTags",
        "Name": "authorizationTags",
        "GraphQLName": "authorizationTags",
        "Flags": "IsCollection",
        "State": "Active",
        "Description": "The list of tags used to authorize access to the ReferenceData."
      }
    ],
    "Version": 1,
    "CreatedDate": "0001-01-01T00:00:00Z",
    "ModifiedDate": "0001-01-01T00:00:00Z",
    "DefaultAuthorizationTag": "BaseAuthorizationTag",
    "Description": "This is a simple reference data type"
  }
]

207 Response (MultiStatusResultOfReferenceDataTypeAndAdhErrorResponse)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SimpleReferenceData",
      "Name": "SimpleReferenceData",
      "GraphQLName": "SimpleReferenceData",
      "Category": "ReferenceData",
      "State": "Active",
      "Properties": [
        {
          "PropertyTypeCode": "String",
          "Id": "id",
          "Name": "id",
          "GraphQLName": "id",
          "Flags": "None",
          "State": "Active",
          "Description": "A unique identifier for the ReferenceData instance."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "modifiedDate",
          "Name": "modifiedDate",
          "GraphQLName": "modifiedDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The last modified date and time of the ReferenceData."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "createdDate",
          "Name": "createdDate",
          "GraphQLName": "createdDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The date and time at which the ReferenceData was created."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "createdByUser",
          "Name": "createdByUser",
          "GraphQLName": "createdByUser",
          "Flags": "None",
          "State": "Active",
          "Description": "The identity of the user that created the ReferenceData."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "authorizationTags",
          "Name": "authorizationTags",
          "GraphQLName": "authorizationTags",
          "Flags": "IsCollection",
          "State": "Active",
          "Description": "The list of tags used to authorize access to the ReferenceData."
        }
      ],
      "Version": 1,
      "CreatedDate": "0001-01-01T00:00:00Z",
      "ModifiedDate": "0001-01-01T00:00:00Z",
      "DefaultAuthorizationTag": "BaseAuthorizationTag",
      "Description": "This is a simple reference data type"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "property1": null,
      "property2": null
    }
  ]
}

Get Reference Data Type Acl By Id

Returns the AccessControlList for the specified ReferenceDataType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}/AccessControl

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Response

Status Code Body Type Description
200 AccessControlList Success.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.

Example response body

200 Response (AccessControlList)

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

Update Reference Data Type Acl By Id

Updates and returns the AccessControlList for the specified ReferenceDataType.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}/AccessControl

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Request Body

An AccessControlList.

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

Response

Status Code Body Type Description
200 AccessControlList Success.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.

Example response body

200 Response (AccessControlList)

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

Get Reference Data Type Owner By Id

Returns the Trustee for the specified ReferenceDataType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}/Owner

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Response

Status Code Body Type Description
200 Trustee Success.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.

Example response body

200 Response (Trustee)

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

Update Reference Data Type Owner By Id

Updates and returns the Trustee for the specified ReferenceDataType.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}/Owner

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Request Body

A Trustee.

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

Response

Status Code Body Type Description
200 Trustee Success.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.

Example response body

200 Response (Trustee)

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

List Reference Data Type Access Rights By Id

Returns a list of CommonAccessRights for the specified ReferenceDataType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/ReferenceDataTypes/{id}/AccessRights

Parameters

string tenantId

string namespaceId

string id
The id of the ReferenceDataType.

Response

Status Code Body Type Description
200 Inline Success.
403 AdhErrorResponse Forbidden.
404 AdhErrorResponse ReferenceDataType not found.

Definitions

ReferenceDataType

Represents a ReferenceDataType object.

Properties

Property Name Data Type Required Nullable Description
Name string false true The name of this object
GraphQLName string false true The name of this object as it appears in GraphQL
Version int32 false false The current version number of this object
Id string false true The id which is used in lookup
State LifeCycleState false false The lifecycle state of this object
CreatedDate date-time false true Date this object was created
ModifiedDate date-time false true The last time this object was modified
Description string false true Description of what this object is
Category ReferenceDataCategory false false Determine what category the ReferenceDataType falls into
Properties [TypeProperty] false true List of TypeProperty associated with this ReferenceDataType
DefaultAuthorizationTag string false true The authorization tag that will be added to all instances of nodes based on the type 
{
  "Id": "SimpleReferenceData",
  "Name": "SimpleReferenceData",
  "GraphQLName": "SimpleReferenceData",
  "Category": "ReferenceData",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the ReferenceData instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the ReferenceData."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the ReferenceData was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the ReferenceData."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the ReferenceData."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple reference data type"
}

LifeCycleState

Enumerated Values

Property Value
Active 0
Deprecated 1
Deleted 2

ReferenceDataCategory

Enumerated Values

Property Value
ReferenceData 0
ExternalReference 1

TypeProperty

Properties

Property Name Data Type Required Nullable Description
PropertyTypeCode PropertyTypeCode false false Code that explains what kind of typeProperty this is
Id string false true The id; used in lookup
Name string false true The name of this TypeProperty
GraphQLName string false true The name of this TypeProperty as it appears in GraphQL
Flags PropertyTypeFlags false false Flag that denotes what special attributes this property has
State LifeCycleState false false The lifecycle state of this TypeProperty
PropertyTypeId string false true The id of the type that this property points to
RemoteReferenceName string false true The name of the invisible property that is generated in GraphQL type schema if the ReverseLookup flag is set that points to this TypeProperty
Description string false true Description of what this TypeProperty is
Uom string false true The unit of measure for the type property. This property is only present/valid for numeric PropertyTypeCodes 
{
  "PropertyTypeCode": 0,
  "Id": "string",
  "Name": "string",
  "GraphQLName": "string",
  "Flags": 0,
  "State": 0,
  "PropertyTypeId": "string",
  "RemoteReferenceName": "string",
  "Description": "string",
  "Uom": "string"
}

PropertyTypeCode

Enumerated Values

Property Value
Empty 0
Boolean 3
Int32 9
Int64 11
Double 14
DateTime 16
String 18
TimeSpan 21
Event 10000
Enumeration 10001
ReferenceData 10002
Asset 10003

PropertyTypeFlags

Enumerated Values

Property Value
None 0
NoReverseLookup 1
Indexed 2
Required 4
IsCollection 8
NoUom 16
NoAggregation 32

AdhErrorResponse

Properties

Property Name Data Type Required Nullable Description
OperationId string false true An optional unique string used to identify an operation
Error string false true Description of the error
Reason string false true Short blurb on why the error occured
Resolution string false true Short blurb on how to fix the error 
{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

MultiStatusResultOfReferenceDataTypeAndAdhErrorResponse

Properties

Property Name Data Type Required Nullable Description
Reason string false false Short blurb on why the error occured
Error string false false Description of the error
OperationId string false false An optional unique string used to identify an operation
Data [ReferenceDataType] false false List of data returned from the multi-calls
ChildErrors [AdhErrorResponse] false false List of errors from all the multi-calls 
{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SimpleReferenceData",
      "Name": "SimpleReferenceData",
      "GraphQLName": "SimpleReferenceData",
      "Category": "ReferenceData",
      "State": "Active",
      "Properties": [
        {
          "PropertyTypeCode": "String",
          "Id": "id",
          "Name": "id",
          "GraphQLName": "id",
          "Flags": "None",
          "State": "Active",
          "Description": "A unique identifier for the ReferenceData instance."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "modifiedDate",
          "Name": "modifiedDate",
          "GraphQLName": "modifiedDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The last modified date and time of the ReferenceData."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "createdDate",
          "Name": "createdDate",
          "GraphQLName": "createdDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The date and time at which the ReferenceData was created."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "createdByUser",
          "Name": "createdByUser",
          "GraphQLName": "createdByUser",
          "Flags": "None",
          "State": "Active",
          "Description": "The identity of the user that created the ReferenceData."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "authorizationTags",
          "Name": "authorizationTags",
          "GraphQLName": "authorizationTags",
          "Flags": "IsCollection",
          "State": "Active",
          "Description": "The list of tags used to authorize access to the ReferenceData."
        }
      ],
      "Version": 1,
      "CreatedDate": "0001-01-01T00:00:00Z",
      "ModifiedDate": "0001-01-01T00:00:00Z",
      "DefaultAuthorizationTag": "BaseAuthorizationTag",
      "Description": "This is a simple reference data type"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "property1": null,
      "property2": null
    }
  ]
}

AccessControlList

Properties

Property Name Data Type Required Nullable Description
RoleTrusteeAccessControlEntries [AccessControlEntry] false true None 
{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

Property Name Data Type Required Nullable Description
Trustee Trustee false true None
AccessType AccessType false false None
AccessRights int64 false false None 
{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

Trustee

Properties

Property Name Data Type Required Nullable Description
Type TrusteeType false false None
ObjectId string false true None
TenantId string false true None 
{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

Property Value
User 1
Client 2
Role 3

AccessType

Enumerated Values

Property Value
Allowed 0
Denied 1
In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in