Reference Data

Rest Asp.net Core controller

Query Reference Data

Queries one or many referenceData entities of a specified TypeId from the Graph Storage.
The response will vary based on the TypeId and if you query for a single entity (by id), or for many entities, or for many entities with paging.

Request

GET /api/v1.0-preview/tenants/{tenantId}/namespaces/{namespaceId}/referencedata
?typeId={typeId}&id={id}&fields={fields}&filter={filter}&orderBy={orderBy}&count={count}&continuationToken={continuationToken}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
The referenceData TypeId to query.

[optional] string id
The id of the entntiy to get. If id is specified, then only the fields optional argument will be processed. Also the response JSON will be a single object and not an array.

[optional] string fields
The names of the fields to be returned separated by spaces. You can specify simple GraphQL syntax for relationships (ex: asset{id}}. If not specified, it defaults to all non-collection properties.

[optional] string filter
The filter to apply to the query.

[optional] string orderBy
The order by directive specifies the field name and either ascending (asc) or descending (desc). The default is asc.

[optional] integer count
The number of entities to return.

[optional] string continuationToken
Specifies you want a page of data with count entities. You must pass an empty token to get the 1st page. The response is different when using paging.

Response

Example response body

200 Response

[
  {
    "id": "critical",
    "color": "red",
    "severity": 2
  },
  {
    "id": "notice",
    "color": "blue",
    "severity": 8
  }
]

400 Response (ErrorResponse)

{
  "reason": "string",
  "error": "string",
  "resolution": "string",
  "data": [
    null
  ],
  "childErrors": [
    {
      "StatusCode": 100,
      "Reason": "string",
      "Error": "string",
      "Resolution": "string",
      "Id": "string"
    }
  ]
}

Upsert Reference Data

Upserts one or many referenceData entities of a specified TypeId to the Graph Storage.
If the body contains a JSON array, it upserts many entities. If the body contains a single JSON object it upserts one entity.
The response will reflect the written JSON.

Request

POST /api/v1.0-preview/tenants/{tenantId}/namespaces/{namespaceId}/referencedata
?typeId={typeId}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
The referenceData TypeId being added or updated

Request Body

Response

Example response body

200 Response

[
  {
    "id": "critical",
    "color": "red",
    "severity": 2
  },
  {
    "id": "notice",
    "color": "blue",
    "severity": 8
  }
]

207 Response

{
  "Reason": "See child errors",
  "Error": "Some of the elements in the request failed.",
  "Data": [
    {
      "id": "critical",
      "color": "red",
      "severity": 2
    }
  ],
  "ChildErrors": [
    {
      "StatusCode": 412,
      "Reason": "OPTIMISTIC_CONCURRENCY_ERROR",
      "Error": "Optimistic concurrency error",
      "Id": "notice"
    }
  ]
}

400 Response (ErrorResponse)

{
  "reason": "string",
  "error": "string",
  "resolution": "string",
  "data": [
    null
  ],
  "childErrors": [
    {
      "StatusCode": 100,
      "Reason": "string",
      "Error": "string",
      "Resolution": "string",
      "Id": "string"
    }
  ]
}

Delete Reference Data

Deletes one referenceData entity of a specified TypeId from the Graph Storage.

Request

DELETE /api/v1.0-preview/tenants/{tenantId}/namespaces/{namespaceId}/referencedata
?typeId={typeId}&id={id}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string typeId
The referenceData TypeId being deleted.

string id
The referenceData id to delete.

Response

Definitions

ErrorResponse

event response

Properties

{
  "reason": "string",
  "error": "string",
  "resolution": "string",
  "data": [
    null
  ],
  "childErrors": [
    {
      "StatusCode": 100,
      "Reason": "string",
      "Error": "string",
      "Resolution": "string",
      "Id": "string"
    }
  ]
}

EventError

Event child error

Properties

{
  "StatusCode": 100,
  "Reason": "string",
  "Error": "string",
  "Resolution": "string",
  "Id": "string"
}

HttpStatusCode

Enumerated Values