List terms for a skill taxonomy

GET

/v1/skill-taxonomies/{taxonomyId}/terms

curl -X GET 'https://api.embodiflow.io/v1/skill-taxonomies/{taxonomyId}/terms' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

taxonomyIdstringrequired

Query parameters

pageSizenumber
Page size (default 25, maximum 100). Over-maximum is refused.
pageTokenstring
Opaque page token from the previous response.

Responses

Success

dataarray<SkillTaxonomyTermDto>required
- idstring | nullrequired
- termIdentitystringrequired
- codestringrequired
- displayLabelstringrequired
- labelsobjectrequired
- parentTermIdentitystring | nullrequired
- assignableone ofrequired
- definitionstringrequired
- positiveExamplesarray<string>required
- negativeExamplesarray<string>required
- externalMappingsarray<SkillExternalMapping>required
- originLayerstringrequired
  Allowed values
  tenant
  project
  platform
- statusstringrequired
  Allowed values
  active
  deprecated
  retired
- successorTermIdentitystring | nullrequired
- enabledone ofrequired
- coverageFloorone ofrequired
- provenanceobjectrequired
- sourcesobjectrequired
nextPageTokenstring
Opaque AIP-158 page token. Omitted when the collection is exhausted.
metaobjectrequired
- pageSizenumberrequired
- totalCountnumber
- requestIdstring

Response example

{
  "data": [
    {
      "id": "string",
      "termIdentity": "string",
      "code": "string",
      "displayLabel": "string",
      "labels": {},
      "parentTermIdentity": "string",
      "assignable": false,
      "definition": "string",
      "positiveExamples": [
        "string"
      ],
      "negativeExamples": [
        "string"
      ],
      "externalMappings": [
        {
          "source": "string",
          "sourceVersion": "string",
          "externalCode": "string",
          "externalLabel": "string",
          "mappingKind": "exact",
          "confidence": 0
        }
      ],
      "originLayer": "tenant",
      "status": "active",
      "successorTermIdentity": "string",
      "enabled": false,
      "coverageFloor": false,
      "provenance": {
        "originLayer": "tenant",
        "sourceRevision": "string",
        "fields": {}
      },
      "sources": {}
    }
  ],
  "nextPageToken": "string",
  "meta": {
    "pageSize": 0,
    "totalCount": 0,
    "requestId": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

{ "data": [ { "id": "string", "termIdentity": "string", "code": "string", "displayLabel": "string", "labels": {}, "parentTermIdentity": "string", "assignable": false, "definition": "string", "positiveExamples": [ "string" ], "negativeExamples": [ "string" ], "externalMappings": [ { "source": "string", "sourceVersion": "string", "externalCode": "string", "externalLabel": "string", "mappingKind": "exact", "confidence": 0 } ], "originLayer": "tenant", "status": "active", "successorTermIdentity": "string", "enabled": false, "coverageFloor": false, "provenance": { "originLayer": "tenant", "sourceRevision": "string", "fields": {} }, "sources": {} } ], "nextPageToken": "string", "meta": { "pageSize": 0, "totalCount": 0, "requestId": "string" } }