Kintone
מחבר Kintone מאפשר לכם לבצע פעולות של הוספה, מחיקה, עדכון וקריאה במסד נתונים של Kintone.
לפני שמתחילים
לפני שמשתמשים במחבר Kintone, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-Google Cloud:
- מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM roles/connectors.admin.
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. המחבר וחשבון השירות צריכים להיות שייכים לאותו פרויקט. מידע נוסף זמין במאמר בנושא יצירת חשבון שירות.
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
הגדרת המחבר
החיבור הוא ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- מחבר: בוחרים באפשרות Kintone מהרשימה הנפתחת של המחברים הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- אופציונלי: מזינים תיאור למופע החיבור.
- אופציונלי: מפעילים את Cloud Logging ואז בוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-
Error. - חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- אופציונלי: מגדירים את ההגדרות של צומת החיבור:
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר עסקאות לחיבור נדרשים יותר צמתים, ולהפך: כדי לעבד פחות עסקאות נדרשים פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- התרת תווים מיוחדים: קובעת אם מותר להשתמש בתווים מיוחדים. אם הערך הוא true, התווים המיוחדים לא יוחלפו.
- Check For Subtables In (חיפוש טבלאות משנה ב): רשימה מופרדת בפסיקים של אפליקציות Kintone שממנה יאוחזרו טבלאות משנה.
- מזהה מרחב אורח: הגבלת תוצאות השאילתה למרחב אורח.
- Number Map To Double (מיפוי מספרים למספרים כפולים): קובע אם לשנות את סוג הנתונים של שדות מספרים מעשרוני למספר כפול.
- תו מפריד של טבלת משנה: התו שמשמש לחלוקת טבלאות מטבלאות משנה בפורמט tablename + char + subtable.
- שימוש בקוד לשם השדה: קובע אם להשתמש בתווית או בקוד לשם השדה.
- Use Cursor: ערך בוליאני שקובע אם צריך להשתמש בסמנים כדי לאחזר רשומות.
- תצוגות שהוגדרו על ידי המשתמש: נתיב לקובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית.
- (אופציונלי) בקטע הגדרות מתקדמות, מסמנים את התיבה שימוש ב-proxy כדי להגדיר שרת proxy לחיבור, ומגדירים את הערכים הבאים:
-
סכימת אימות של שרת proxy: בוחרים את סוג האימות לאימות מול שרת ה-proxy. אלה סוגי האימות שנתמכים:
- בסיסי: אימות HTTP בסיסי.
- Digest: אימות HTTP מסוג Digest.
- משתמש proxy: שם משתמש שישמש לאימות בשרת ה-proxy.
- סיסמת ה-Proxy: הסוד במנהל הסודות של סיסמת המשתמש.
-
סוג ה-SSL של ה-Proxy: סוג ה-SSL שבו יש להשתמש כשמתחברים לשרת ה-Proxy. אלה סוגי האימות שנתמכים:
- אוטומטי: הגדרת ברירת המחדל. אם כתובת ה-URL היא כתובת HTTPS, נעשה שימוש באפשרות Tunnel. אם כתובת ה-URL היא כתובת HTTP, נעשה שימוש באפשרות NEVER.
- תמיד: החיבור תמיד מופעל באמצעות SSL.
- לעולם לא: החיבור לא מופעל באמצעות SSL.
- מנהור: החיבור הוא דרך שרת proxy למנהור. שרת ה-proxy פותח חיבור למארח המרוחק, והתנועה זורמת הלוך ושוב דרך ה-proxy.
- בקטע שרת Proxy, מזינים את פרטי שרת ה-Proxy.
- לוחצים על + הוספת יעד.
- בוחרים סוג יעד.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
כדי ליצור חיבור פרטי למערכת העורפית, פועלים לפי השלבים הבאים:
- יוצרים קובץ מצורף לשירות PSC.
- יוצרים endpoint attachment ואז מזינים את הפרטים שלו בשדה Host address.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
- אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
- בקטע יעדים, מזינים את הפרטים של המארח המרוחק (מערכת העורף) שאליו רוצים להתחבר.
- סוג היעד: בוחרים סוג יעד.
- כדי לציין את שם המארח או את כתובת ה-IP של היעד, בוחרים באפשרות כתובת המארח ומזינים את הכתובת בשדה מארח 1.
- כדי ליצור חיבור פרטי, בוחרים באפשרות Endpoint attachment (צירוף נקודת קצה). ברשימה Endpoint Attachment, בוחרים את קובץ ה-Endpoint Attachment שנוצר עבור מערכת ה-Backend.
אם רוצים ליצור חיבור ציבורי למערכות העורפיות עם אבטחה נוספת, אפשר להגדיר כתובות IP סטטיות יוצאות לחיבורים, ואז להגדיר את כללי חומת האש כך שרק כתובות ה-IP הסטטיות הספציפיות יופיעו ברשימת ההיתרים.
כדי להזין יעדים נוספים, לוחצים על +הוספת יעד.
- לוחצים על הבא.
- סוג היעד: בוחרים סוג יעד.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
החיבור ל-Kintone תומך בסוגי האימות הבאים:
- שם משתמש וסיסמה
- טוקן API
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- בדיקה: בודקים את פרטי החיבור והאימות.
- לוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
-
שם משתמש וסיסמה
- שם משתמש: שם המשתמש של המחבר
- סיסמה: סוד ב-Secret Manager שמכיל את הסיסמה שמשויכת למחבר.
- סיסמה לאימות בסיסי: הסיסמה הנוספת שנדרשת לדומיינים שמשתמשים באימות בסיסי.
- משתמש באימות בסיסי: שם המשתמש הנוסף שנדרש לדומיינים שמשתמשים באימות בסיסי.
-
API Token
- API Token: סוד ב-Secret Manager שמכיל את טוקן ה-API לאימות.
- מזהה האפליקציה: מזהה האפליקציה שמשמש יחד עם APIToken לאימות.
דוגמאות להגדרת חיבור
בקטע הזה מפורטים ערכים לדוגמה לשדות השונים שאתם מגדירים כשאתם יוצרים חיבור ל-Kintone.
סוג החיבור של אימות בסיסי
בחיבור מסוג אימות בסיסי, משתמשים בשם המשתמש ובסיסמה שמקבלים כשיוצרים את מופע Kintone החדש.
| שם השדה | פרטים |
|---|---|
| מיקום | europe-west1 |
| מחבר | Kintone |
| גרסת המחבר | 1 |
| שם החיבור | kintone-conn-free-trial |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| Check For Subtables in | * |
| שימוש בקוד לשם השדה | כן |
| שימוש בסמן | כן |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 2 |
| סוג היעד(שרת) | כתובת המארח |
| כתובת המארח | https://tx3tdonei8na.kintone.com |
| שם משתמש | שם משתמש |
| סיסמה | PASSWORD |
| גרסה של סוד | 2 |
סוג החיבור של טוקן ה-API
מידע על קבלת טוקן API זמין במאמר טוקן גישה ל-API.
| שם השדה | פרטים |
|---|---|
| מיקום | europe-west1 |
| מחבר | Kintone |
| גרסת המחבר | 1 |
| שם החיבור | kintone-api-token-conn |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| Check For Subtables in | * |
| תו המפריד של טבלת המשנה | _ |
| שימוש בקוד לשם השדה | כן |
| שימוש בסמן | כן |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| סוג היעד(שרת) | כתובת המארח |
| כתובת המארח | https://tx3tdonei8na.kintone.com |
| טוקן API | API_Token_PostmanApplication |
| AppId | 4 |
| גרסה של סוד | 1 |
סוג חיבור OAuth
בקטע הזה מפורטים ערכי הדוגמה של השדות השונים שאתם מגדירים כשאתם יוצרים חיבור ל-Kintone באמצעות OAuth. בנוסף, מוסבר כאן איך ליצור חשבון Kintone ולהגדיר אותו.
יצירה והגדרה של חשבון Kintone
- מידע על יצירת חשבון ב-Kintone זמין במאמר יצירת מופע חינמי של Kintone.
- במאמר הוספת לקוח OAuth מוסבר איך להוסיף לקוח OAuth.
- מידע על יצירת מרחב חדש זמין במאמר יצירת מרחב.
- מידע על יצירת אפליקציה זמין במאמר יצירת אפליקציה מאפס.
- במאמר יצירת שרשור מוסבר איך ליצור שרשור.
| שם השדה | פרטים |
|---|---|
| מיקום | europe-west1 |
| מחבר | Kintone |
| גרסת המחבר | 1 |
| שם החיבור | kintone-oauth-conn |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| Check For Subtables in | * |
| תו המפריד של טבלת המשנה | _ |
| שימוש בקוד לשם השדה | כן |
| שימוש בסמן | כן |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| סוג היעד(שרת) | כתובת המארח |
| כתובת המארח | https://tx3tdonei8na.kintone.com |
| מזהה לקוח | CLIENT_ID |
| היקפים | k:app_settings:write k:app_settings:read k:app_record:read k:app_record:write k:file:read k:file:write |
| סוד לקוח | CLIENT_SECRET |
| גרסה של סוד | 2 |
ישויות, פעולות ופעולות
כל Integration Connectors מספקים שכבת הפשטה לאובייקטים של האפליקציה המחוברת. אפשר לגשת לאובייקטים של אפליקציה רק דרך ההפשטה הזו. ההפשטה מוצגת לכם כישויות, פעולות ופעולות.
- ישות: ישות היא אובייקט או אוסף של מאפיינים באפליקציה או בשירות המקושרים. ההגדרה של ישות משתנה ממחבר למחבר. לדוגמה, במחבר של מסד נתונים, הטבלאות הן הישויות, במחבר של שרת קבצים, התיקיות הן הישויות, ובמחבר של מערכת הודעות, התורים הם הישויות.
עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה
Entitiesתהיה ריקה. - פעולה: פעולה היא הפעילות שאפשר לבצע בישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:
בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה
Operations. - פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה
Actionsתהיה ריקה.
מגבלות המערכת
מחבר Kintone יכול לעבד 5 טרנזקציות בשנייה, לכל צומת, ומגביל את כל הטרנזקציות מעבר למגבלה הזו. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.
מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.
פעולות
בקטע הזה מפורטות הפעולות שהמחבר תומך בהן. כדי להבין איך להגדיר את הפעולות, אפשר לעיין בדוגמאות לפעולות.
פעולת AppsDeployStatus
הפעולה הזו מקבלת את סטטוס הפריסה של האפליקציה
פרמטרים של קלט לפעולה AppsDeployStatus
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| AppIds | String | כן | המזהה של האפליקציה. יכול להיות רשימה של מזהים מופרדים בפסיקים. |
| GuestSpaceId | String | לא | הפרמטר הזה משמש לאפליקציות שנמצאות במרחב האורחים. אל תוסיפו את הפרמטר הזה אם מאפיין החיבור GuestSpaceId מצוין במחרוזת החיבור. |
דוגמאות להגדרת הפעולה AppsDeployStatus מופיעות במאמר דוגמאות לפעולות.
פעולת CreateApp
הפעולה הזו יוצרת אפליקציות.
פרמטרים של קלט לפעולה CreateApp
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| שם | String | כן | מציינים את שם האפליקציה באורך של פחות מ-64 תווים. |
| רווח | String | לא | המזהה של המרחב. אל תציינו את ההגדרה הזו אם מאפיין החיבור GuestSpaceId מוגדר במחרוזת החיבור. |
| ThreadId | String | לא | המזהה של המרחב. אל תציינו את ההגדרה הזו אם מאפיין החיבור GuestSpaceId מוגדר במחרוזת החיבור. |
| IsGuestSpace | בוליאני | לא | זהו ערך בוליאני שמציין אם פרמטר המרחב הוא מרחב רגיל או מרחב לאורחים. מגדירים את הערך הזה כ-true במרחבים לאורחים. ערך ברירת המחדל הוא False. |
דוגמאות להגדרת הפעולה CreateApp מופיעות במאמר דוגמאות לפעולות.
פעולת מחיקה של אורחים
הפעולה הזו מאפשרת למשתמשים למחוק אורחים.
פרמטרים של קלט לפעולה DeleteGuests
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| אורחים | String | כן | רשימה של כתובות אימייל של משתמשים עם הרשאת גישה כאורחים. אפשר למחוק עד 100 אורחים. |
דוגמאות להגדרת הפעולה DeleteGuests מופיעות במאמר דוגמאות לפעולות.
פעולת DeployApps
הפעולה הזו מאפשרת לפרוס אפליקציות.
פרמטרים של קלט לפעולה DeployApps
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| AppId | String | כן | מזהה האפליקציה. אפשר להזין רשימה של מזהים מופרדים בפסיקים. |
| גרסה קודמת | String | לא | מציינים את הגרסה של ההגדרה שמשקפת את סביבת ההפעלה. אם הגרסה שצוינה לא עדכנית, הבקשה תיכשל. |
| חזרה לגרסה הקודמת | בוליאני | לא | אם רוצים לבטל את השינוי בהגדרות האפליקציה, צריך להגדיר את הערך הזה כ-true. ערך ברירת המחדל הוא False. |
| GuestSpaceId | String | לא | הפרמטר הזה משמש לאפליקציות שנמצאות במרחב האורחים. אל תוסיפו את הפרמטר הזה אם מאפיין החיבור GuestSpaceid מצוין במחרוזת החיבור. |
דוגמאות להגדרת הפעולה DeployApps מופיעות במאמר דוגמאות לפעולות.
הפעולה DownloadFile
הפעולה הזו מאפשרת למשתמשים להוריד קבצים משדה של קובץ מצורף באפליקציה.
פרמטרים של קלט לפעולה DownloadFile
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| FileKey | String | כן | המזהה של הקובץ. |
| HasBytes | בוליאני | לא | האם להוריד את התוכן כבייט. הערכים התקינים הם true או false.
אם הערך הוא true, הקובץ יורד כמחרוזת מקודדת Base64.
כברירת מחדל, השדה |
דוגמאות להגדרת הפעולה DownloadFile מופיעות במאמר דוגמאות לפעולות.
פעולת העדכון של המקבלים
הפעולה הזו מאפשרת למשתמשים לעדכן את הנמענים.
פרמטרים של קלט לפעולה UpdateAssignees
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| AppId | String | כן | מזהה האפליקציה. |
| RecordId | String | כן | RecordId |
| מקבל ההקצאה | String | כן | קודי המשתמש של המקבלים. אם השדה ריק, לא יוקצו משתמשים. המספר המקסימלי של המשתמשים שאפשר להקצות להם משימות הוא 100. |
| גרסה קודמת | String | לא | מספר הגרסה של הרשומה לפני עדכון המקבלים. אם הגרסה שצוינה היא לא הגרסה האחרונה, הבקשה תגרום לשגיאה. |
| GuestSpaceId | String | לא | הפרמטר הזה משמש לאפליקציות שנמצאות במרחב האורחים. אל תוסיפו את הפרמטר הזה אם מאפיין החיבור GuestSpaceId מצוין במחרוזת החיבור. |
דוגמאות להגדרת הפעולה UpdateAssignees מופיעות במאמר דוגמאות לפעולות.
הפעולה AddGuests
הפעולה הזו מאפשרת למשתמשים להוסיף אורחים.
פרמטרים של קלט לפעולה AddGuests
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| שם | String | FALSE | השם המוצג של המשתמש. האורך צריך להיות בין 1 ל-128 תווים. |
| קוד | String | לא | כתובת האימייל (שם הכניסה) של משתמש האורח. |
| סיסמה | String | לא | סיסמת הכניסה של משתמש האורח. הוא חייב להיות אלפאנומרי. |
| אזור הזמן | String | לא | אזור הזמן של משתמש אורח. |
| לוקאל | String | לא | הגדרות השפה של משתמש האורח. הערכים האפשריים הם auto, en, zh, ja. אם לא תציינו ערך, המערכת תגדיר את הערך auto כברירת מחדל. |
| תמונה | String | לא | תמונת הפרופיל של משתמש האורח. מציינים את fileKey של קובץ שהועלה. |
| SurNameReading | String | לא | ההגדרות של שם המשפחה הפונטי של המשתמש האורח. האורך המקסימלי הוא 64 תווים. |
| GivenNameReading | String | לא | ההגדרות של השם הפרטי הפונטי של משתמש האורח. האורך המקסימלי הוא 64 תווים. |
| חברה | String | לא | שם החברה שיוצג בפרופיל של משתמש האורח. |
| חטיבה | String | לא | שם המחלקה שיוצג בפרופיל של משתמש האורח. |
| טלפון | String | לא | מספר הטלפון שיוצג בפרופיל של משתמש אורח. |
| CallTo | String | לא | שם המשתמש ב-Skype של המשתמש האורח. |
| GuestsAggregate | String | לא | הנתון המצטבר של האורחים. |
דוגמאות להגדרת הפעולה AddGuests מופיעות במאמר דוגמאות לפעולות.
הפעולה UploadFile
הפעולה הזו מאפשרת להעלות קובץ.
פרמטרים של קלט לפעולה UploadFile
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| FileName | String | כן | השם שרוצים לתת למסמך. אם לא מציינים שם, המערכת משתמשת בשם הקובץ שצוין בקלט FullPath. |
| תוכן | String | לא | התוכן כ-InputStream להעלאה כשלא מצוין FullPath. |
| ContentBytes | String | לא | תוכן בבייט (כמחרוזת Base64) להעלאה כקובץ. משתמשים באפשרות הזו כדי להעלות נתונים בינאריים. |
| AppId | String | לא | מזהה האפליקציה ב-Kintone. המאפיין הזה נדרש כשהערך של AttachToApp הוא true. |
| HasBytes | בוליאני | לא | האם להעלות תוכן כבייטים. הערכים התקינים הם true או false.
אם הערך הוא true, תוכן הקובץ צריך להיות מחרוזת מקודדת Base64.
כברירת מחדל, השדה |
פעולת AddThreadComment
הפעולה הזו מאפשרת למשתמשים להוסיף תגובות בשרשור
פרמטרים של קלט של הפעולה AddThreadComment
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| SpaceId | מספר שלם | כן | המזהה של המרחב. |
| ThreadId | מספר שלם | כן | המזהה של השרשור. |
| טקסט | String | לא | תוכן התגובה. אפשר לציין מעבר שורה באמצעות LF. המספר המקסימלי של תווים בתגובה הוא 65,535. חובה, אם לא מוגדר קובץ. |
| אזכורים | String | לא | מערך שכולל אזכורים, ששולחים התראות למשתמשי Kintone אחרים. |
| קבצים | String | לא | מערך שכולל נתונים של קבצים מצורפים. אפשר להעלות עד 5 קבצים. חובה, אם לא מוגדר טקסט. |
דוגמה להגדרת הפעולה AddThreadComment מופיעה במאמר דוגמאות לפעולות.
פעולת העדכון של השרשור
הפעולה הזו מאפשרת לעדכן שרשור
פרמטרים של קלט לפעולה UpdateThread
| שם הפרמטר | סוג הנתונים | חובה | תיאור |
|---|---|---|---|
| ThreadId | מספר שלם | כן | מזהה השרשור. מזהה השרשור מופיע בכתובת ה-URL של השרשור. |
| שם | String | לא | השם החדש של השרשור. האורך צריך להיות בין 1 ל-128 תווים. אם המערכת מתעלמת מהפרמטר הזה, השם לא מתעדכן. אי אפשר לעדכן את שם השרשור במרחבים עם שרשור אחד. |
| גוף | String | לא | התוכן של גוף השרשור. |
דוגמה להגדרת הפעולה UpdateThread מופיעה במאמר דוגמאות לפעולות.
דוגמאות לפעולות
בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.
דוגמה – קבלת סטטוס פריסת האפליקציה
בדוגמה הזו מאחזרים את סטטוס הפריסה של האפליקציה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
AppsDeployStatusולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "AppIds": "4" }
אם הפעולה מצליחה, ערך הפרמטר AppsDeployStatus response connectorOutputPayload של המשימה יהיה דומה לדוגמה הבאה:
{ "AppId": "4", "Status": "SUCCESS", "success": "true" }
דוגמה – יצירת אפליקציה
בדוגמה הזו נוצרת אפליקציה חדשה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
CreateAppולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "NewApp" }
אם הפעולה מצליחה, לפרמטר התגובה CreateApp של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "AppId": "20", "Revision": "2", "Success": "true" }]
דוגמה – פריסת אפליקציה
בדוגמה הזו פורסים אפליקציה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DeployAppsולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "AppId": "19", "Revision": "2" }
אם הפעולה מצליחה, לפרמטר התגובה DeployApps של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true" }]
דוגמה – הורדת קובץ
בדוגמה הזו מורידים קובץ שקיים באפליקציה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DownloadFileולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049" }
אם הפעולה מצליחה, לפרמטר התגובה DownloadFile של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "True", "Content": "Record number, Number, Text\n49, 162, Hello" }]
דוגמה – עדכון של מקבל ההקצאה
בדוגמה הזו מעדכנים את המקבל/ת של ההקצאה.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UpdateAssigneesולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "FileKey": "2024022706351283F683AABB3A4FA09AF1D28049" }
אם הפעולה מצליחה, לפרמטר התגובה UpdateAssignees של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "True", "Content": "Record number, Number, Text\n49, 162, Hello" }]
דוגמה – הוספת משתתפים
בדוגמה הזו מוסיפים משתתף.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
AddGuestsולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדה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\"}]" }
אם הפעולה מצליחה, לפרמטר התגובה AddGuests של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true" }]
דוגמה – מחיקת אורח
בדוגמה הזו נמחק משתמש אורח.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DeleteGuestsולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Guests": "[\"testuser1@test.com\"]" }
אם הפעולה מצליחה, לפרמטר התגובה DeleteGuests של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true" }]
דוגמה – העלאת קובץ
בדוגמה הזו מוסבר איך להעלות קובץ.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UploadFileולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "FileName": "GoogleCloud_Upload_File.txt", "AppId": "9", "Content": "Hello" }
אם הפעולה מצליחה, לפרמטר התגובה UploadFile של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35", "Success": "true", "Id": null, "Revision": null }]
דוגמה – הוספת תגובה לשרשור
בדוגמה הזו מוסבר איך להוסיף תגובה לשרשור.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
AddThreadCommentולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "SpaceId": 1.0, "ThreadId": 1.0, "Text": "Test Comment" }
אם הפעולה מצליחה, לפרמטר התגובה AddThreadComment של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Id": "3", "Success": "true" }]
דוגמה – עדכון של שרשור
בדוגמה הזו אפשר לראות איך מעדכנים שרשור.
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UpdateThreadולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "ThreadId": 1.0, "Name": "updated thread" }
אם הפעולה מצליחה, לפרמטר התגובה UpdateThread של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Success": "true" }]
דוגמאות לפעולות על ישויות
בקטע הזה מוסבר איך לבצע חלק מהפעולות על ישויות במחבר הזה.
דוגמה – רשימת כל האפליקציות
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
AppsמהרשימהEntity. - בוחרים את הפעולה
Listולוחצים על סיום. - אופציונלי: בקטע Task Input במשימה Connectors, אפשר לסנן את קבוצת התוצאות על ידי ציון filter clause. תמיד מציינים את הערך של סעיף המסנן בתוך גרשיים בודדים (').
אפשר לבצע את הפעולה List גם על הישויות Record ו-Comments.
דוגמה – הורדת אפליקציה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
AppsמהרשימהEntity. - בוחרים את הפעולה
Getולוחצים על סיום. - בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על EntityId (מזהה ישות) ואז מזינים
4בשדה Default Value (ערך ברירת מחדל).כאן,
4הוא מזהה רשומה ייחודי בישותApps.
אפשר גם לבצע את פעולת Get בישויות הבאות: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers
דוגמה – מחיקת רשומה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
RecordמהרשימהEntity. - בוחרים את הפעולה
Deleteולוחצים על סיום. - בקטע Task Input (קלט משימה) של המשימה Connectors (מחברים), לוחצים על entityId ואז מזינים
6בשדה Default Value (ערך ברירת מחדל).
אפשר גם לבצע את פעולת המחיקה על ישויות של תגובות.
דוגמה – יצירת רשומה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
RecordמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Text": "HelloDemo" }
הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ "RecordId": 29.0 }
דוגמה – עדכון רשומה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
RecordמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Text_area": "updatedemo" }
- לוחצים על entityId ואז מזינים
22בשדה ערך ברירת מחדל.הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ "RecordId": "22" }
יצירת חיבורים באמצעות Terraform
אפשר להשתמש במשאב של Terraform כדי ליצור חיבור חדש.
כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.
כדי לראות תבנית לדוגמה של Terraform ליצירת חיבור, אפשר לעיין בתבנית לדוגמה.
כשיוצרים את החיבור הזה באמצעות Terraform, צריך להגדיר את המשתנים הבאים בקובץ ההגדרות של Terraform:
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| allow_special_characters | בוליאני | לא נכון | קובע אם לאפשר תווים מיוחדים או לא. אם הערך הוא true, התווים המיוחדים לא יוחלפו. |
| check_for_subtables_in | מחרוזת | נכון | רשימה מופרדת בפסיקים של אפליקציות Kintone שמהן יאוחזרו טבלאות משנה. |
| guest_space_id | מחרוזת | לא נכון | הגבלת תוצאות השאילתה למרחב אורחים. |
| number_map_to_double | בוליאני | לא נכון | הפונקציה קובעת אם לשנות את סוג הנתונים של שדות מספריים מעשרוני למספר כפול. |
| subtable_separator_character | מחרוזת | נכון | התו שמשמש לחלוקת טבלאות מטבלאות משנה בפורמט tablename + char + subtable. |
| use_code_for_field_name | בוליאני | לא נכון | קובע אם להשתמש בתווית או בקוד עבור שם השדה. |
| use_cursor | בוליאני | לא נכון | ערך בוליאני שקובע אם צריך להשתמש בסמנים כדי לאחזר רשומות. |
| user_defined_views | מחרוזת | לא נכון | נתיב קובץ שמצביע על קובץ ההגדרות בפורמט JSON שמכיל את התצוגות המותאמות אישית. |
| proxy_enabled | בוליאני | לא נכון | מסמנים את תיבת הסימון הזו כדי להגדיר שרת Proxy לחיבור. |
| proxy_auth_scheme | ENUM | לא נכון | סוג האימות שבו יש להשתמש כדי לבצע אימות לשרת ה-proxy ProxyServer. הערכים הנתמכים הם: BASIC, DIGEST, NONE |
| proxy_user | מחרוזת | לא נכון | שם משתמש שישמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_password | SECRET | לא נכון | סיסמה שתשמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_ssltype | ENUM | לא נכון | סוג ה-SSL שבו צריך להשתמש כשמתחברים לשרת ה-proxy של ProxyServer. הערכים הנתמכים הם: AUTO, ALWAYS, NEVER, TUNNEL |
שימוש בחיבור Kintone בשילוב
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.