Kintone

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação AppsDeployStatus

Esta ação exibe status de implantação do app

Parâmetros de entrada da ação AppsDeployStatus

Para saber como configurar a ação AppsDeployStatus, consulte Exemplos de ação.

Ação de CreateApp

Essa ação cria apps.

Parâmetros de entrada da ação CreateApp

Para saber como configurar a ação CreateApp, consulte Exemplos de ação.

Ação "Excluir visitantes"

Essa ação permite que os usuários excluam convidados.

Parâmetros de entrada da ação DeleteGuests

Para saber como configurar a ação DeleteGuests, consulte Exemplos de ação.

Ação "DeployApps"

Essa ação permite implantar apps.

Parâmetros de entrada da ação DeployApps

Por exemplo, sobre como configurar a ação DeployApps, consulte Exemplos de ação.

Ação DownloadFile

Essa ação permite que os usuários façam o download de arquivos de um campo de anexo em um app.

Parâmetros de entrada da ação DownloadFile

Por exemplo, sobre como configurar a ação DownloadFile, consulte Exemplos de ação.

Ação AtualizarAtribuição

Essa ação permite que os usuários atualizem os atribuídos.

Parâmetros de entrada da ação UpdateAssignees

Por exemplo, sobre como configurar a ação UpdateAssignees, consulte Exemplos de ação.

Ação "Adicionar convidados"

Essa ação permite que os usuários adicionem convidados.

Parâmetros de entrada da ação AddGuests

Por exemplo, sobre como configurar a ação AddGuests, consulte Exemplos de ação.

Ação UploadFile

Essa ação permite fazer upload de um arquivo.

Parâmetros de entrada da ação UploadFile

Ação AddThreadComment

Essa ação permite que os usuários adicionem comentários na conversa

Parâmetros de entrada da ação AddThreadComment

Por exemplo, sobre como configurar a ação AddThreadComment, consulte Exemplos de ação.

Ação UpdateThread

Esta ação permite atualizar uma conversa

Parâmetros de entrada da ação UpdateThread

Por exemplo, sobre como configurar a ação UpdateThread, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: conferir o status da implantação do app

Este exemplo mostra o status da implantação do aplicativo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AppsDeployStatus e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "AppIds": "4"
   }

Se a ação for bem-sucedida, o AppsDeployStatus resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

{
"AppId": "4",   "Status": "SUCCESS",   "success": "true"
}

Exemplo: criar um app

Este exemplo cria um novo app.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateApp e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "Name": "NewApp"
   }

Se a ação for bem-sucedida, o CreateApp resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"AppId": "20",   "Revision": "2",   "Success": "true"
}]

Exemplo: implantar um aplicativo

Este exemplo implanta um app

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeployApps e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "AppId": "19",   "Revision": "2"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeployApps terá um valor semelhante a este:

[{
"Success": "true"
}]

Exemplo: fazer o download de um arquivo

Este exemplo faz o download de um arquivo presente em um app.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadFile e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadFile terá um valor semelhante a este:

[{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

Exemplo: atualizar um responsável

Este exemplo atualiza um usuário atribuído.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UpdateAssignees e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateAssignees terá um valor semelhante a este:

[{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

Exemplo: adicionar um convidado

Neste exemplo, um convidado é adicionado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddGuests e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "GuestsAggregate": "[{\"name\":\"Testuser\",\"code\":\"testuser1@test.com\",
   \"password\":\"test@123\",\"timezone\":\"America/Los_Angeles\",
   \"company\":\"Company Name\",\"division\": \"Sales\",
   \"callto\":\"SkypeCallTo\",\"locale\":\"en\"}]"
   }

Se a ação for bem-sucedida, o AddGuests resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Success": "true"
}]

Exemplo: excluir um convidado

Este exemplo exclui um convidado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteGuests e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Guests": "[\"testuser1@test.com\"]"
   }

Se a ação for bem-sucedida, o DeleteGuests resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Success": "true"
}]

Exemplo: fazer upload de um arquivo

Este exemplo mostra como fazer upload de um arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadFile e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "FileName": "GoogleCloud_Upload_File.txt",
   "AppId": "9",
   "Content": "Hello"
   }

Se a ação for bem-sucedida, o UploadFile resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35",
"Success": "true",
"Id": null,
"Revision": null
}]

Exemplo: adicionar um comentário em uma conversa

Este exemplo mostra como adicionar um comentário de linha de execução.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddThreadComment e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "SpaceId": 1.0,
   "ThreadId": 1.0,
   "Text": "Test Comment"
   }

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddThreadComment terá um valor semelhante a este:

[{
"Id": "3",
"Success": "true"
}]

Exemplo: atualizar uma conversa

Este exemplo mostra como atualizar uma linha de execução.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UpdateThread e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "ThreadId": 1.0,
   "Name": "updated thread"
   }

Se a ação for bem-sucedida, o UpdateThread resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Success": "true"
}]

Exemplos de operações de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os apps

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Apps na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (").

Exemplo: instalar um aplicativo

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Apps na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 4 no campo Valor padrão.

   Aqui, 4 é um ID de registro exclusivo na entidade Apps.

Exemplo: excluir um registro

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Record na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 6 no campo Valor padrão.

Exemplo: criar um registro

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Record na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Text": "HelloDemo"
   }

   A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "RecordId": 29.0
   }

Exemplo: atualizar um registro

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Record na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Text_area": "updatedemo"
   }

5. Clique em entityId e insira 22 no campo Valor padrão.

   A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

   {
   "RecordId": "22"
   }