GET Entities

This endpoint is used to get entities from Entity API.

URL

https://{{HOST}}/entity/api/v2.2/{entityType}{idList}

Method

GET

Required IMS Scopes

  • TODO

URL Path Parameters

Name Description Example Type
entityType
required		 Entity Type to get entities from /entity/api/v2.X/systems string
idList
optional		 Comma-separated list of Entity Id enclosed in ( ) /entity/api/v2.X/systems(id1,id2) string

URL Query Parameters

Name Description Example Type
$count
optional		 Count the number of samples in the result /entity/api/v2.X/systems?$count None
$top
optional		 limit the number of samples returned to this number /entity/api/v2.X/systems?$top=2 int32
$select
optional		 Return the samples with selected properties /entity/api/v2.X/systems?$select=name,type string
$expand
optional		 Return samples with related entities /entity/api/v2.X/systems?$expand=points string
$filter
optional		 Return samples which satisfy filter condition /entity/api/v2.X/systems?$filter=name eq ‘systems1’ string

Request Header Parameters

Type Value Description
Authentication
required		 Bearer {{access_token}} Description
org
required for v2.2		 {{org}} The org header is used in v2.2 but not in v2.1 or v2.0
appname
optional for admins		 {{appname}} Helps to narrow down what appname the requested resource is in to speed up the request

Example

Request

curl -X GET 
  https://api.digitalvault.cloud/entity/api/v2.X/{{entitytype}} 
  -H 'authorization: Bearer {{access_token}}' 
  -H 'org: {{organization}}'

Response

JSON Response

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition