Aller au contenu
Documentation de la Plateforme

Créer une version de périmètre

POST
/relation-tiers/v1/relationships/{relationshipId}/scopes
curl --request POST \
  --url https://example.com/relation-tiers/v1/relationships/example/scopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "members": [ { "mode": "example", "domain": "example", "objectType": "example", "objectId": "example", "purpose": "example" } ], "expression": "example", "expressionLanguageVersion": "example" }'

Autorisations

Section intitulée « Autorisations »

Paramètres

Section intitulée « Paramètres »

Paramètres (path)

Section intitulée « Paramètres (path) »
relationshipId
required
string

Paramètres (header)

Section intitulée « 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 ; même clé et même contenu rejouent le résultat initial, même clé et contenu différent font 409 IDEMPOTENCY_CONFLICT.

Corps de la requêterequired

Section intitulée « Corps de la requêterequired »
Media typeapplication/json
object
members
required
Array<object>
object
mode
required
string
domain
required
string
objectType
required
string
objectId
string
purpose
string
expression

Expression dynamique dans le langage canonique versionné — jamais une requête SQL ni un filtre CRM.

string
expressionLanguageVersion
string
Examplegenerated
{
  "members": [
    {
      "mode": "example",
      "domain": "example",
      "objectType": "example",
      "objectId": "example",
      "purpose": "example"
    }
  ],
  "expression": "example",
  "expressionLanguageVersion": "example"
}

Réponses

Section intitulée « Réponses »

201

Section intitulée « 201 »

La version de périmètre est créée.

Media typeapplication/json
object
id
required
string
aggregateVersion
required
integer
status
required
string
Examplegenerated
{
  "id": "example",
  "aggregateVersion": 1,
  "status": "example"
}

401

Section intitulée « 401 »

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

403

Section intitulée « 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 ne produit jamais ce code sur une ressource — il produit 404 (ne rien révéler).

404

Section intitulée « 404 »

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

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details) — le texte n’expose ni l’existence d’un objet d’un autre tenant, ni une donnée sensible.

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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "correlationId": "example",
  "retryable": true,
  "violations": [
    {
      "field": "example",
      "reason": "example",
      "ruleId": "example"
    }
  ]
}

409

Section intitulée « 409 »

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

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details) — le texte n’expose ni l’existence d’un objet d’un autre tenant, ni une donnée sensible.

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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "correlationId": "example",
  "retryable": true,
  "violations": [
    {
      "field": "example",
      "reason": "example",
      "ruleId": "example"
    }
  ]
}

422

Section intitulée « 422 »

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

Media typeapplication/json

L’enveloppe d’erreur du catalogue (Problem Details) — le texte n’expose ni l’existence d’un objet d’un autre tenant, ni une donnée sensible.

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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "correlationId": "example",
  "retryable": true,
  "violations": [
    {
      "field": "example",
      "reason": "example",
      "ruleId": "example"
    }
  ]
}