Les relations applicables à une date et un contexte

GET

/relation-tiers/v1/relationships:applicable

curl --request GET \
  --url https://example.com/relation-tiers/v1/relationships:applicable \
  --header 'Authorization: Bearer <token>'

Autorisations

• authentification
  relation-tiers:consultation

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, et le corps ne peut jamais le choisir.

X-Correlation-Id

string

Paramètres (query)

effectiveAt

string format: date-time

La date d’effet de la lecture — la situation applicable à cette date ; absente, la lecture porte sur maintenant.

cursor

string

limit

integer

<= 200

actorId

string

relationshipType

string

Réponses

200

Les relations applicables.

Media typeapplication/json

object

items

required

Array<object>

object

relationshipId

required

string

relationshipType

required

string

status

required

string

parties

Array<object>

object

validFrom

string format: date-time

validTo

string format: date-time

aggregateVersion

integer

nextCursor

string

Example^generated

{
  "items": [
    {
      "relationshipId": "example",
      "relationshipType": "example",
      "status": "example",
      "parties": [
        {}
      ],
      "validFrom": "2026-04-15T12:00:00Z",
      "validTo": "2026-04-15T12:00:00Z",
      "aggregateVersion": 1
    }
  ],
  "nextCursor": "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 ne produit jamais ce code sur une ressource — il produit 404 (ne rien révéler).