Definition

OpenAPI V2

Retrieve taxonomy definition structure based on the entrypoint.

post

Retrieve taxonomy defintion structure based on the entrypoint ID.

Authorizations

Path parameters

idstringRequired

The taxonomy entry point id (UUID)

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

400

Bad Request

application/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /taxonomy/entrypoints/{id}/definition HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

{
  "taxonomyEntrypoint": "text",
  "baseSets": [
    {
      "roleType": "text",
      "arcRoleType": "text",
      "labels": [
        {
          "label": "text",
          "language": "text",
          "labelRole": "text",
          "conceptId": "text"
        }
      ],
      "nodes": [
        {
          "name": "text",
          "uniqueId": "text",
          "namespace": "text",
          "prefix": "text",
          "dataType": "text",
          "typeQName": "text",
          "periodType": "text",
          "isAbstract": true,
          "isEnumeration": true,
          "isTuple": true,
          "enumerations": [
            {
              "name": "text",
              "labels": [
                {
                  "lang": "text",
                  "role": "text",
                  "xLinkLabel": "text",
                  "labelText": "text"
                }
              ]
            }
          ],
          "parentNodeUniqueId": "text",
          "labels": [
            {
              "label": "text",
              "language": "text",
              "labelRole": "text",
              "conceptId": "text"
            }
          ],
          "children": [
            "[Circular Reference]"
          ],
          "childrenReferences": [
            {
              "referenceId": "text",
              "labels": [
                {
                  "label": "text",
                  "language": "text",
                  "labelRole": "text",
                  "conceptId": "text"
                }
              ],
              "hasChildren": true
            }
          ],
          "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"
                }
              ]
            }
          ],
          "hasChildren": true
        }
      ],
      "nodeReferences": [
        {
          "referenceId": "text",
          "labels": [
            {
              "label": "text",
              "language": "text",
              "labelRole": "text",
              "conceptId": "text"
            }
          ],
          "hasChildren": true
        }
      ],
      "hasChildren": true
    }
  ],
  "baseSetsReferences": [
    {
      "referenceId": "text",
      "labels": [
        {
          "label": "text",
          "language": "text",
          "labelRole": "text",
          "conceptId": "text"
        }
      ],
      "hasChildren": true,
      "arcRoleType": "text"
    }
  ]
}