Get Term Set

GET

https://api.markup.ai/style-agent/terminology/term-sets/:term_id

GET

/style-agent/terminology/term-sets/:term_id

curl https://api.markup.ai/style-agent/terminology/term-sets/term_id \
     -H "Authorization: Bearer <token>"

{
  "concept_id": "string",
  "concept_uuid": "string",
  "terms": [
    {
      "id": "string",
      "uuid": "string",
      "external_id": "string",
      "conceptid": "string",
      "conceptuuid": "string",
      "isconcept": "string",
      "surface": {
        "surface": "string",
        "lemmastart": 1,
        "lemmalength": 1,
        "lowercasesurface": "string"
      },
      "language": {
        "id": "string",
        "type": "string",
        "name": "string",
        "displayname": "string",
        "issystem": true,
        "uuid": "string",
        "external_id": "string",
        "parent": "string",
        "priority": 1
      },
      "status": {
        "id": "string",
        "type": "string",
        "name": "string",
        "displayname": "string",
        "issystem": true,
        "uuid": "string",
        "external_id": "string",
        "parent": "string",
        "priority": 1
      },
      "msr": {
        "id": "string",
        "type": "string",
        "name": "string",
        "displayname": "string",
        "issystem": true,
        "uuid": "string",
        "external_id": "string",
        "parent": "string",
        "priority": 1
      },
      "categories": [
        {
          "id": "string",
          "type": "string",
          "name": "string",
          "displayname": "string",
          "issystem": true,
          "uuid": "string",
          "external_id": "string",
          "parent": "string",
          "priority": 1
        }
      ],
      "variantsconfigurations": "string",
      "variant_settings": {
        "rules": {
          "flagVariants": true,
          "allowHyphen": true,
          "allowTitleAnywhere": true,
          "allowUpperCase": true,
          "allowBOS": true,
          "requireBOSFormAtBOS": true,
          "upperCaseTitleAfterHyphen": true,
          "applyMcatRestriction": true
        },
        "bosForms": [
          "string"
        ],
        "titleForms": [
          "string"
        ],
        "alwaysFlag": [
          "string"
        ],
        "neverFlag": [
          "string"
        ]
      },
      "frequency": 0,
      "creationdate": "2024-01-15T09:30:00Z",
      "creator": "string",
      "lastmodificationdate": "2024-01-15T09:30:00Z",
      "lastmodifier": "string",
      "linked_term_count": 0,
      "member_count": 0,
      "custom_fields": {},
      "custom_field_values": [
        {
          "field_id": "string",
          "field_uuid": "string",
          "name": "string",
          "displayname": "string",
          "type": "string",
          "isconceptlevel": true,
          "ismultiline": true,
          "location": 1,
          "string_value": "string",
          "category_values": [
            {
              "id": "string",
              "type": "string",
              "name": "string",
              "displayname": "string",
              "issystem": true,
              "uuid": "string",
              "external_id": "string",
              "parent": "string",
              "priority": 1
            }
          ]
        }
      ]
    }
  ]
}

Get the whole entry (concept) a term belongs to, with all its terms.

Returns 404 if the term does not exist in this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

term_idstringRequiredformat: "uuid"

Response

Successful Response

concept_idstring

concept_uuidstring

termslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error