Skip to main content

GET - Метаданные

Описание​

Метод GET /metadata/types/{type} используется для получения метаданных указанного типа. Доступные типы:

  • actionValueType
  • currency
  • language
  • pointType
  • permission
  • role
  • taskState
  • zoneId

Параметры пути​

Параметры​

ПараметрТипОбязательноОписание
typestringДаТип метаданных, которые необходимо получить. Доступные значения: actionValueType, currency, language, pointType, permission, role, taskState, zoneId.

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

URL запроса​

GET /metadata/types/taskStatus

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

{
  "type": "taskStatus",
  "values": [
    {
      "key": "OPEN",
      "value": "OPEN"
    },
    {
      "key": "READY_TO_DO",
      "value": "READY_TO_DO"
    },
    {
      "key": "IN_PROGRESS",
      "value": "IN_PROGRESS"
    },
    {
      "key": "COMPLETED",
      "value": "COMPLETED"
    },
    {
      "key": "CANCELLED",
      "value": "CANCELLED"
    },
    {
      "key": "EXTRA_WORK_REQUIRED",
      "value": "EXTRA_WORK_REQUIRED"
    },
    {
      "key": "CLOSED",
      "value": "CLOSED"
    }
  ]
}

Возможные ошибки​

404 Ресурс не найден​

Код ответа​

404 Not Found

Тело ответа​

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание​

Запрашиваемый тип метаданных не найден.

500 Внутренняя ошибка сервера​

Код ответа​

500 Internal Server Error

Тело ответа​

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Описание​

На сервере произошла ошибка. Повторите запрос позже или обратитесь в службу поддержки.

Итог​

Метод GET /metadata/types/{type} позволяет получить метаданные различных типов, таких как статус задачи, валюты, роли и т. д. Убедитесь, что в пути запроса указан корректный тип метаданных.