Listar as filas de gestão de carga de trabalho

Use a API de listar filas de Gerenciamento da carga de trabalho para obter a lista de todas as filas associadas à Control Room especificada.Para executar esta API, é necessário ter permissão do Consumidor em Fila de espera.

Solicitação

POST http://{{ControlRoomURL}}/v3/wlm/queues/list

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

Todas as chamadas API devem conter um token de autenticação de API de autenticação (gera um token da Web JSON) ou um token portador dos serviços OAuth. Não é possível utilizar os dois juntos em uma API.

Corpo da solicitação sem filtros:

{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}

Corpo da solicitação com filtros:

{
"sort": [
  {
   "field": "name",//set sort by criteria
   "direction": "asc"
  }
],
 "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "eq",
        "value": "DRAFT",
        "field": "status"
      },
      {
        "operator": "substring",
        "value": "Test",
        "field": "name"
      }
    ]
  },
"fields": [],
"page": {//return a limited number of results with offset for pagination
  "offset": 0,
  "total": 100,
  "totalFilter": 100,
  "length": 200
}
}

Parâmetros da solicitação


Parâmetro	Tipo	Obrigatório	Descrição
classificar	Matriz	Não	Por padrão, os resultados da pesquisa são classificados em ordem decrescente de acordo com suas IDs. Uma classificação alternativa é especificada usando o parâmetro de consulta da classificação. Digite o campo pelo qual você quer classificar e escolha a direção `asc` (crescente) ou `desc` (decrescente). Para mais informações sobre classificação, consulte Filtragem, paginação e classificação
filtro	Objeto	Não	Filtra o resultado. Para mais informações sobre classificação, consulte Filtragem, paginação e classificação
campos	Matriz	Não	Filtra o resultado com base nos campos.
página	Objeto	Não	O objeto page permite que você obtenha as páginas desejadas. Para mais informações sobre regras de paginação, consulte Filtragem, paginação e classificação

Para o pedido de amostra acima, a resposta retorna todos os detalhes da fila que tem Test em seu nome e NOT_IN_USE como status.

Resposta

{
    "page": {
        "offset": 0,
        "total": 17,
        "totalFilter": 1
    },
    "list": [
        {
            "id": "32",
            "createdBy": "873",
            "createdOn": "2022-03-02T05:51:53.855636Z",
            "updatedBy": "873",
            "updatedOn": "2022-03-02T05:54:18.745722Z",
            "tenantId": "1",
            "version": "1",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "name": "for-docs-test",
            "description": "",
            "reactivationThreshold": "1",
            "status": "NOT_IN_USE",
            "manualProcessingTime": "0",
            "manualProcessingTimeUnit": "SECONDS",
            "workItemProcessingOrders": [],
            "workItemModelId": "28",
            "displayColumnIds": [
                "156",
                "157",
                "158",
                "159",
                "160"
            ],
            "considerReactivationThreshold": false
        }
    ]
}

Parâmetros de resposta


Parâmetro	Tipo	Descrição
offset	Inteiro	O deslocamento da lista inicial, utilizado para paginação.
total	Inteiro	Número total de gravações.
totalFilter	Inteiro	Número de gravações após a aplicação do filtro.
Lista	Matriz	O conjunto de Lista de filas.
Listar objeto de funções
id	Inteiro	A ID exclusiva de uma fila específica.
criadoPor	Inteiro	ID do usuário que criou a função.
criadoEm	String	A criação do carimbo de data/hora da função.
atualizadoPor	Inteiro	ID do usuário que fez a última atualização da função.
atualizadoEm	String	O último carimbo de tempo de atualização da função.
tenantId	Inteiro	ID do locatário.
versão	Inteiro	Versão da instância da função.
tenantUuid	String	ID única do locatário.
nome	String	Nome da fila.
descrição	String	Descrição da fila.
reactivationThreshold	Inteiro	Número mínimo de workItems na fila para reativar a fila.
status	String	O status atual da fila. Os valores podem ser DRAFT, IN_USE ou NOT_IN_USE.
manualProcessingTime	Inteiro	Esforços necessários para processar a fila manualmente.
manualProcessingTimeUnit	String	Unidade do tempo de processamento manual. Os valores podem ser SECONDS, MINUTES, HOURS ou DAYS.
workItemProcessingOrders	Matriz	Um conjunto de ordens de processamento de itens de trabalho.
workItemModelId	Inteiro	ID do modelo do item de trabalho.
displayColumnIds	Matriz	Um conjunto que exibe o a lista de IDs de coluna.
considerReactivationThreshold	Booliano	Marcador para indicar se o Limite de Reativação é ou não necessário.

Nota: Você pode exibir o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma edição licenciada do Automation 360 para acessar a funcionalidade completa das APIs.

A API REST responde a cada solicitação com um código de resposta HTTP. Para códigos de resposta, consulte Códigos de resposta da API.