Référence API
API : company-relations
1 opérations REST du groupe company-relations.
GET /company-relations#
Natures de relation des sociétés (référentiel court, une page complète)
Scopes d'app : referentials:read. Les autres droits, périmètres et contrôles métier restent applicables.
Aucun corps de requête déclaré dans ce contrat.
Réponses
200 : La liste de l'organisation (défaut : partenaire, fournisseur, concurrent, prescripteur, sous-traitant)
Contenu de la réponse 200
{
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
},
"description": "Natures de relation de l'organisation, dans l'ordre de la liste ; `key` est la valeur de company.relations"
},
"nextCursor": {
"type": "null"
}
},
"required": [
"data",
"nextCursor"
],
"additionalProperties": false
}
}
}default : Erreur - enveloppe problem+json (RFC 9457)
Contenu de la réponse default
{
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}Opération OpenAPI complète
{
"summary": "Natures de relation des sociétés (référentiel court, une page complète)",
"tags": [
"Référentiels"
],
"security": [
{
"oauth2": [
"referentials:read"
]
},
{
"userSession": []
}
],
"responses": {
"200": {
"description": "La liste de l'organisation (défaut : partenaire, fournisseur, concurrent, prescripteur, sous-traitant)",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
},
"description": "Natures de relation de l'organisation, dans l'ordre de la liste ; `key` est la valeur de company.relations"
},
"nextCursor": {
"type": "null"
}
},
"required": [
"data",
"nextCursor"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "Erreur - enveloppe problem+json (RFC 9457)",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}