Get configuration of a entity type

1min
GET
https://{tenantSubdomain}.io/core/api/v2/entity/entity-type/{entityTypePluralName}
Get basic configuration of a entity type specified by EntityTypePluralName.
Path Parameters
entityTypePluralName
EntityTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-APPID
string
*
X-COREOS-ORIGIN-TOKEN
string
*
Query Parameters
searchByTag
string
groupByTag
boolean
Responses
200
entity Type
EntityTypeResponse
data
EntityTypeResponseDataGet
*
All Of
BasicParams  +
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/entity-type/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/entity-type/{entityTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// entity Type 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// entity Type 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 16 Oct 2024
Did this page help you?
Update entity type configuration