תיקון תגובות שגיאה (Preview)

חשוב

‏‫[מאמר זה הוא תיעוד קדם-הפצה והוא עשוי להשתנות.]‬

תגובות שגיאה חייבות להיות סטנדרטיות כדי להבטיח שהודעות השגיאה עקביות וקלות להבנה. הטבלה הבאה מפרטת את הסכימה עבור אובייקט השגיאה הצפויה בגוף התגובה.

שם	סוג נתונים	נדרש	Description
קוד שגיאה	מחרוזת	‏‏כן‬	קטגוריית שגיאות קצרה וקלה לזיהוי.
הודעת שגיאה	מחרוזת	לא	הודעה ידידותית למפתחים לקבלת פרטים נוספים אודות השגיאה.
activityId	מחרוזת	לא	מזהה ייחודי עבור הבקשה.
פרטים	אובייקט	לא	פרטים נוספים על השגיאה. התוכן עשוי להשתנות, בהתאם לסוג השגיאה. הדוגמה הבאה מציגה מקרה שבו למשתמש אין את ההרשאות המתאימות. { "resourceType": "מעטפה", "resourceId": "<envelopeId>" }

הטבלה הבאה מפרטת כמה תרחישים ואת קודי השגיאה הצפויים.

תרחיש	קוד שגיאה	קוד מצב HTTP
מערכת ניהול קשרי הלקוחות (CRM) שאליה מחובר המשתמש שונה מזו שצוינה בקלט.	חיבור CRM לא חוקי	400
מערכת ה- CRM של הרשומה לא נמצאה, או שהיא נמחקה.	רשומה לא נמצאה	404
המשתמש אינו מאומת. (תרחיש זה מתרחש בדרך כלל כאשר פג תוקפו של האסימון.)	INVALID_TOKEN_SPECIFIED	401
המשתמש אינו מורשה לבצע פעולה. (במילים אחרות, למשתמש אין הרשאות מספיקות).	הרשאות לא מספיקות	403
יותר מדי בקשות נשלחו למחבר.	REQUEST_THROTTLED	429
‏‏אירעה שגיאת שירות לא מטופלת.	שגיאת שרת פנימית	500

משוב

האם עמוד זה היה מועיל?