Créer un export tenantisé

POST

/relation-tiers/v1/exports

curl --request POST \
  --url https://example.com/relation-tiers/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "purpose": "example", "scope": {}, "format": "example" }'

Autorisations

• authentification
  relation-tiers:administration

Paramètres

Paramètres (header)

X-Tenant-Id

string

Facultatif — le tenant fait foi dans le jeton ; s’il est fourni, il doit être identique.

X-Correlation-Id

string

Idempotency-Key

required

string

Corps de la requête^required

Media typeapplication/json

object

purpose

required

string

scope

required

object

format

string

Example^generated

{
  "purpose": "example",
  "scope": {},
  "format": "example"
}

Réponses

202

L’export est accepté — préparé puis remis sous trace.

Media typeapplication/json

object

id

required

string

aggregateVersion

integer

status

required

string

Example^generated

{
  "id": "example",
  "aggregateVersion": 1,
  "status": "example"
}

401

Aucune identité présentée (401).

403

L’identité présentée n’a pas la famille d’accès relation-tiers:administration (403).

422

Donnée comprise mais non admissible — règle identifiée.

Media typeapplication/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

correlationId

required

string

retryable

boolean

violations

Array<object>

object

field

string

reason

string

ruleId

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "correlationId": "example",
  "retryable": true,
  "violations": [
    {
      "field": "example",
      "reason": "example",
      "ruleId": "example"
    }
  ]
}