Задачи

Спецификация OpenAPI

• tasks
  • getПолучение списка задач
  • postСоздание задачи
  • getПолучение задачи
  • putОбновление задачи
  • putИзменение статуса задачи

API docs by Redocly

Публичный API (0.0.0)

Публичный API 2ГИС ГеоПоток

tasks

Получение списка задач

Возвращает страницу со списком задач.

Authorizations:

BearerAuth

query Parameters

limit required	integer Максимальное число задач в ответе, от 1 до 100.
cursor	string Курсор для получения следующей или предыдущей страницы результатов.

Responses

Response Schema: application/json

required	object (CursorResponse) Курсоры следующей и предыдущей страниц результата.
required	Array of objects (TaskResponse) Элементы текущей страницы.

URL сервера

https://geoflow.2gis.ru/public/api/v1/tasks

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "cursor": {

  • "next": "string",
  • "prev": "string"

  },
• "items": [

  • {

    • "attributes": [

      • {

        • "data": {

          • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
          • "type": "text",
          • "value": "string"

          }

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "status_alias": "created",
    • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Создание задачи

Создаёт задачу по указанному шаблону.

Authorizations:

BearerAuth

Request Body schema: application/json

required

Данные для создания задачи.

required	Array of objects (Attribute) Значения атрибутов задачи.
template_id required	string <uuid> Идентификатор шаблона задачи.

Responses

Response Schema: application/json

required	Array of objects (Attribute) Значения атрибутов задачи.
created_at required	string <date-time> Дата и время создания задачи в формате RFC 3339.
id required	string <uuid> Идентификатор задачи.
status_alias required	string (TaskStatusAlias) Enum: "created" "ready" "in_progress" "completed" "cancelled" Текущий статус задачи: created, ready, in_progress, completed или cancelled.
template_id required	string <uuid> Идентификатор шаблона задачи.
updated_at required	string <date-time> Дата и время последнего обновления задачи в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/tasks

Request samples

• Payload

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc"

}

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "status_alias": "created",
• "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
• "updated_at": "2019-08-24T14:15:22Z"

}

Получение задачи

Возвращает данные задачи, включая статус, по её идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор задачи.

Responses

Response Schema: application/json

required	Array of objects (Attribute) Значения атрибутов задачи.
created_at required	string <date-time> Дата и время создания задачи в формате RFC 3339.
id required	string <uuid> Идентификатор задачи.
status_alias required	string (TaskStatusAlias) Enum: "created" "ready" "in_progress" "completed" "cancelled" Текущий статус задачи: created, ready, in_progress, completed или cancelled.
template_id required	string <uuid> Идентификатор шаблона задачи.
updated_at required	string <date-time> Дата и время последнего обновления задачи в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/tasks/{id}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "status_alias": "created",
• "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
• "updated_at": "2019-08-24T14:15:22Z"

}

Обновление задачи

Обновляет данные задачи по её идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор задачи.

Request Body schema: application/json

required

Новые значения атрибутов задачи.

	Array of objects (Attribute) Значения атрибутов задачи.
id required	string <uuid> Идентификатор задачи. Должен совпадать с идентификатором в пути запроса.

Responses

Response Schema: application/json

required	Array of objects (Attribute) Значения атрибутов задачи.
created_at required	string <date-time> Дата и время создания задачи в формате RFC 3339.
id required	string <uuid> Идентификатор задачи.
status_alias required	string (TaskStatusAlias) Enum: "created" "ready" "in_progress" "completed" "cancelled" Текущий статус задачи: created, ready, in_progress, completed или cancelled.
template_id required	string <uuid> Идентификатор шаблона задачи.
updated_at required	string <date-time> Дата и время последнего обновления задачи в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/tasks/{id}

Request samples

• Payload

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "status_alias": "created",
• "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
• "updated_at": "2019-08-24T14:15:22Z"

}

Изменение статуса задачи

Изменяет статус задачи по её идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор задачи.

Request Body schema: application/json

required

Новый статус задачи.

status_alias required

string (TaskStatusAlias) Enum: "created" "ready" "in_progress" "completed" "cancelled" Новый статус задачи: created, ready, in_progress, completed или cancelled.

Responses

Response Schema: application/json

required	Array of objects (Attribute) Значения атрибутов задачи.
created_at required	string <date-time> Дата и время создания задачи в формате RFC 3339.
id required	string <uuid> Идентификатор задачи.
status_alias required	string (TaskStatusAlias) Enum: "created" "ready" "in_progress" "completed" "cancelled" Текущий статус задачи: created, ready, in_progress, completed или cancelled.
template_id required	string <uuid> Идентификатор шаблона задачи.
updated_at required	string <date-time> Дата и время последнего обновления задачи в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/tasks/{id}/status

Request samples

• Payload

Content type

application/json

{

• "status_alias": "created"

}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "attributes": [

  • {

    • "data": {

      • "attribute_id": "ef88e6be-6132-42c9-abcd-a9aadce04df6",
      • "type": "text",
      • "value": "string"

      }

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "status_alias": "created",
• "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
• "updated_at": "2019-08-24T14:15:22Z"

}