Annuler avec motif

POST

/relation-tiers/v1/requests/{requestId}:cancel

curl --request POST \
  --url https://example.com/relation-tiers/v1/requests/example:cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'If-Match: example' \
  --data '{ "reasonCode": "example", "effectiveAt": "2026-04-15T12:00:00Z", "comment": "example" }'

Autorisations

• authentification
  relation-tiers:demandes

Paramètres

Paramètres (path)

requestId

required

string

Paramètres (header)

X-Tenant-Id

string

Facultatif — le tenant fait foi dans le jeton ; s’il est fourni, il doit être identique, et le corps ne peut jamais le choisir.

X-Correlation-Id

string

Idempotency-Key

required

string

La clé d’idempotence de la commande — liée à l’intention métier, pas à la tentative réseau.

If-Match

required

string

La version d’agrégat attendue — 409 CONCURRENT_MODIFICATION sinon.

Corps de la requête^required

Media typeapplication/json

object

reasonCode

required

string

effectiveAt

string format: date-time

comment

string

Example^generated

{
  "reasonCode": "example",
  "effectiveAt": "2026-04-15T12:00:00Z",
  "comment": "example"
}

Réponses

200

La demande est annulée.

Media typeapplication/json

object

id

required

string

aggregateVersion

required

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 requise (403). Les 403 croisés entre familles sont prouvés par les tests d’assemblage. Un écart de tenant sur une ressource produit 404 (ne rien révéler), jamais ce code.

404

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

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details).

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"
    }
  ]
}

409

Version obsolète, chevauchement interdit ou clé d’idempotence réutilisée avec un contenu différent.

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details).

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"
    }
  ]
}

422

Donnée comprise mais non admissible — règle identifiée, référence externe non résolue ou preuve insuffisante.

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details).

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"
    }
  ]
}