Box

Contoh konfigurasi koneksi

Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi.

Jenis koneksi metode token JWT OAuth

Anda dapat mengakses Client ID, Client Secret, Tingkat Akses Aplikasi Box, dan Enterprise Id/User Id dari akun Box.

Anda dapat mengakses Kunci Pribadi dan Sandi Kunci Pribadi dari file Private keypair.json yang Anda download. Untuk informasi selengkapnya, lihat Informasi pasangan kunci Publik dan Pribadi. Selain itu, sebelum Anda meneruskan sandi kunci pribadi, ganti \n di file json dengan baris baru.

Jenis koneksi kode otorisasi OAuth

Untuk mengetahui informasi tentang konfigurasi OAuth Box, lihat Membuat aplikasi OAuth.

Jenis koneksi metode autentikasi JWT Box Json

Anda dapat menggunakan akun Box untuk menyiapkan Box Json untuk autentikasi JWT. Untuk mengetahui informasi tentang cara menyiapkan Box Json untuk JWT, lihat Langkah-langkah pembuatan token JWT

Akses nilai autentikasi JWT Box Json dari file Private keypair.json yang Anda download. file. Untuk mengetahui informasi selengkapnya, lihat Informasi pasangan kunci Publik dan Pribadi. Anda harus memasukkan seluruh konten file .json di kolom Box Json for JWT Auth.

Jenis koneksi Kredensial Klien OAuth

Anda dapat mengakses Client ID, Client Secret, Tingkat Akses Aplikasi Box, dan Enterprise Id/User Id dari akun Box.

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 semua tindakan yang didukung oleh koneksi Box.

Tindakan DownloadFile

Tindakan ini memungkinkan Anda mendownload file dari instance Box Anda.

Parameter input tindakan DownloadFile

Parameter output tindakan DownloadFile

Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.

Untuk contoh cara mengonfigurasi tindakan DownloadFile, lihat Contoh tindakan.

Tindakan UploadFile

Tindakan ini memungkinkan Anda mengupload file ke instance Box Anda.

Parameter input tindakan UploadFile

Parameter output tindakan UploadFile

Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.

Untuk contoh cara mengonfigurasi tindakan UploadFile, lihat Contoh tindakan.

Tindakan CopyFile

Tindakan ini memungkinkan Anda menyalin file dari instance Box Anda.

Parameter input tindakan CopyFile

Parameter output tindakan CopyFile

Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.

Untuk contoh cara mengonfigurasi tindakan CopyFile, lihat Contoh tindakan.

Tindakan CopyFolder

Tindakan ini memungkinkan Anda menyalin seluruh folder dari instance Box Anda.

Parameter input tindakan CopyFolder

Parameter output tindakan CopyFolder

Tindakan ini menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.

Untuk contoh cara mengonfigurasi tindakan CopyFolder, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Mendownload file

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:

   {
   "FileID": "1283194869422", 
   "HasBytes": true
   }

Contoh ini mendownload file sebagai string berenkode Base64. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Contoh - 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:

   {
   "ParentId": "0",
   "Content": "12345"
   }

Contoh ini mengupload konten string sebagai file. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Contoh - Menyalin file

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

   {
   "FileID": "1288751886061",
   "DestinationFolderId": "219105724517", 
   "NewName": "NewCopiedFile"
   }

Contoh ini menyalin file dengan ID 1288751886061 ke folder dengan ID 219105724517. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"ID": "1308006018536"
}]

Contoh - Menyalin folder

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

   {
   "FolderID": "218475301279",
   "DestinationFolderId": "0", 
   "NewName": "NewCopiedFolder"
   }

Contoh ini menyalin folder dengan ID 218475301279 ke folder dengan ID 219105724517. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"ID": "226312444517"
}]

Contoh operasi entity

Contoh - Mencantumkan semua file

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih File dari Daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.

Anda dapat melakukan operasi LIST pada entitas berikut: Folder, TrashedItems, SharedItems, Collaborations, TaskAssignments, dan Tasks

Contoh - Mendapatkan file

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih File dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Setel ID entity ke 1262397830475 yang merupakan Kunci yang akan diteruskan. Untuk menyetel ID entitas, di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 1262397830475 di kolom Default Value.

Nilai untuk ID Entitas harus diteruskan secara langsung, seperti 1262397830475. Dengan 1262397830475 adalah nilai kunci utama yang unik.

Anda dapat melakukan operasi GET pada entitas berikut: Folder, SharedItems, Collaborations, TaskAssignments, dan Tasks

Contoh - Menghapus file

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih File dari daftar Entity.
3. Pilih operasi DELETE, lalu klik Selesai.
4. Setel ID entity ke 1258725940971 yang merupakan Kunci yang akan diteruskan. Untuk menyetel ID entitas, di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 1258725940971 di kolom Default Value.

   Atau, jika Entity memiliki dua Kunci Bisnis Gabungan atau Kunci Primer, bukan menentukan entityId, Anda juga dapat menetapkan filterClause ke Id='1258725940971'.

Anda dapat melakukan operasi DELETE pada entitas berikut: Folder, Tugas, Kolaborasi, ItemBersama, dan PenugasanTugas

Contoh - Membuat folder

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Folder 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:

   {
   "Name": "Google Cloud Platforms_created_folders",
   "ParentId": "0"
   }

   Jika integrasi berhasil, parameter respons connectorOutputPayload tugas Folder akan memiliki nilai yang mirip dengan berikut:

    
   {
   "Id": "222269371053"
   } 

Contoh - Membuat kolaborasi

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Kolaborasi 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:

   {
   "ItemId": "216592737829",
   "ItemType": "folder",
   "AccessibleById": "27370766275",
   "AccessibleByType": "user",
   "AccessibleByLogin": "baklavainthebalkans@gmail.com",
   "Role": "editor"
   }

   Jika integrasi berhasil, parameter respons connectorOutputPayload tugas Folder akan memiliki nilai yang mirip dengan :

   {
   "Success": false
   } 

Contoh - Membuat tugas

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tugas 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:

   {
   "ItemId": "1253997361112",
   "ItemType": "file",
   "Action": "review",
   "Message": "Creating a task from Google Cloud Platform",
   "DueAt": "2023-12-12 09:01:15.0",
   "CompletionRule": "all_assignees"
   }

   Jika integrasi berhasil, parameter respons connectorOutputPayload tugas Folder akan memiliki nilai yang mirip dengan berikut:

    
   {
   "Id": "1253997361112"
   }

Contoh - Membuat penetapan tugas

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TaskAssignments 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:

   {
   "TaskId": "21507516872",
   "AssignedToId": "27370766275"
   }

   Jika integrasi berhasil, parameter respons connectorOutputPayload tugas Folder akan memiliki nilai yang mirip dengan berikut:

    
   {
   "Id": "50804351753"
   }

Contoh - Memperbarui File

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih File 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:

   {
   "Name": "Get Started with Box Files.pdf"
   }

5. Tetapkan ID entitas ke 1253997361112. Untuk menyetel ID entitas, klik entityId, lalu masukkan 1253997361112 di kolom Nilai Default.

   Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 1253997361112.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   "Id": "1253997361112"
   }

Anda dapat melakukan operasi UPDATE pada entitas berikut: Folders, Tasks, Collaborations, SharedItems, dan TaskAssignments

Contoh - Memperbarui folder

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Folder 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:

   {
   "Name": "Demo Update"
   }

5. Tetapkan ID entitas ke 216457668125. Untuk menyetel ID entitas, klik entityId, lalu masukkan 216457668125 di kolom Nilai Default.

   Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 216457668125.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   "Id": "216457668125"
   } 

Contoh - Memperbarui kolaborasi

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Kolaborasi 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:

   {
   "Role": "Viewer"
   }

5. Setel ID entity ke 46685648757. Untuk menyetel ID entitas, klik entityId, lalu masukkan 46685648757 di kolom Nilai Default.

   Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 46685648757.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   
   }

Contoh - Perbarui tugas

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tugas 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:

   {
   "Message": "This is a new task is updated and assigned to you by me"
   }

5. Tetapkan ID entitas ke 21507516872. Untuk menyetel ID entitas, klik entityId, lalu masukkan 21507516872 di kolom Nilai Default.

   Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 21507516872.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   "Id": "21507516872"
   }

Contoh - Memperbarui taskassignments

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TaskAssignments 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:

   {
   "Message": "Looks good to me",
   "ResolutionState": "completed"
   }

5. Tetapkan ID entitas ke 49542929469. Untuk menyetel ID entitas, klik entityId, lalu masukkan 49542929469 di kolom Nilai Default.

   Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 49542929469.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   "Id": "49542929469"
   } 

Contoh - Update Transferfolders

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Folder 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:

   {
   "Name": "Demo Update"
   "ParentId": "216596059374"
   }

5. Tetapkan ID entitas ke 216457668125. Untuk menyetel ID entitas, klik entityId, lalu masukkan 216457668125 di kolom Nilai Default.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
   "Id": "216457668125"
   }