`GET /docflows`

Метод позволяет получить список документооборотов, которые соответствуют критериям поиска.

В результатах поиска список документооборотов будет отсортирован по дате создания в порядке убывания. Первым в списке будет последний созданный документооборот.

Параметры

Название	Тип	Формат	Обязательность	Описание
externalId	string	`^\w{1,256}$`	`false`	Клиентский идентификатор документооборота
parentId	string	Guid	`false`	Идентификатор основного документооборота
state	string	DocflowState	`false`	Статус документооборота. В одном запросе можно указывать несколько статусов, по которым необходимо осуществить поиск
type	string	DocflowType	`false`	Вид документооборота
from	date-time	ISO 8601: `YYYY-MM-DDTHH:MM.S&`	`false`	Дата в формате ISO 8601. Если параметр указывается, то в результатах поиска будут получены документообороты, созданные позднее указанной даты
to	date-time	ISO 8601: `YYYY-MM-DDTHH:MM.S&`	`false`	Дата в формате ISO 8601. Если параметр указывается, то в результатах поиска будут получены документообороты, созданные ранее указанной даты
afterDocflowId	string	Guid	`false`	Идентификатор документооборота, после которого необходимо получить список. Если параметр указан, то в результатах поиска будут располагаться документообороты, которые были созданы ранее указанного. Указанный документооборот не будет содержаться в ответе
count	integer		`false`	Количество документооборотов, содержащееся в ответе. Максимальное значение 50

Если ни один из параметров не будет передан, то в ответе будет содержаться 30 последних созданных документооборотов.

Заголовки

Название	Описание
Authorization	Заголовок авторизации

Пример

GET /realty/rosreestr/v2/docflows?state=Sent&state=Processing&type=ObjectExtract
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30

Ответы

200

Тело ответа

Поиск прошел успешно. В теле ответа содержится:

Название	Тип	Формат	Обязательность	Описание
item	array	Docflow	true	Список документооборотов, которые удовлетворяют критериям поиска
lastDocflowId	string	Guid	true	Идентификатор последнего документооборота в списке

Если по результатам поиска не было найдено ни одного документооборота, удовлетворяющего заданным параметрам, то:

объект item будет содержать пустой массив;

поле lastDocflowId будет отсутствовать.

Заголовки ответа

Название	Описание
Content-Type	Тип содержимого

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

  HTTP 200
  Content-Type: Application/json

{
  "item":
  [
    {
      "docflowId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
      "docflowState": "sent",
      "docflowType": "ObjectExtract",
      "creationDate": "2011-01-01T15:03:01.012345Z",
      "objectExtract":
      {
        "objectExtractType": "Base",
        "objects":
        [
          {
            "cadastralNumber": "54:12:345814:45"
          }
        ]
      }
    }
  ],
  "lastDocflowId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88"
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки	Описание
WrongFieldValue	Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в `message`

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

  HTTP 400
  Content-Type Application/json

  {
    "code": "validation",
    "message": "Failed to validate input request",
    "target": "api",
    "errors":
    [
      {
        "code": "WrongFieldValue",
        "message": "afterEventId should be guid",
        "target": "EntityApi"
      }
    ]
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации