Concepts

OpenAPI V2

Retrieve taxonomy concepts for entrypoint id.

get

Retrieve list of concepts based on the entrypoint ID provided.

Authorizations
Path parameters
idstringRequired

The taxonomy entry point id (UUID)

Query parameters
pageNumberstringOptional

The page number of results. Optional parameter, if not provided the default value is 1.

pageSizestringOptional

The number of items per page, Optional parameter, if not provided the default value is 10

conceptNameFilterstringOptional

Filters the result concepts by name. Optional, if not provided the concept list will not be filtered by name.

Header parameters
x-api-versionstringRequired
ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Responses
200
OK
application/json
get
GET /taxonomy/{id}/concepts HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*
{
  "count": 1,
  "taxonomyConcepts": [
    {
      "uniqueId": "text",
      "name": "text",
      "namespaceUri": "text",
      "dataType": "text",
      "typeQName": "text",
      "prefix": "text",
      "periodType": "text",
      "isAbstract": true,
      "substitutionGroupType": "text",
      "isDimension": true,
      "isEnumeration": true,
      "isNillable": true,
      "balance": "text",
      "labels": [
        {
          "label": "text",
          "language": "text",
          "labelRole": "text",
          "conceptId": "text"
        }
      ],
      "enumerations": [
        {
          "name": "text",
          "labels": [
            {
              "lang": "text",
              "role": "text",
              "xLinkLabel": "text",
              "labelText": "text"
            }
          ]
        }
      ],
      "dimensionMembers": [
        {
          "dimension": "text",
          "member": "text",
          "isTypedMember": true,
          "contextElement": "text",
          "dimensionLabel": "text",
          "memberLabel": "text",
          "dimensionLabelCollection": [
            {
              "label": "text",
              "language": "text",
              "labelRole": "text",
              "conceptId": "text"
            }
          ],
          "memberLabelCollection": [
            {
              "label": "text",
              "language": "text",
              "labelRole": "text",
              "conceptId": "text"
            }
          ]
        }
      ]
    }
  ]
}

Was this helpful?