Get base & core attribute values of a Entity.

1min
GET
https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}
API to get information (base & core attribute values) of a Entity (specified by EntityId) of entity type specified by entityTypePluralName.
Path Parameters
entityTypePluralName
EntityTypePluralName
*
entityId
UniqueInstanceId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-APPID
string
*
Responses
200
Entity
EntityResponse
data
GetSingleEntityResponseData
*
All Of
object  +
request
Request
*
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// Entity 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Entity 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 16 Oct 2024
Did this page help you?
Update core attributes of a Entity.