Protocol Status

GET

/v1/objects/protocol-status/{task_id}

curl --request GET \
  --url https://api.cloud.agentums.ru/v1/objects/protocol-status/example \
  --header 'Authorization: Bearer <token>'

• Прод

Статус сборки протокола. В отличие от convert-status отдаёт ещё и id готового файла — клиенту нужно на что-то сослаться кнопками «Открыть» и «Скачать».

Authorizations

• bearerAuth

Parameters

Path Parameters

task_id

required

Task Id

string

Responses

200

Successful Response

Media typeapplication/json

ProtocolStatus

Статус сборки протокола (как convert-status) + id готового файла, когда он появился.

stage/step/steps — текущий этап для полосы прогресса. Сборка по двухчасовой встрече идёт минутами, и без этапа интерфейс неотличим от зависшего запроса.

object

detail

Detail

string

""

done

Done

boolean

filename

Filename

string

""

object_id

Any of:

string

string format: uuid

null

null

ok

Ok

boolean

stage

Stage

string

""

state

required

State

string

step

Step

integer

0

steps

Steps

integer

0

Example

{
  "detail": "",
  "done": false,
  "filename": "",
  "ok": false,
  "stage": "",
  "step": 0,
  "steps": 0
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}