Kintone

Entitas, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

• Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.

  Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Daftar
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Tindakan

Bagian ini mencantumkan tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Tindakan AppsDeployStatus

Tindakan ini mendapatkan status deployment aplikasi

Parameter input tindakan AppsDeployStatus

Untuk contoh cara mengonfigurasi tindakan AppsDeployStatus, lihat Contoh tindakan.

Tindakan CreateApp

Tindakan ini membuat aplikasi.

Parameter input tindakan CreateApp

Untuk contoh cara mengonfigurasi tindakan CreateApp, lihat Contoh tindakan.

Tindakan DeleteGuests

Tindakan ini memungkinkan pengguna Menghapus Tamu.

Parameter input tindakan DeleteGuests

Untuk contoh cara mengonfigurasi tindakan DeleteGuests, lihat Contoh tindakan.

Tindakan DeployApps

Tindakan ini memungkinkan Anda men-deploy aplikasi.

Parameter input tindakan DeployApps

Untuk contoh cara mengonfigurasi tindakan DeployApps, lihat Contoh tindakan.

Tindakan DownloadFile

Tindakan ini memungkinkan pengguna mendownload file dari kolom lampiran di aplikasi.

Parameter input tindakan DownloadFile

Untuk contoh cara mengonfigurasi tindakan DownloadFile, lihat Contoh tindakan.

Tindakan UpdateAssignees

Tindakan ini memungkinkan pengguna memperbarui penerima tugas.

Parameter input tindakan UpdateAssignees

Untuk contoh cara mengonfigurasi tindakan UpdateAssignees, lihat Contoh tindakan.

Tindakan AddGuests

Tindakan ini memungkinkan pengguna menambahkan Tamu.

Parameter input tindakan AddGuests

Untuk contoh cara mengonfigurasi tindakan AddGuests, lihat Contoh tindakan.

Tindakan UploadFile

Tindakan ini memungkinkan Anda mengupload file.

Parameter input tindakan UploadFile

Tindakan AddThreadComment

Tindakan ini memungkinkan pengguna menambahkan komentar dalam rangkaian pesan

Parameter input tindakan AddThreadComment

Untuk contoh cara mengonfigurasi tindakan AddThreadComment, lihat Contoh tindakan.

Tindakan UpdateThread

Tindakan ini memungkinkan Anda memperbarui rangkaian pesan

Parameter input tindakan UpdateThread

Untuk contoh cara mengonfigurasi tindakan UpdateThread, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Mendapatkan status deployment aplikasi

Contoh ini mendapatkan status deployment aplikasi.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AppsDeployStatus, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "AppIds": "4"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AppsDeployStatus akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Membuat aplikasi

Contoh ini membuat aplikasi baru.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CreateApp, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Name": "NewApp"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CreateApp akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Men-deploy aplikasi

Contoh ini men-deploy aplikasi

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan DeployApps, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

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

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DeployApps akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Mendownload file

Contoh ini mendownload file yang ada di aplikasi.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan DownloadFile, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadFile akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Memperbarui penerima tugas

Contoh ini memperbarui penerima tugas.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan UpdateAssignees, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UpdateAssignees akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Menambahkan tamu

Contoh ini menambahkan tamu.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AddGuests, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom 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\"}]"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AddGuests akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Menghapus tamu

Contoh ini menghapus tamu.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan DeleteGuests, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

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

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DeleteGuests akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Mengupload file

Contoh ini menunjukkan cara mengupload file.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan UploadFile, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

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

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UploadFile akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Menambahkan komentar rangkaian pesan

Contoh ini menunjukkan cara menambahkan komentar rangkaian pesan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AddThreadComment, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

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

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AddThreadComment akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Memperbarui rangkaian pesan

Contoh ini menunjukkan cara memperbarui thread.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan UpdateThread, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

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

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UpdateThread akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entitas di konektor ini.

Contoh - Mencantumkan semua aplikasi

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Apps dari daftar Entity.
3. Pilih operasi List, lalu klik Selesai.
4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter. Selalu tentukan nilai klausa filter dalam tanda kutip tunggal (').

Anda juga dapat melakukan operasi List pada entitas Record dan Comments.

Contoh - Mendapatkan aplikasi

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Apps dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 4 di kolom Default Value.

   Di sini, 4 adalah ID data unik dalam entitas Apps.

Anda juga dapat melakukan operasi Get pada entity berikut: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers

Contoh - Menghapus data

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Record dari daftar Entity.
3. Pilih operasi Delete, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 6 di kolom Default Value.

Anda juga dapat melakukan operasi Hapus pada entitas Komentar.

Contoh - Membuat catatan

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Record dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Text": "HelloDemo"
   }

   Dengan menjalankan contoh ini, respons yang mirip dengan berikut akan ditampilkan dalam variabel output connectorOutputPayload tugas konektor:

   {
   "RecordId": 29.0
   }

Contoh - Memperbarui data

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Record dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Text_area": "updatedemo"
   }

5. Klik entityId, lalu masukkan 22 di kolom Default Value.

   Dengan menjalankan contoh ini, respons yang mirip dengan berikut akan ditampilkan dalam variabel output connectorOutputPayload tugas konektor:

   {
   "RecordId": "22"
   }