C DOIS (Pré-visualização)

C TWO é uma Plataforma de Gestão Agentica que orquestra fluxos de trabalho de automação, gere interações humano-robô e processa itens de trabalho através de filas universais. Use este conector para desencadear fluxos de sessões C TWO, gerir o ciclo de vida da sessão, criar e processar itens de fila e permitir interações humanas no ciclo com trabalhadores digitais.

Este conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Estúdio Copiloto	Premium	Todas as regiões Power Automate exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões Azure Government      - Regiões Azure China      - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

Contact
Nome	Apoio ao C TWO
URL	https://ctwo.com/
Email	customersuccess@ctwo.com

Metadados do conector
Editora	C DOIS
Sítio Web	https://ctwo.com/
Política de privacidade	https://ctwo.com/privacy-policy/
Categorias	Business Intelligence; IA

C DOIS

C TWO é uma Plataforma de Gestão Agentica que orquestra fluxos de trabalho de automação, gere interações humano-robô e processa itens de trabalho através de filas universais. Este conector permite que Power Automate, Power Apps, Azure Logic Apps e Copilot Studio disparem e sejam acionados por sessões C TWO, geram o ciclo de vida das sessões, criem e processem itens da Universal Queue e possibilitam interações humanas no ciclo com trabalhadores digitais.

O C DOIS situa-se acima do seu património de automação como uma única camada de orquestração, governação e monitorização: o que quer que crie ou execute o trabalho, o C DOIS adiciona rastreamento SLA, tentativas e auto-recuperação, telemetria de sessões ao vivo e um registo completo de auditoria.

Pré-requisitos

Antes de criar uma ligação, vai precisar de:

1. Um tenant C TWO ativo — seja C TWO Cloud (alojado) ou um servidor C TWO local acessível via HTTPS.
2. Um token de Conta de Serviço ou Token de Acesso Pessoal emitido pelo seu administrador C TWO (ver Obtenção de credenciais).
3. Se o C TWO estiver alojado localmente, o servidor deve ser acedido a partir do Power Platform via HTTPS (firewall que permite ao Microsoft os intervalos de IP de saída do Power Automate — Azure Service AzureConnectors.<region> Tags e PowerPlatformPlex para o seu Power Platform Geo).
4. Um ambiente Power Platform com permissões de Conector Personalizado e um nível de licença que suporta conectores personalizados (Power Automate Premium ou equivalente).

A criar uma ligação

Quando crias uma ligação, forneces três valores, todos do teu próprio ambiente C TWO:

1. C TWO Host — apenas o nome de host do seu servidor C TWO (sem esquema, sem barra final), por exemplo, connect24.ctwo.cloud, ou um host local com porta opcional, como ctwo.contoso.com:8443.
2. C TWO Base URL — o caminho base da sua API C TWO incluindo a sua divisão, começando com uma barra e sem barra final, por /DEFAULT/CTWO.Server/apiexemplo, .
3. API Key — o seu token, introduzido como Bearer <your-token>. Recomenda-se um token de Conta de Serviço ; um Token de Acesso Pessoal também funciona.

Em conjunto, o Host e o URL Base encaminham o conector para o seu próprio servidor C TWO (https://{Host}{Base URL}/…), de modo que cada cliente se liga ao seu próprio ambiente — C TWO Cloud ou on-premises.

Obtenção de credenciais

A autenticação utiliza uma chave API enviada como um token Portador no Authorization cabeçalho.

Token da Conta de Serviço (recomendado para produção)

1. Inicia sessão na tua instância C DOIS.
2. Vai a Apps e Ligações → Microsoft Power Automate → Criar conta de serviço.
3. Copie imediatamente o token gerado — ele é mostrado apenas uma vez.

Personal Access Token (desenvolvimento/testes)

1. Abra o seu perfil de utilizador no C DOIS.
2. Vai ao separador de API Tokens e gera um novo token.
3. Copie-o imediatamente — é mostrado apenas uma vez e é invalidado se a conta de utilizador for desativada.

Trate ambos os tipos de tokens como segredos — armazene-os apenas na credencial de ligação Power Platform, nunca em variáveis de fluxo ou código do lado do cliente.

Operações suportadas

• Gatilhos — Inicie um fluxo quando o C DOIS despacha uma sessão, com ou sem timeout imposto.
• Gestão de sessões — Reportar conclusão/falha, escrever registos de sessão digitados, ajustar o timeout da sessão e verificar se há um pedido de paragem eficiente.
• Fila Universal — Criar, listar, bloquear, desbloquear, retentar e adiar itens da fila; atualizar os dados dos itens e adicionar registos ao nível do item; adicionar/remover etiquetas; recuperar anexos; criar estados personalizados dos itens; Filas de lista.
• Humano no ciclo — Criar, atribuir, desatribuir e preencher formulários estruturados de assistência humana, e recuperá-los/consultá-los.

As operações de ajuda internas preenchem os dropdowns dinâmicos (seletores de tarefas e de utilizador) e não são chamadas diretamente.

Problemas e limitações conhecidos

• É necessário o anfitrião correto e o URL da base. Ambos são introduzidos no momento da ligação e encaminham o conector para o seu servidor C TWO. Valores incorretos ou inalcançáveis resultam em falhas de ligação ou pedidos.
• Formato da chave API. O campo API Key espera a string Bearer <token> literal — omitir o Bearer prefixo resulta em 401 Unauthorized.
• Fornecimento de dados de itens JSON. Os campos de itens (Create Queue Item, Set Queue Item Data) são objetos JSON. Num fluxo, fornece JSON literal com a json('…') expressão para que seja enviado como um objeto em vez de uma string.
• A latência do sonding desencadeia. Os gatilhos fazem polling em vez de push, por isso há um pequeno atraso (limitado pela recorrência do trigger) entre uma sessão ser despachada em C DOIS e o início do fluxo.
• Tipos de campo de formulário. Alguns campos identificadores devolvidos pelas operações do formulário podem ser um inteiro, uma cadeia ou nulo, dependendo do estado do formulário.

Erros e soluções comuns

Erro	Causa provável	Ressarcimento
401 Unauthorized	Chave API sem prefixo Bearer , expirada ou revogada	Reintroduza a credencial como Bearer <token>; gerar um novo token de Conta de Serviço se for revogado
400 Bad request em Criar Item de Fila	Faltar um campo obrigatório (reference, queueItemState, itemKey)	Preenche os três campos obrigatórios
O gatilho nunca dispara	Tarefa errada selecionada, ou a tarefa C DOIS não está exposta ao Power Automate	Confirme que a tarefa aparece no menu suspenso do ID da tarefa e está configurada como um fluxo exposto em C DOIS
Dados de itens armazenados como uma cadeia de escapes	JSON fornecido como texto em vez de objeto	Use a json('…') expressão (fluxos) ou Corpo Bruto (teste de conector) para que seja enviado como objeto

FAQ

Posso usar este conector do Power Apps, Azure Logic Apps e Copilot Studio, não apenas o Power Automate? Yes. Os gatilhos são específicos do Power Automate, mas todas as ações podem ser chamadas a partir de qualquer uma destas plataformas assim que uma ligação é criada.

Este conector gere licenciamentos? No. C DOIS orquestra e governa a execução; os clientes são responsáveis pelo seu próprio licenciamento Microsoft.

Onde posso obter ajuda? Contacte a C TWO Customer Success em customersuccess@ctwo.com.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
C TWO Apresentador	cadeia (de caracteres)	O teu servidor C DOIS só nomes de host — sem esquema, sem barra final. Por exemplo, connect24.ctwo.cloud, ou um host local com porta opcional como ctwo.contoso.com:8443.	Verdade
C TWO Base URL	cadeia (de caracteres)	O caminho base da tua API do C TWO incluindo a tua divisão. Começa com um corte, sem um corte posterior. Por exemplo, /DEFAULT/CTWO. Servidor/API.	Verdade
Chave de API	securestring	O seu token C TWO API, inserido como: Bearer <your-token>. Recomenda-se um token de Conta de Serviço; um Token de Acesso Pessoal também funciona.	Verdade

Ações

Adicionar etiquetas ao item da fila	Adiciona uma ou mais etiquetas a um item da fila para categorização e filtragem. As etiquetas ajudam a organizar e pesquisar itens de trabalho através das filas.
Adicionar Registo ao Item da Fila	Adiciona uma mensagem de registo a um item da fila para registo de auditoria e rastreabilidade. Use esta ação para registar passos de processamento, avisos ou erros sobre um item de trabalho específico.
Adicionar Registo à Sessão	Escreve uma entrada de registo numa sessão C TWO. Use esta ação para acompanhar o progresso, registar decisões ou registar informações de diagnóstico durante a execução do fluxo. Os registos são visíveis na plataforma C TWO para auditoria e resolução de problemas.
Criar Estado de Item de Fila	Cria um novo estado personalizado dentro de uma fila específica. Os estados personalizados permitem-lhe definir etapas de fluxo de trabalho para além dos estados padrão (Pendente, Concluído, Referido), adaptando a fila ao seu processo de negócio.
Criar Forma	Cria um novo formulário de interação com robôs que permite a um trabalhador digital pedir assistência humana. O formulário é apresentado aos utilizadores atribuídos na plataforma C TWO, permitindo cenários de intervenção humana em que seja necessária especialização humana para lidar com exceções ou decisões complexas.
Criar Item de Fila	Cria um novo item de trabalho numa fila universal especificada. Use esta ação para adicionar itens para processamento por trabalhadores digitais, incluindo cargas úteis de dados, etiquetas e anexos opcionais de ficheiros.
Definir o estado de execução do fluxo para concluído	Marca uma sessão C DOIS como concluída, sinalizando que o fluxo terminou o seu trabalho com sucesso. Coloque esta ação no final do seu fluxo para reportar ao C DOIS que a automação foi concluída sem erros.
Definir o estado de execução do fluxo para Falhado	Marca uma sessão C TWO como falhada, sinalizando que ocorreu um erro durante a execução do fluxo. Use esta ação nos escopos de gestão de erros para reportar falhas ao C DOIS com detalhes sobre o que correu mal.
Definir o estado do item da fila	Altera o estado de um item da fila (por exemplo, de Pendente para Concluído, ou para um estado personalizado). Use esta ação para avançar itens no seu pipeline de fluxo de trabalho.
Definir o Tempo de Pausa da Sessão	Atualiza o valor de timeout para uma sessão C TWO ativa. Use esta ação para estender ou reduzir o tempo de execução permitido para uma sessão em execução quando o timeout original precisa de ajuste.
Definir os Dados do Item da Fila	Atualiza o conteúdo de dados de um item da fila. Use esta ação para modificar a carga útil de um item de trabalho durante o processamento, por exemplo, para armazenar resultados intermédios.
Deve a Sessão Terminar	Verifica se C DOIS pediu uma paragem suave (suave) para a sessão em questão. Use esta ação dentro dos ciclos para verificar periodicamente se a sessão deve terminar mais cedo, permitindo que o fluxo limpe recursos antes de parar.
Formulário Completo	Marca um formulário de interação do robô como preenchido, sinalizando que o utilizador humano forneceu a entrada solicitada e que o trabalhador digital pode retomar o processamento.
Formulário de Atribuição	Atribui um formulário de interação com robôs a um utilizador específico, tornando-o responsável por rever e preencher o pedido do humano no ciclo.
Formulário de Desatribuição	Remove a atribuição de utilizador atual de um formulário de interação com robôs, tornando-a disponível para outros utilizadores reclamarem.
Item da Fila de Adiamento	Adia um item da fila para que não seja processado até à data/hora especificada. Use esta ação quando um item não puder ser processado agora, mas deve ser tentado novamente mais tarde.
Item da Fila de Bloqueio	Bloqueia um item da fila para impedir que outros trabalhadores o processem em simultâneo. Use esta ação antes de processar um item de trabalho para garantir acesso exclusivo.
Item da Fila de Desbloqueio	Desbloqueia um item da fila previamente bloqueado e devolve-o ao seu estado disponível. Use esta ação quando o processamento for interrompido e o item deve ser libertado para outros trabalhadores.
Item da Fila de Retentar	Tente novamente um item específico da fila, voltando a colocar os dados no valor original e criando uma nova Tentativa.
Obter Formulário por Identificação	Recupera uma forma específica de interação robótica pelo seu identificador único. Use esta ação para obter os detalhes, campos e o estado atual de um formulário humano-in-the-loop criado por um trabalhador digital.
Obter formulários	Recupera uma lista de formas de interação com robôs com filtragem opcional. Use esta ação para interrogar pedidos pendentes de intervenção humana, verificar o seu estado ou encontrar formulários atribuídos a utilizadores específicos.
Obter Itens da Fila	Recupera itens da fila com base em critérios de filtro especificados, como estado, etiquetas, datas e nomes das filas. Use esta ação para procurar e monitorizar itens de trabalho nas suas filas universais.
Obtém Anexo de Itens de Fila	Recupera um anexo específico de ficheiro de um item da fila como dados codificados em base64. Use esta ação para descarregar ficheiros que estavam anexados a itens de trabalho durante a criação ou processamento.
Receba Filas	Recupera filas universais com base nos critérios do filtro. Use esta ação para listar as filas disponíveis, verificar a sua configuração ou consultar detalhes da fila. Esta operação também alimenta os dropdowns dinâmicos noutras ações.
Remover Etiquetas do Item da Fila	Remove uma ou mais etiquetas de um item da fila. Use esta ação para atualizar a categorização dos itens de trabalho durante o processamento.

Adicionar etiquetas ao item da fila

ID da Operação:

AddItemTag

Adiciona uma ou mais etiquetas a um item da fila para categorização e filtragem. As etiquetas ajudam a organizar e pesquisar itens de trabalho através das filas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila a adicionar etiquetas.
Tags	tags		string	Lista de etiquetas separadas por vírgulas para adicionar.

Adicionar Registo ao Item da Fila

ID da Operação:

AddItemLog

Adiciona uma mensagem de registo a um item da fila para registo de auditoria e rastreabilidade. Use esta ação para registar passos de processamento, avisos ou erros sobre um item de trabalho específico.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila para iniciar sessão.
Nível do registo	level		string	O nível de gravidade da entrada do registo.
Mensagem	message		string	O conteúdo da mensagem do log.

Adicionar Registo à Sessão

ID da Operação:

AddLogToSession

Escreve uma entrada de registo numa sessão C TWO. Use esta ação para acompanhar o progresso, registar decisões ou registar informações de diagnóstico durante a execução do fluxo. Os registos são visíveis na plataforma C TWO para auditoria e resolução de problemas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de sessão	sessionId	True	string	O ID de sessão C TWO onde a entrada do registo será registada. Por defeito, o ID da sessão da saída do trigger.
nível	level	True	string	O nível de gravidade da entrada do registo.
mensagem	message	True	string	O conteúdo da mensagem do registo para gravar.

Criar Estado de Item de Fila

ID da Operação:

CreateItemState

Cria um novo estado personalizado dentro de uma fila específica. Os estados personalizados permitem-lhe definir etapas de fluxo de trabalho para além dos estados padrão (Pendente, Concluído, Referido), adaptando a fila ao seu processo de negócio.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome	name		string	O nome do novo estado.
Cálculo do Tempo de Resposta	responseTimeCalculationBasis	True	string	Determina como os SLAs de tempo de resposta são calculados para itens que entram neste estado.
Tipo de Estado	state	True	string	O tipo de estado (Pendente, Concluído ou Referido).
ID da Fila	queueId	True	integer	O ID da fila onde este estado será criado.
Description	description		string	Uma descrição do que este estado representa no seu fluxo de trabalho.
Tempo Poupado por Item	timeSavedPerItem		integer	Tempo poupado por item neste estado (segundos), usado para reportar o retorno do investimento.
Valor Gerado por Item	valueGeneratedPerItem		integer	Valor gerado por item neste estado, usado para relatórios de ROI.
Incluir nos Relatórios	includeInReports		boolean	Se deve incluir este estado nas análises e relatórios.

Criar Forma

ID da Operação:

CreateForm

Cria um novo formulário de interação com robôs que permite a um trabalhador digital pedir assistência humana. O formulário é apresentado aos utilizadores atribuídos na plataforma C TWO, permitindo cenários de intervenção humana em que seja necessária especialização humana para lidar com exceções ou decisões complexas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
campos	fields		string	String com formato JSON que define os campos de formulário que o utilizador humano precisa de preencher.
título	title		string	O título é mostrado ao utilizador humano quando este abre o formulário.
Prazo	deadline		date-time	O prazo pelo qual o humano deve responder ao formulário (formato ISO 8601).
Introdução	intro		string	Texto introdutório mostrado ao utilizador humano explicando que ação é necessária.
itemId	itemId		integer	O ID do item da fila associado a este formulário, ligando a interação humana a um item de trabalho específico.
workflowTaskId	workflowTaskId		integer	A tarefa C DOIS que criou este formulário.

Devoluções

Name	Caminho	Tipo	Descrição
id	id	integer	id

Criar Item de Fila

ID da Operação:

CreateItem

Cria um novo item de trabalho numa fila universal especificada. Use esta ação para adicionar itens para processamento por trabalhadores digitais, incluindo cargas úteis de dados, etiquetas e anexos opcionais de ficheiros.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Chave do Item	itemKey	True	string	Uma chave de negócio única para identificar este item da fila (por exemplo, número de fatura, ID do caso).
Estado do Item da Fila	queueItemState	True	string	O estado inicial do item da fila (por exemplo, Pendente).
Referência da Fila	reference	True	string	A referência da fila onde o item será criado.
Adiado até	deferredUntil		date-time	Adiar o processamento até esta data/hora (formato ISO 8601).
Dados do Item	itemData		object	O payload de dados para o item da fila em formato JSON.
Tags	tags		string	Etiquetas para o item da fila (separadas por vírgulas).
nomeDoFicheiro	fileName		string	O nome do ficheiro anexo.
fileData	fileData		string	O base64 codificava dados do ficheiro.
ID de sessão	sessionId		string	O ID da sessão associado a este item.
Dispositivo	device		string	O dispositivo que criou este objeto.
User	user		string	O utilizador que criou este item.
Fornecedor de Automação	automationProvider		string	O fornecedor de automação para este artigo.

Devoluções

Name	Caminho	Tipo	Descrição
id	id	integer	id
itemKey	itemKey	string	itemKey
tentativas	attempts	integer	tentativas
queueId	queueId	integer	queueId
id	state.id	integer	id
Nome	state.name	string	Nome
state	state.state	string	state
tags	tags	array of string	tags
criado	created	string	criado
createdByVendorSessionId	createdByVendorSessionId	integer	createdByVendorSessionId
concluído	concluded	string	concluído
adiado	deferred	string	adiado
testar	test	boolean	testar
bloqueado	locked	boolean	bloqueado

Definir o estado de execução do fluxo para concluído

ID da Operação:

SetSessionCompleted

Marca uma sessão C DOIS como concluída, sinalizando que o fluxo terminou o seu trabalho com sucesso. Coloque esta ação no final do seu fluxo para reportar ao C DOIS que a automação foi concluída sem erros.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de sessão	sessionId	True	string	O ID da sessão C TWO para marcar como concluída com sucesso. Por defeito, o ID da sessão da saída do trigger.

Devoluções

response

object

Definir o estado de execução do fluxo para Falhado

ID da Operação:

SetSessionFailed

Marca uma sessão C TWO como falhada, sinalizando que ocorreu um erro durante a execução do fluxo. Use esta ação nos escopos de gestão de erros para reportar falhas ao C DOIS com detalhes sobre o que correu mal.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de sessão	sessionId	True	string	O ID de sessão C TWO para marcar como falhado. Por defeito, o ID da sessão da saída do trigger.
details	details	True	string	Uma descrição do erro ou exceção que causou a falha da sessão.

Definir o estado do item da fila

ID da Operação:

SetItemState

Altera o estado de um item da fila (por exemplo, de Pendente para Concluído, ou para um estado personalizado). Use esta ação para avançar itens no seu pipeline de fluxo de trabalho.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila a atualizar.
Estado	state		string	O novo estado para o item da fila.

Definir o Tempo de Pausa da Sessão

ID da Operação:

SetTimeout

Atualiza o valor de timeout para uma sessão C TWO ativa. Use esta ação para estender ou reduzir o tempo de execução permitido para uma sessão em execução quando o timeout original precisa de ajuste.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de sessão	sessionId	True	string	O ID de sessão C DOIS para atualizar o timeout. Por defeito, o ID da sessão da saída do trigger.
Timeout	timeout	True	integer	O novo valor de timeout em segundos para aplicar à sessão.

Devoluções

response

string

Definir os Dados do Item da Fila

ID da Operação:

SetItemData

Atualiza o conteúdo de dados de um item da fila. Use esta ação para modificar a carga útil de um item de trabalho durante o processamento, por exemplo, para armazenar resultados intermédios.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila a atualizar.
Data	data		object	O novo payload de dados para o item da fila, como objeto JSON.
Criado	created		date-time	O carimbo temporal da criação destes dados.

Deve a Sessão Terminar

ID da Operação:

IsStopRequested

Verifica se C DOIS pediu uma paragem suave (suave) para a sessão em questão. Use esta ação dentro dos ciclos para verificar periodicamente se a sessão deve terminar mais cedo, permitindo que o fluxo limpe recursos antes de parar.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID de sessão	sessionId	True	string	O ID de sessão C TWO para verificar se há um pedido de paragem. Por defeito, o ID da sessão da saída do trigger.

Devoluções

Name	Caminho	Tipo	Descrição
éPáraSolicitado	isStopRequested	boolean	éPáraSolicitado

Formulário Completo

ID da Operação:

CompleteForm

Marca um formulário de interação do robô como preenchido, sinalizando que o utilizador humano forneceu a entrada solicitada e que o trabalhador digital pode retomar o processamento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do formulário	formId	True	string	Forma humana no loop id para marcar como concluído.
concluídoAt	completedAt		date-time	O carimbo temporal em que o formulário foi preenchido (formato ISO 8601).

Formulário de Atribuição

ID da Operação:

AssignForm

Atribui um formulário de interação com robôs a um utilizador específico, tornando-o responsável por rever e preencher o pedido do humano no ciclo.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do formulário	formId	True	string	Humano no loop form id a atribuir.
userId	userId		integer	O ID do utilizador a quem atribuir o formulário.

Formulário de Desatribuição

ID da Operação:

UnassignForm

Remove a atribuição de utilizador atual de um formulário de interação com robôs, tornando-a disponível para outros utilizadores reclamarem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do formulário	formId	True	string	Humano no loop form id para desatribuir.

Item da Fila de Adiamento

ID da Operação:

DeferItem

Adia um item da fila para que não seja processado até à data/hora especificada. Use esta ação quando um item não puder ser processado agora, mas deve ser tentado novamente mais tarde.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila a adiar.
Adiado até	deferredUntil		date-time	A data/hora a adiar até (formato ISO 8601).

Devoluções

response

string

Item da Fila de Bloqueio

ID da Operação:

LockItem

Bloqueia um item da fila para impedir que outros trabalhadores o processem em simultâneo. Use esta ação antes de processar um item de trabalho para garantir acesso exclusivo.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId		string	O ID do item da fila a bloquear. Se for omitido, o próximo item disponível que corresponda ao filtro será bloqueado.
Nome da fila	reference		string	A referência à fila para bloquear um item de.
ID do Estado	stateId		string	O ID do estado para filtrar os artigos.
Nome do Estado	stateName		string	O nome do estado para filtrar os itens por.
ID de sessão	sessionId		string	O ID da sessão deste bloqueio.

Devoluções

Name	Caminho	Tipo	Descrição
id	id	integer	O identificador único do item bloqueado.
itemKey	itemKey	string	A chave única do objeto trancado.
tentativas	attempts	integer	O número de tentativas de processamento.
queueId	queueId	integer	O identificador da fila do pai.
id	state.id	integer	O identificador do estado.
Nome	state.name	string	O nome do estado.
state	state.state	string	O valor do estado.
tags	tags	array of string	As etiquetas associadas ao item da fila.
criado	created	string	O carimbo temporal da criação.
createdByVendorSessionId	createdByVendorSessionId	integer	O ID da sessão que criou este item.
concluído	concluded	string	O carimbo temporal da conclusão.
adiado	deferred	string	O carimbo temporal adiado.
testar	test	boolean	Se isto é um item de teste.
bloqueado	locked	boolean	Se o item está bloqueado.

Item da Fila de Desbloqueio

ID da Operação:

UnlockItem

Desbloqueia um item da fila previamente bloqueado e devolve-o ao seu estado disponível. Use esta ação quando o processamento for interrompido e o item deve ser libertado para outros trabalhadores.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila a desbloquear.

Item da Fila de Retentar

ID da Operação:

RetryItem

Tente novamente um item específico da fila, voltando a colocar os dados no valor original e criando uma nova Tentativa.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	integer	ID específico do item da fila para tentar novamente.
ID do Estado	stateId		integer	ID de estado específico do item pendente da fila a definir; tem prioridade sobre o parâmetro de estado.
Estado	state		string	Nome específico do estado do item pendente da fila a definir.
ID de Tarefa do Fluxo de Trabalho	workflowTaskId		integer	Identificador WorkflowTask.
ID de Aplicação	appId		integer	Identificador da aplicação.

Obter Formulário por Identificação

ID da Operação:

GetFormById

Recupera uma forma específica de interação robótica pelo seu identificador único. Use esta ação para obter os detalhes, campos e o estado atual de um formulário humano-in-the-loop criado por um trabalhador digital.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do formulário	formId	True	string	Formulário humano no loop para obter detalhes.

Devoluções

Name	Caminho	Tipo	Descrição
id	id	integer	id
divisionId	divisionId		divisionId
ID de sessão	sessionId		ID de sessão
queueItemId	queueItemId		queueItemId
claimedByUserId	claimedByUserId		claimedByUserId
reivindicadoEm	claimedOn	string	reivindicadoEm
createdByWorkflowTaskId	createdByWorkflowTaskId		createdByWorkflowTaskId
criadoByUserId	createdByUserId		criadoByUserId
criadoEm	createdOn	string	criadoEm
Prazo	deadline	string	Prazo
concluída	completed	string	concluída
título	title	string	título
Introdução	intro	string	Introdução
campos	fields	string	campos

Obter formulários

ID da Operação:

GetForms

Recupera uma lista de formas de interação com robôs com filtragem opcional. Use esta ação para interrogar pedidos pendentes de intervenção humana, verificar o seu estado ou encontrar formulários atribuídos a utilizadores específicos.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Pular	skip		integer	Número de registos a saltar para paginação.
Pegue	take		integer	Número de registos a devolver.
Prazo Antes	deadlineBefore		date-time	Filtrar formulários com prazo antes desta data/hora (ISO 8601).
Prazo Após	deadlineAfter		date-time	Filtrar formulários com prazo após esta data/hora (ISO 8601).
Incluir Concluídos	includeCompleted		boolean	Se deve incluir formulários preenchidos nos resultados.
Reivindicado por ID de Utilizador	claimedByUserId		integer	Formulários de filtro reclamados por um ID de utilizador específico.
Criado por ID de Tarefa do Fluxo de Trabalho	createdByWorkflowTaskId		integer	Filtrar formulários criados por um ID de tarefa específico do fluxo de trabalho.

Devoluções

Name	Caminho	Tipo	Descrição
		array of object
id	id	integer	id
divisionId	divisionId		divisionId
ID de sessão	sessionId		ID de sessão
queueItemId	queueItemId		queueItemId
claimedByUserId	claimedByUserId		claimedByUserId
reivindicadoEm	claimedOn	string	reivindicadoEm
createdByWorkflowTaskId	createdByWorkflowTaskId		createdByWorkflowTaskId
criadoByUserId	createdByUserId		criadoByUserId
criadoEm	createdOn	string	criadoEm
Prazo	deadline	string	Prazo
concluída	completed	string	concluída
não diferido	undeferred	boolean	não diferido

Obter Itens da Fila

ID da Operação:

GetItems

Recupera itens da fila com base em critérios de filtro especificados, como estado, etiquetas, datas e nomes das filas. Use esta ação para procurar e monitorizar itens de trabalho nas suas filas universais.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Chave do Item	itemKey		string	Filtrar por chave de item.
Attempts	attempts		integer	Filtra pelo número de tentativas.
Adiado antes	deferredBefore		date-time	Filtrar itens adiados antes desta data.
Adiado após	deferredAfter		date-time	Filtrar itens adiados após esta data.
Criado antes	createdBefore		date-time	Filtrar os itens criados antes desta data.
Criado após	createdAfter		date-time	Filtrar os itens criados após esta data.
Concluído antes	concludedBefore		date-time	Filtrar itens concluídos antes desta data.
Concluído depois	concludedAfter		date-time	Filtrar itens concluídos após esta data.
O Estado Entrou antes	stateEnteredTimeBefore		date-time	Filtrar os itens que entraram no estado antes desse momento.
O Estado Entrou depois	stateEnteredTimeAfter		date-time	Filtrar os itens que entraram no estado depois desse período.
States	states		string	Filtrar pelo estado do item da fila.
IDs de Estado dos Itens da Fila	queueItemStateIds		integer	Filtrar por IDs de estado dos itens da fila.
Nomes dos Estados dos Itens da Fila	queueItemStateNames		string	Filtrar por nomes de estado dos itens da fila.
Tags	tags		string	Filtrar por etiquetas (separadas por vírgulas).
IDs de fila	queueIds		integer	Filtrar por IDs de fila.
Nomes das Filas	queueNames	True	string	Filtrar por nomes de fila (obrigatório).
References	references		string	Filtrar por referências de fila.
Incluir Dados de Itens	includeItemData		boolean	Se deve incluir dados de itens em resposta.
Pular	skip		integer	Número de registos a saltar para paginação.
Pegue	take		integer	Número de registos a devolver.

Devoluções

Name	Caminho	Tipo	Descrição
		array of object
id	id	integer	O identificador único do item da fila.
itemKey	itemKey	string	A chave única do item da fila.
tentativas	attempts	integer	O número de tentativas de processamento.
queueId	queueId	integer	O identificador da fila do pai.
id	state.id	integer	O identificador do estado.
Nome	state.name	string	O nome do estado.
state	state.state	string	O valor do estado.
tags	tags	array of string	As etiquetas associadas ao item da fila.
criado	created	string	O carimbo temporal da criação.
createdByVendorSessionId	createdByVendorSessionId	integer	O ID da sessão que criou este item.
concluído	concluded	string	O carimbo temporal da conclusão.
adiado	deferred	string	O carimbo temporal adiado.
testar	test	boolean	Se isto é um item de teste.
bloqueado	locked	boolean	Se o item está bloqueado.

Obtém Anexo de Itens de Fila

ID da Operação:

GetItemAttachment

Recupera um anexo específico de ficheiro de um item da fila como dados codificados em base64. Use esta ação para descarregar ficheiros que estavam anexados a itens de trabalho durante a criação ou processamento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila que contém o anexo.
ID do anexo	attachmentId	True	string	O ID do anexo a recuperar.
Nome do ficheiro	filename		string	O nome do arquivo do anexo.

Devoluções

response

string

Receba Filas

ID da Operação:

GetQueues

Recupera filas universais com base nos critérios do filtro. Use esta ação para listar as filas disponíveis, verificar a sua configuração ou consultar detalhes da fila. Esta operação também alimenta os dropdowns dinâmicos noutras ações.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID da Fila	id		string	Filtrar por ID da fila.
Referência da Fila	reference		string	Filtrar por referência da fila.
Nome da fila	name		string	Filtra por nome da fila.
Nome do Estado	stateName		string	Filtrar por nome do estado.
Deleted	deleted		boolean	Filtrar por estado eliminado.
Pular	skip		integer	Número de registos a saltar para paginação.
Pegue	take		integer	Número de registos a devolver.

Devoluções

Name	Caminho	Tipo	Descrição
		array of object
id	id	integer	O identificador único da fila.
Suprimido	deleted	boolean	Se a fila é eliminada.
Nome	name	string	O nome da fila.
description	description	string	A descrição da fila.
visível	visible	boolean	Se a fila é visível.
includeInReports	includeInReports	boolean	Se deve incluir nos relatórios.
criado	created	string	O carimbo temporal da criação.
atualizado	updated	string	O carimbo temporal da última atualização.
deletedTime	deletedTime	string	O carimbo temporal da eliminação.
divisionId	divisionId	integer	O identificador de divisão.
tipo	type	integer	O tipo de fila.
referenciar	reference	string	A referência da fila.
Estados	states	array of object	Os estados disponíveis nesta fila.
id	states.id	integer	O identificador do estado.
Nome	states.name	string	O nome do estado.
description	states.description	string	A descrição do estado.
tagfilter	states.tagfilter	string	O filtro de etiquetas para este estado.
state	states.state	integer	Do tipo estatal.
TimeSavedPerItem	states.timeSavedPerItem	integer	Tempo poupado por item.
includeInReports	states.includeInReports	boolean	Se deve incluir nos relatórios.
RespostaTempoCálculoBase	states.responseTimeCalculationBasis	integer	Base no cálculo do tempo de resposta.

Remover Etiquetas do Item da Fila

ID da Operação:

RemoveItemTag

Remove uma ou mais etiquetas de um item da fila. Use esta ação para atualizar a categorização dos itens de trabalho durante o processamento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Item da Fila	queueItemId	True	string	O ID do item da fila para remover etiquetas.
Tags	tags		string	Lista de etiquetas separadas por vírgulas a remover.

Acionadores

Iniciar o Fluxo a partir do Pedido de Sessão com Tempo Limite	Faz sondagens para as novas C DUAS sessões e desencadeia o fluxo com uma restrição de timeout. Use este gatilho quando a automação tiver de ser concluída dentro de uma janela de tempo específica. Se a sessão exceder o timeout, o C TWO tratará da situação de acordo com a sua política de timeout.
Iniciar o Fluxo a partir do Pedido de Sessão sem Tempo Limite	Faz sondagens para novas sessões C TWO e dispara o fluxo quando uma sessão é criada para a tarefa selecionada. Use este gatilho quando a automação não exige uma restrição de timeout. O fluxo recebe detalhes da sessão, incluindo valores de entrada passados de C DOIS.

Iniciar o Fluxo a partir do Pedido de Sessão com Tempo Limite

ID da Operação:

StartFlowWithTimeout

Faz sondagens para as novas C DUAS sessões e desencadeia o fluxo com uma restrição de timeout. Use este gatilho quando a automação tiver de ser concluída dentro de uma janela de tempo específica. Se a sessão exceder o timeout, o C TWO tratará da situação de acordo com a sua política de timeout.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID da tarefa	taskId	True	integer	Selecione a tarefa C DOIS que irá desencadear este fluxo. Quando uma sessão é criada para esta tarefa, o fluxo começa com o timeout especificado aplicado.
Segundos de tempo	timeout	True	integer	O tempo máximo em segundos que a sessão pode decorrer antes de C DOIS marca que está esgotada.

Devoluções

Name	Caminho	Tipo	Descrição
sessions	sessions	array of object	Conjunto de sessões desencadeadas por C DOIS com timeout
ID de sessão	sessions.sessionId	integer	ID de sessão
workflowTaskId	sessions.workflowTaskId	integer	workflowTaskId
nome do fluxo de trabalho	sessions.workflowName	string	nome do fluxo de trabalho
Nome da tarefa	sessions.taskName	string	Nome da tarefa
criado	sessions.created	string	criado
ProcessoInputValues	sessions.processInputValues	object	ProcessoInputValues

Iniciar o Fluxo a partir do Pedido de Sessão sem Tempo Limite

ID da Operação:

StartFlowWithoutTimeout

Faz sondagens para novas sessões C TWO e dispara o fluxo quando uma sessão é criada para a tarefa selecionada. Use este gatilho quando a automação não exige uma restrição de timeout. O fluxo recebe detalhes da sessão, incluindo valores de entrada passados de C DOIS.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID da tarefa	taskId	True	integer	Selecione a tarefa C DOIS que irá desencadear este fluxo. Quando uma nova sessão é criada para esta tarefa em C DOIS, o fluxo começa automaticamente sem impor um timeout.

Devoluções

Name	Caminho	Tipo	Descrição
sessions	sessions	array of object	Conjunto de sessões desencadeadas por C DOIS sem tempo de espera
ID de sessão	sessions.sessionId	integer	ID de sessão
workflowTaskId	sessions.workflowTaskId	integer	workflowTaskId
nome do fluxo de trabalho	sessions.workflowName	string	nome do fluxo de trabalho
Nome da tarefa	sessions.taskName	string	Nome da tarefa
criado	sessions.created	string	criado
ProcessoInputValues	sessions.processInputValues	object	ProcessoInputValues

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

objecto

Este é o tipo 'objeto'.