v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Data Model

This endpoint provides a list of LinkTypes, it can be paginated with the pagination=true parameter

Retrieves the collection of LinkType resources.

get/link-types

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[priority]'asc' | 'desc'

order[id]'asc' | 'desc'

idstring

id[]string[]

catalogs.idstring

catalogs.id[]string[]

origin.objectTypestring

origin.objectType[]string[]

origin.documentType.idstring

origin.documentType.id[]string[]

target.objectTypestring

target.objectType[]string[]

target.documentType.idstring

target.documentType.id[]string[]

order[origin]'asc' | 'desc'

order[target]'asc' | 'desc'

searchstring

order[name]'asc' | 'desc'

namestring

name[]string[]

Response

LinkType collection

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"
  }
]