v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Data Model

Create a new LinkType in the datamodel

Creates a LinkType resource.

post/link-types

Request body

idstring

priorityinteger

This defines the priority of the link.

maxItemsinteger nullable

This defines the maximum number of items that will be accepted while creating links. If null, an infinite number of items will be accepted.

Example request

{
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "priority": 50,
  "maxItems": 15
}

Response

LinkType resource created

legacyIdinteger

priorityinteger

This defines the priority of the link.

maxItemsinteger nullable

This defines the maximum number of items that will be accepted while creating links. If null, an infinite number of items will be accepted.

statusstring

dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

maxCountLinksByOrigininteger

idstring

This is the unique identifier of the resource

Example response

{
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "priority": 50,
  "maxItems": 15,
  "origin": {
    "documentType": {
      "id": "identifier_example"
    }
  },
  "target": {
    "documentType": {
      "id": "identifier_example"
    }
  },
  "id": "identifier_example"
}