v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Data Enhancement

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

Retrieves the collection of CompletenessSetting resources.

get/completenesses/settings

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[id]'asc' | 'desc'

order[documentType.id]'asc' | 'desc'

order[name]'asc' | 'desc'

Response

CompletenessSetting collection

colorstring required

fieldsstring[]

This is an array of field identifiers.

attributesobject[]

This is an array of field identifiers. The field "attributeSet" is deprecated and will be removed after the 2023-10-15

legacyIdinteger

idstring required

This is the unique identifier of the resource

documentTypeCodestring required

This is the unique identifier of the document type that the resource should be apply to

dateModifiedstring date-time nullable

This is an ISO datetime

dateCreatedstring date-time nullable

This is an ISO datetime

Example response

[
  {
    "color": "#4DABF7",
    "fields": [
      "name",
      "web_description"
    ],
    "attributes": [
      {
        "id": "name",
        "attributeSet": null
      },
      {
        "id": "web_description",
        "attributeSet": {
          "id": "chaussures"
        }
      }
    ],
    "linkTypes": {
      "minimum": 1
    },
    "id": "identifier_example",
    "documentTypeCode": "document_type_example",
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    }
  }
]