La photographie

GET

/entreprise/v1/populations/{id}

curl --request GET \
  --url https://example.com/entreprise/v1/populations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Correlation-Id: example' \
  --header 'X-Tenant-Id: example'

Autorisations

• authentification
  entreprise:consultation

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. 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.

Réponses

200

La vue datée, versionnée et minimisée. Un ETag est retourné pour les lectures conditionnelles ; la clé de cache inclut tenant, vue, date et version.

Media typeapplication/json

Une vue du référentiel — datée, versionnée, minimisée. Toute vue expose au moins la ressource, sa version et la corrélation.

object

resource_id

required

string

version

required

integer

correlation_id

required

string

Example^generated

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

Headers

ETag

string

L’empreinte de la vue servie.

401

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

403

L’identité présentée n’a pas la famille d’accès entreprise:consultation (403). Les 403 croisés entre familles sont prouvés par les tests d’assemblage.

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

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