Get Domain

Get Domain information stored in the system.

Get Domain

cURL

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/taxonomy/domains/{domain_external_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "domain_name": "IT & Engineering",
  "last_updated": "2021-01-21T17:32:28Z"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

domain_external_id · string · required

The unique Domain ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Query Parameters

include · enum<string>[]

Additional Domain attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options: custom_properties

Response

200

application/json

OK

Default structure for Domain.

external_id · string<uuid> · required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

domain_name · string · required

Name of the Domain.

Required string length: 1 - 255

Example:

"IT & Engineering"

last_updated · string<date-time> · required

Timestamp of the last update to this entity.

Example:

"2021-01-21T17:32:28Z"