This creates a new completeness setting

post

https://{instance_name}.quable.com/api/completenesses/settings

Creates a CompletenessSetting resource.

Body Params

The new CompletenessSetting resource

color

string

required

Defaults to #4DABF7

This will be used to display the completeness on document.

fields

array of strings

This is an array of field identifiers.

fields

attributes

array of objects

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

attributes

linkTypes

object of strings

This is an array of link types identifiers.

string

required

length ≤ 255

This is the unique identifier of the resource

documentTypeCode

string

required

length ≤ 255

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

description

object

This structure does accept key & values where key has to be a language code configured in your PIM & the value is the value for this field in this language.

name

object

required

This structure does accept key & values where key has to be a language code configured in your PIM & the value is the value for this field in this language.

Headers

string

enum

Defaults to application/ld+json

Generated from available response content types

Allowed:

Responses

400

Invalid input

422

Unprocessable entity

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/ld+json

application/hal+json

application/json

text/html

201CompletenessSetting resource created