APIСправочник API
Граф связей
GET /v1/observations/{observation_id}/graph
GET /v1/observations/{observation_id}/graph
Доступ
Требуется bearer-авторизация. Описание операции задаёт дополнительные права, роли и ограничения для сессий кабинета. Сам по себе API-ключ их не предоставляет.
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
observation_id (path) | string | да |
Тело запроса
Тело запроса не требуется.
Ответы
| HTTP | Описание | Тип |
|---|---|---|
| 200 | Успешный ответ | application/json: Graph |
| 401 | Требуется авторизация | application/problem+json: ProblemDetails |
| 402 | Недостаточно кредитов | application/problem+json: ProblemDetails |
| 403 | Доступ запрещён | application/problem+json: ProblemDetails |
| 404 | Не найдено | application/problem+json: ProblemDetails |
| 408 | Время запроса истекло | application/problem+json: ProblemDetails |
| 413 | Превышен размер запроса | application/problem+json: ProblemDetails |
| 422 | Ошибка входных данных | application/problem+json: ProblemDetails |
| 429 | Превышен лимит | application/problem+json: ProblemDetails |
| 502 | Ошибка шлюза | application/problem+json: ProblemDetails |
| 503 | Сервис недоступен | application/problem+json: ProblemDetails |
Ответ: Graph
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
observation_id | string | да | |
nodes | GraphNode[] | да | |
edges | GraphEdge[] | да | |
algorithmic_balance | ImputedComponents | да | |
truncated | boolean | да | |
omitted_participations | integer | да | |
node_limit | integer | да | |
product_is_role_projection | boolean | да |
Полная схема
{
"properties": {
"observation_id": {
"type": "string",
"title": "Observation Id"
},
"nodes": {
"items": {
"$ref": "#/components/schemas/GraphNode"
},
"type": "array",
"title": "Nodes"
},
"edges": {
"items": {
"$ref": "#/components/schemas/GraphEdge"
},
"type": "array",
"title": "Edges"
},
"algorithmic_balance": {
"$ref": "#/components/schemas/ImputedComponents"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"omitted_participations": {
"type": "integer",
"title": "Omitted Participations"
},
"node_limit": {
"type": "integer",
"title": "Node Limit"
},
"product_is_role_projection": {
"type": "boolean",
"title": "Product Is Role Projection"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"observation_id",
"nodes",
"edges",
"algorithmic_balance",
"truncated",
"omitted_participations",
"node_limit",
"product_is_role_projection"
],
"title": "Graph"
}Эта страница генерируется из OpenAPI. Примеры показывают схемы, а не вымышленные успешные ответы.