Pular para o conteúdo principal
GET
/
api
/
publicapi
/
v1
/
transactions
/
active
Retorna as transações ativas com os Parameters especificados
curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "<string>",
      "reviewerEmail": "<string>",
      "reviewerName": "<string>",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createTimeUtc": "2023-11-07T05:31:56Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "skillId": "<string>",
      "skillVersion": 123,
      "documentCount": 123
    }
  ],
  "totalItemCount": 123
}

Autorizações

​
Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

​
StageType
string

Etapa atual da transação

​
StageName
string

Nome da etapa atual da transação Nome atual da etapa da transação

​
SkillId
string

ID da skill disponível (de acordo com as permissões). Se este campo estiver vazio, então todas as skills disponíveis serão utilizadas como filtro. ID da skill disponível (de acordo com as permissões). Se este campo estiver vazio, todas as skills disponíveis serão utilizadas como filtro.

​
SkillVersion
string

Apenas as skills disponíveis podem ser filtradas por versão Somente as skills disponíveis podem ser filtradas por versão

​
StartDate
string<date-time>

Data e hora mínima de criação das transações. O horário deve ser definido no formato UTC. Hora mínima de criação das transações. O horário deve ser definido no formato UTC.

​
EndDate
string

Momento máximo de criação das transações. O horário deve ser definido no formato UTC. Se não for especificado, será utilizado o horário UTC atual. Tempo máximo para a criação das transações. O horário deve ser definido no formato UTC. Se não for informado, será usado o horário UTC atual.

​
TransactionParameters
object[]

Lista de Parameters de transação. As transações recuperadas devem conter todos os Parameters Lista de parâmetros de transação. As transações obtidas devem conter todos os parâmetros.

​
DocumentParameters
object[]

Lista de Parameters do documento. As transações recuperadas devem conter todos os Parameters Lista de Parameters do documento. As transações recuperadas devem conter todos os Parameters.

​
Offset
integer<int32>

Offset de paginação (padrão: 0)

​
Limit
integer<int32>

Limite da paginação Limite de paginação

Resposta

Transações com parâmetros de registro das transações e respectivos documentos, e com informações de estágio

É usado apenas para o Swagger

​
items
object[] | null
​
totalItemCount
integer<int32>