Kintone

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

• Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Azioni

Questa sezione elenca le azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione AppsDeployStatus

Questa azione recupera gli stati di deployment delle app

Parametri di input dell'azione AppsDeployStatus

Per un esempio di come configurare l'azione AppsDeployStatus, consulta Esempi di azioni.

Azione CreateApp

Questa azione crea app.

Parametri di input dell'azione CreateApp

Per un esempio di come configurare l'azione CreateApp, consulta Esempi di azioni.

Azione DeleteGuests

Questa azione consente agli utenti di eliminare gli ospiti.

Parametri di input dell'azione DeleteGuests

Per un esempio di come configurare l'azione DeleteGuests, consulta Esempi di azioni.

Azione DeployApps

Questa azione ti consente di eseguire il deployment delle app.

Parametri di input dell'azione DeployApps

Per un esempio di come configurare l'azione DeployApps, consulta Esempi di azioni.

Azione DownloadFile

Questa azione consente agli utenti di scaricare file da un campo allegato in un'app.

Parametri di input dell'azione DownloadFile

Per un esempio di come configurare l'azione DownloadFile, consulta Esempi di azioni.

Azione UpdateAssignees

Questa azione consente agli utenti di aggiornare gli assegnatari.

Parametri di input dell'azione UpdateAssignees

Per un esempio di come configurare l'azione UpdateAssignees, consulta Esempi di azioni.

Azione AddGuests

Questa azione consente agli utenti di aggiungere invitati.

Parametri di input dell'azione AddGuests

Per un esempio di come configurare l'azione AddGuests, consulta Esempi di azioni.

Azione UploadFile

Questa azione ti consente di caricare un file.

Parametri di input dell'azione UploadFile

Azione AddThreadComment

Questa azione consente agli utenti di aggiungere commenti nel thread

Parametri di input dell'azione AddThreadComment

Per un esempio di come configurare l'azione AddThreadComment, consulta Esempi di azioni.

Azione UpdateThread

Questa azione ti consente di aggiornare un thread

Parametri di input dell'azione UpdateThread

Per un esempio di come configurare l'azione UpdateThread, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: recuperare lo stato del deployment dell'app

Questo esempio recupera lo stato del deployment dell'app.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AppsDeployStatus, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "AppIds": "4"
   }

Se l'azione ha esito positivo, il parametro connectorOutputPayload della risposta AppsDeployStatus dell'attività avrà un valore simile al seguente:

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

Esempio: crea un'app

Questo esempio crea una nuova app.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CreateApp, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "NewApp"
   }

Se l'azione ha esito positivo, il parametro CreateApp della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: esegui il deployment di un'app

Questo esempio esegue il deployment di un'app

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DeployApps, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro DeployApps della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: scaricare un file

Questo esempio scarica un file presente in un'app.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DownloadFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Se l'azione ha esito positivo, il parametro DownloadFile della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: aggiornare un assegnatario

Questo esempio aggiorna un assegnatario.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UpdateAssignees, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Se l'azione ha esito positivo, il parametro UpdateAssignees della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: aggiungi un ospite

Questo esempio aggiunge un ospite.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AddGuests, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel 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 l'azione ha esito positivo, il parametro AddGuests della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: elimina un ospite

Questo esempio elimina un ospite.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DeleteGuests, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro DeleteGuests della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: carica un file

Questo esempio mostra come caricare un file.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UploadFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro UploadFile della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: aggiungi un commento al thread

Questo esempio mostra come aggiungere un commento al thread.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AddThreadComment, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro AddThreadComment della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: aggiornare un thread

Questo esempio mostra come aggiornare un thread.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UpdateThread, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro UpdateThread della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempi di operazioni sulle entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenca tutte le app

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Apps dall'elenco Entity.
3. Seleziona l'operazione List, quindi fai clic su Fine.
4. (Facoltativo) Nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Specifica il valore della clausola di filtro sempre tra virgolette singole (').

Puoi eseguire l'operazione Elenco anche sulle entità Record e Commenti.

Esempio: scaricare un'app

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Apps dall'elenco Entity.
3. Seleziona l'operazione Get, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci 4 nel campo Valore predefinito.

   In questo caso, 4 è un ID record univoco nell'entità Apps.

Puoi eseguire l'operazione Get anche sulle seguenti entità: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers

Esempio: elimina un record

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Record dall'elenco Entity.
3. Seleziona l'operazione Delete, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 6 nel campo Valore predefinito.

Puoi eseguire l'operazione di eliminazione anche sulle entità Commenti.

Esempio: creare un record

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Record dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Text": "HelloDemo"
   }

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

   {
   "RecordId": 29.0
   }

Esempio: aggiornare un record

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Record dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Text_area": "updatedemo"
   }

5. Fai clic su entityId, quindi inserisci 22 nel campo Valore predefinito.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

   {
   "RecordId": "22"
   }