Terminer la convention

POST

/entreprise/v1/conventions/{id}/resiliation

curl --request POST \
  --url https://example.com/entreprise/v1/conventions/example/resiliation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-Correlation-Id: example' \
  --header 'X-Tenant-Id: example' \
  --data '{}'

Autorisations

• authentification
  entreprise:administration

Paramètres

Paramètres (path)

id

required

string

>= 1 characters

L’identifiant publié de la ressource.

Paramètres (header)

X-Tenant-Id

required

string

>= 1 characters

Le teneur de compte — injecté et signé par la passerelle ; le corps ne choisit jamais le tenant. Une ressource d’un autre tenant est traitée comme inexistante.

X-Correlation-Id

required

string

>= 1 characters

La corrélation de bout en bout — reprise dans toute réponse.

X-Causation-Id

string

>= 1 characters

Présent lorsqu’une commande en déclenche une autre.

Idempotency-Key

required

string

>= 1 characters

La clé d’idempotence de la commande — le rejeu de la même clé et de la même commande retourne le résultat initial ; une charge différente sous la même clé retourne 409.

Corps de la requête^required

Media typeapplication/json

Une intention métier. Les exigences déjà contractuelles (acte cité, clause source, déclarant et périmètre d’une enveloppe…) sont dites à l’opération.

object

key

additional properties

any

Example^generated

{}

Réponses

200

La commande est servie — la ressource, sa version et la corrélation ; le rejeu idempotent retourne ce même résultat.

Media typeapplication/json

La réponse de toute commande servie.

object

resource_id

required

string

version

required

integer

correlation_id

required

string

suivi

Le lien de suivi — présent sur une application de chargement (202).

string

Example^generated

{
  "resource_id": "example",
  "version": 1,
  "correlation_id": "example",
  "suivi": "example"
}

400

Syntaxe ou champ invalide (400) — le motif nomme le champ.

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}

401

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

403

L’identité présentée n’a pas la famille d’accès entreprise:administration (403) — les 403 croisés entre familles sont prouvés par les tests d’assemblage. Un mandat métier manquant n’est pas un 403 : c’est un refus métier (422).

404

Ressource absente ou invisible — y compris une ressource d’un autre tenant (le régime de la muraille : 404, jamais 403).

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}

409

Conflit de version, d’idempotence ou d’invariant (409).

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}

422

Commande comprise mais impossible au regard du métier (422).

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}

429

Quota du tenant atteint (429).

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}

503

Dépendance indisponible, sans effet partiel (503).

Media typeapplication/json

object

code

required

Par exemple ENT_VERSION_CONFLICT.

string

message

required

string

correlation_id

required

string

details

Array<object>

object

champ

string

motif

string

Example^generated

{
  "code": "example",
  "message": "example",
  "correlation_id": "example",
  "details": [
    {
      "champ": "example",
      "motif": "example"
    }
  ]
}