Перейти к содержанию

Получение ПО по ID

Запрос

Тип Метод
GET /software/{id}

Описание: При выполнении запроса будет возвращено ПО с соответствующим ID.

Пример запроса

GET
http://127.0.0.1/cruddy/v2/software/{id}

Path параметры запроса:

Параметр Описание
{id} Идентификатор ПО

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа модель ПО.

Пример ответа

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "trace_id": "uuid",
  "name": "string",
  "raw_output_line": "string",
  "version": "string",
  "release": "string",
  "os": "string",
  "display_name": "string",
  "description": "string",
  "software_group_id": "d7939ec9-4754-44e2-b522-27172eae4658",
  "tsvector": "'17':4,12 '17.5.2.1':8,16,17 'driver':3,11 'for':5,13 'microsoft':1,9 'odbc':2,10 'server':7,15 'sql':6,14",
  "assets_count": 0,
  "is_group": true,
  "software_count": 0,
  "software_group": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2023-12-20T00:00:01.652259Z",
    "updated_at": "2023-12-20T00:00:01.652259Z",
    "trace_id": "uuid",
    "name": "Новая группа ПО",
    "description": "Описание новой группы ПО",
    "add_new_software_versions": false
  },
  "service_assets": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2023-12-20T00:00:01.652259Z",
      "updated_at": "2023-12-20T00:00:01.652259Z",
      "trace_id": "uuid",
      "type": "Host",
      "name": "Актив",
      "description": "Описание актива",
      "coordinates": "--- []",
      "active": true,
      "scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
      "value": 3,
      "client_note": "string",
      "internal_note": "string",
      "location": "string",
      "network_exposure": 3,
      "responsible_person": "string",
      "technical_specialist": "string",
      "responsible_group_id": "2d40d7ca-3218-4132-89ef-42e29379a567",
      "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c"
    }
  ],
  "_relations": {
    "service_assets": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}

Другие возможные ответы

Код Ответ Описание
400 id should be uuid format Недопустимый формат ID, должен быть uuid
404 not found Объект не найден
500 Internal Server Error Другие ошибки при получении объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 404

{
  "error": "Not Found",
  "error_code": 404
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}