MetaType

object
historyobject

Contains the historical information object

Show Child Parameters
paginationobject
Show Child Parameters
Example

MetaHistoryType

object

Contains the historical information object

createdstring(date-time)required

When the JSON:API Object has been created

Example:2022-01-02T18:25:43.511Z

createdBystring

Who created the JSON:API object. This should not share login information (by example, use email)

Example:chris.doe@sixgroup.com

lastModifiedstring(date-time)

When the object has been modified by the last time. This is optional value.

Example:2022-01-02T18:25:43.511Z

lastModifiedBystring

Who modified the JSON:API object.

Example:michael.rodriguez@sixgroup.com

versionstring

This is the version of the object. Should contain hash of the object to detect if this has changed before commit again new changes.

Example:AF9e94334rr44

Example

DERBase64Certificate

string

Client certificate presented by the client when connecting to the API Platform. Is a PEM
Base64-encoded.

Only present for APIs secured by Mutual TLS flow on the API Platform.

One of ‘X-Token’ or ‘X-SSL-Client-DER’ must be provided.

Example

AccessTokenPayload

string

Decrypted payload of the access token (Base64-encoded).

Only present for APIs secured by IDP Introspection or IDP Client Credentials flow on the API Platform.

One of ‘X-Token’ or ‘X-SSL-Client-DER’ must be provided.

Example

RestrictionRootType

object
attributestring

Name of the attribute to be restricted, filtered or searched

Example:high

typestring

Type of the value to be searched. This is used to validate the transformation done in the backend once the list is received

Allowed values:integerdecimalstringboolean

Example:decimal

operatorstringrequired

Operator applied in the value comparision.

Allowed values:andor

Example:and

valuesarray[object]

List of restrictions to be applied with the operator in the attribute

Show Child Parameters
Example