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

Request

  • Base URL
    https://{instance_name}.quable.com/api
  • URL
    https://{instance_name}.quable.com/api/completenesses/settings
  • Auth
    API key in header Authorization

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",
      "<*>": "..."
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.