Перейти к основному содержимому

Задачи

Вы можете создавать задачи для агентов, например: доставить груз, провести инспекцию и т. д. Подробнее о задачах см. в разделе Задачи Руководства администратора.

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

Вы можете получить список задач с данными о них: ID задачи, ID шаблона, статусом, датой и временем создания и обновления и списком атрибутов.

Чтобы получить список задач, отправьте GET-запрос к /v1/tasks с параметром limit — максимальным количеством задач в ответе от 1 до 100.

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

curl --request GET \
   --url 'https://geoflow.2gis.ru/public/api/v1/tasks?limit=2' \
   --header 'Authorization: Bearer <token>'

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

response.json
{
    "items": [
        {
            "id": "d86f6491-d873-4802-bdb5-ba354245d33e",
            "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
            "attributes": [
                {
                    "data": {
                        "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                        "type": "name",
                        "value": "Задача 814"
                    }
                },
                {
                    "data": {
                        "attribute_id": "9aa20ffb-e130-44a4-8fdf-03ae30ba226b",
                        "type": "description",
                        "value": "Продукты"
                    }
                },
                {
                    "data": {
                        "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
                        "type": "time_windows_settings",
                        "value": {
                            "timezone": "Asia/Novosibirsk",
                            "time_windows": [
                                {
                                    "from": "2026-08-25T05:22:00.000Z",
                                    "to": "2026-08-25T15:22:00.000Z"
                                }
                            ],
                            "is_hard": false
                        }
                    }
                },
                {
                    "data": {
                        "attribute_id": "8bc4e8b0-3409-44d5-aad9-069ed1033b5f",
                        "type": "phone",
                        "value": "+7 (999) 999-99-99"
                    }
                }
            ],
            "status_alias": "created",
            "created_at": "2026-06-15T08:40:34.201829Z",
            "updated_at": "2026-08-24T08:10:03.423399Z"
        },
        {
            "id": "782700da-3370-444e-9cae-f13c80cf6cf2",
            "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
            "attributes": [
                {
                    "data": {
                        "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                        "type": "name",
                        "value": "Задача 815"
                    }
                },
                {
                    "data": {
                        "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
                        "type": "time_windows_settings",
                        "value": {
                            "timezone": "Asia/Novosibirsk",
                            "time_windows": [
                                {
                                    "from": "2026-08-25T05:22:00.000Z",
                                    "to": "2026-08-25T08:55:00.000Z"
                                }
                            ],
                            "is_hard": false
                        }
                    }
                },
                {
                    "data": {
                        "attribute_id": "9aa20ffb-e130-44a4-8fdf-03ae30ba226b",
                        "type": "description",
                        "value": "Продукты 2"
                    }
                }
            ],
            "status_alias": "created",
            "created_at": "2026-06-15T08:40:34.210945Z",
            "updated_at": "2026-08-24T08:10:34.501092Z"
        }
    ],
    "cursor": {}
}

Каждый атрибут содержит ID, тип и значение.

Получение задачи по ID​

Вы можете получить данные задачи по её идентификатору: ID шаблона, статус, дату и время создания и обновления и список атрибутов.

Чтобы получить данные задачи, отправьте GET-запрос к /v1/tasks/{id}, где {id} — идентификатор задачи.

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

curl --request GET \
   --url 'https://geoflow.2gis.ru/public/api/v1/tasks/402ed0c2-e7a5-404e-bee2-e1695ec65bb2' \
   --header 'Authorization: Bearer <token>'

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

response.json
{
    "id": "402ed0c2-e7a5-404e-bee2-e1695ec65bb2",
    "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
    "attributes": [
        {
            "data": {
                "attribute_id": "8c8c5809-3cdf-41a3-bf19-9c47bf45aad9",
                "type": "text",
                "value": "Задача 12136"
            }
        },
        {
            "data": {
                "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                "type": "name",
                "value": "Инспекция"
            }
        },
        {
            "data": {
                "attribute_id": "9aa20ffb-e130-44a4-8fdf-03ae30ba226b",
                "type": "description",
                "value": "Продукты"
            }
        },
        {
            "data": {
                "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
                "type": "time_windows_settings",
                "value": {
                    "timezone": "Asia/Novosibirsk",
                    "time_windows": [
                        {
                            "from": "2026-08-26T05:22:00.000Z",
                            "to": "2026-08-26T08:06:00.000Z"
                        }
                    ],
                    "is_hard": false
                }
            }
        },
        {
            "data": {
                "attribute_id": "8bc4e8b0-3409-44d5-aad9-069ed1033b5f",
                "type": "phone",
                "value": "+7 (999) 999-99-99"
            }
        }
    ],
    "status_alias": "created",
    "created_at": "2026-06-15T08:40:34.216738Z",
    "updated_at": "2026-08-24T08:10:53.13097Z"
}

Каждый атрибут содержит ID, тип и значение.

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

Чтобы создать задачу, отправьте POST-запрос к /v1/tasks со следующими параметрами:

  • template_id (обязательный параметр) — ID шаблона задачи.

  • attributes (обязательный параметр) — список атрибутов задачи. Каждый объект data должен содержать:

    • attribute_id (обязательный параметр) — ID атрибута, указанный в шаблоне задачи.
    • type (обязательный параметр) — тип атрибута, указанный в шаблоне задачи.
    • value — значение атрибута.

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

curl --request POST \
   --url 'https://geoflow.2gis.ru/public/api/v1/tasks' \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json' \
   --data '{
      "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
      "attributes": [
         {
            "data": {
               "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
               "type": "name",
               "value": "Задача"
            }
         },
         {
            "data": {
               "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
               "type": "time_windows_settings",
               "value": {
                  "timezone": "Europe/Moscow",
                  "time_windows": [
                     {
                        "from": "2026-09-20T09:00:00Z",
                        "to": "2026-09-20T12:00:00Z"
                     }
                  ]
               }
            }
         }
      ]
   }'

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

response.json
{
    "id": "d510b69a-ce4b-4c6f-bd8b-76c1da962a84",
    "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
    "attributes": [
        {
            "data": {
                "attribute_id": "8c8c5809-3cdf-41a3-bf19-9c47bf45aad9",
                "type": "text",
                "value": "T-316"
            }
        },
        {
            "data": {
                "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                "type": "name",
                "value": "Задача"
            }
        },
        {
            "data": {
                "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
                "type": "time_windows_settings",
                "value": {
                    "timezone": "Europe/Moscow",
                    "time_windows": [
                        {
                            "from": "2026-09-20T09:00:00Z",
                            "to": "2026-09-20T12:00:00Z"
                        }
                    ],
                    "is_hard": false
                }
            }
        }
    ],
    "status_alias": "created",
    "created_at": "2026-09-17T11:52:43.826551Z",
    "updated_at": "2026-09-17T11:52:43.826551Z"
}

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

Чтобы обновить данные задачи, отправьте PUT-запрос к /v1/tasks/{id}, где {id} — идентификатор задачи, и передайте в теле запроса новые данные.

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

curl --request PUT \
   --url 'https://geoflow.2gis.ru/public/api/v1/tasks/da6e2e9b-3152-4425-a330-abb1fca5956b' \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json' \
   --data '{
      "id": "da6e2e9b-3152-4425-a330-abb1fca5956b",
      "attributes": [
         {
            "data": {
               "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
               "type": "name",
               "value": "Задача 1"
            }
         }
      ]
   }'

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

response.json
{
    "id": "da6e2e9b-3152-4425-a330-abb1fca5956b",
    "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
    "attributes": [
        {
            "data": {
                "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                "type": "name",
                "value": "Задача 1"
            }
        }
    ],
    "status_alias": "created",
    "created_at": "2026-09-22T13:01:10.648376Z",
    "updated_at": "2026-09-22T13:01:54.321587Z"
}

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

Чтобы изменить статус задачи, отправьте PUT-запрос к /v1/tasks/{id}/status, где {id} — идентификатор задачи, с параметром status_alias — новым статусом задачи.

Возможные статусы задач:

  • created — создана,
  • ready — готова к выполнению,
  • in_progress — выполняется,
  • completed — выполнена,
  • cancelled — отменена.

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

curl --request PUT \
   --url 'https://geoflow.2gis.ru/public/api/v1/tasks/d510b69a-ce4b-4c6f-bd8b-76c1da962a84/status' \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json' \
   --data '{
    "status_alias": "completed"
  }'

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

response.json
{
    "id": "d510b69a-ce4b-4c6f-bd8b-76c1da962a84",
    "template_id": "eaacda1f-251e-40a5-9d2d-b4cba2d462c3",
    "attributes": [
        {
            "data": {
                "attribute_id": "8c8c5809-3cdf-41a3-bf19-9c47bf45aad9",
                "type": "text",
                "value": "T-316"
            }
        },
        {
            "data": {
                "attribute_id": "d227f3d3-0c17-409e-9820-8e4f713be6e6",
                "type": "name",
                "value": "Задача 1"
            }
        },
        {
            "data": {
                "attribute_id": "bc53e352-f052-4a40-bea6-8c5267541430",
                "type": "time_windows_settings",
                "value": {
                    "timezone": "Europe/Moscow",
                    "time_windows": [
                        {
                            "from": "2026-09-20T09:00:00Z",
                            "to": "2026-09-20T12:00:00Z"
                        }
                    ],
                    "is_hard": false
                }
            }
        }
    ],
    "status_alias": "completed",
    "created_at": "2026-09-17T11:52:43.826551Z",
    "updated_at": "2026-09-18T09:47:18.260846Z"
}