סקירת פריטים on ~.Dimensions.~

קבל פריט

Mon, 01 Jan 0001 00:00:00 +0000

קבל פריט #

מקבל פריט תיקייה ספציפי.

GET /v1.0/contactdirectoryies/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

דוגמה #

הבקשה הזו תקבל פריט ספציפי מתיקיה שמזהה אותה.

בקשה #

 
קבל <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
הרשאה: נושא {TOKEN}

תגובה #

 
HTTP/1.1 200 OK 
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
{ 
	"page_size": 1, 
	"data": [{ 
            "id": "00000000-0000-0000-0000-00000-000000000123", 
            "שדות": { 
                "כותרת": "מר", 
                "fullName": "CRM2", 
                "שם חברה": "חברה", 
                "jobTitle": "Job Title", 
                "phone1": "+44XXXXXXXXXXXX", 
                "אימייל": "כתובת דוא"ל", 
                "field1": "field1", 
                "field2": "field2", 
                "crmId": "00000000-00000-00000-00000-0000000001" 
            }
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ], 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-01-01T10:00:00.2890319Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

קבל פריטים

Mon, 01 Jan 0001 00:00:00 +0000

קבל פריטים #

מקבל כל פריט תיקייה התואם למסנן שסופק.

GET /v1.0/contactdirectoryies/{DIRECTORY_ID}/items?filter={FILTER}&fields={FIELDS}

warning
זכור לקודד URL לקודד כל פרמטר שמועבר בפרמטר 'filter'.

note
כאשר מחפשים בשדות 'phoneX', המספרים נשמרים בפורמט E.164.

דוגמה #

בקשה זו תבצע שאילתה לכל הפריטים עם שדה טלפון המכיל +44XXXXXXXXXX

החלפת פריט

Mon, 01 Jan 0001 00:00:00 +0000

החלפת פריט #

מחליף פריט תיקייה קיים.

PUT /v1.0/contactdirectoryies/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

דוגמה #

בקשה זו תעדכן פריט תיקייה קיים.

בקשה #

 
שים <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
סוג תוכן: application/json
קבלה-חיובים: נכון
הרשאה: נושא {TOKEN}
קשר: לשמור בחיים
{ 
    "שדות": { 
        "כותרת": "מר", 
        "fullName": "CRM3a", 
        "שם חברה": "חברה", 
        "jobTitle": "Job Title", 
        "phone1": "+44XXXXXXXXXXXX", 
        "אימייל": "כתובת דוא"ל", 
        "field1": "field1", 
        "field2": "field2", 
        "crmId": "00000000-00000-00000-00000-0000000001" 
    }
}

תגובה #

 
HTTP/1.1 201 נוצר
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
מיקום: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> 
{ 
	"data": { 
        "id": "00000000-0000-0000-0000-00000-000000000123", 
        "שדות": { 
            "כותרת": "מר", 
            "fullName": "CRM3a", 
            "שם חברה": "חברה", 
            "jobTitle": "Job Title", 
            "phone1": "+44XXXXXXXXXXXX", 
            "אימייל": "כתובת דוא"ל", 
            "field1": "field1", 
            "field2": "field2", 
            "crmId": "00000000-00000-00000-00000-0000000001" 
        }
    }, 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-11-29T16:03:23.9251680Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

יצירת פריט

Mon, 01 Jan 0001 00:00:00 +0000

יצירת פריט #

יוצר פריט תיקיה חדש בתיקייה שסופקה.

POST /v1.0/contactdirectoryies/{DIRECTORY_ID}/items

דוגמה #

בקשה זו תיצור פריט תיקייה חדש.

בקשה #

 
פוסט <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
סוג תוכן: application/json
קבלה-חיובים: נכון
הרשאה: נושא {TOKEN}
קשר: לשמור בחיים
{ 
	"שדות": { 
        "כותרת": "מר", 
        "fullName": "CRM3a", 
        "שם חברה": "חברה", 
        "jobTitle": "Job Title", 
        "phone1": "+44XXXXXXXXXXXX", 
        "אימייל": "כתובת דוא"ל", 
        "field1": "field1", 
        "field2": "field2", 
        "crmId": "00000000-00000-00000-00000-0000000001" 
    }
}

תגובה #

 
HTTP/1.1 201 נוצר
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
מיקום: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> 
{ 
	"data": { 
        "id": "00000000-0000-0000-0000-00000-000000000123", 
        "שדות": { 
            "כותרת": "מר", 
            "fullName": "CRM3a", 
            "שם חברה": "חברה", 
            "jobTitle": "Job Title", 
            "phone1": "+44XXXXXXXXXXXX", 
            "אימייל": "כתובת דוא"ל", 
            "field1": "field1", 
            "field2": "field2", 
            "crmId": "00000000-00000-00000-00000-0000000001" 
        }
    }, 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-11-29T16:03:23.9251680Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

פריט תיקון

Mon, 01 Jan 0001 00:00:00 +0000

פריט תיקון #

מעדכן סט ספציפי של תכונות של פריט תיקייה. זה משתמש בפורמט ה-Patch JSON לכל שינוי.

PATCH /v1.0/contactdirectoryies/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

דוגמה #

בקשה זו תוסיף שדה טלפון חדש לפריט תיקייה קיים.

בקשה #

 
תיקון <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
סוג תוכן: application/json
קבלה-חיובים: נכון
הרשאה: נושא {TOKEN}
קשר: לשמור בחיים
{ 
    "path": "/fields/phone2", 
    "op": "add", 
    "ערך": "+44YYYYYYYYYY" 
}

תגובה #

 
HTTP/1.1 201 נוצר
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
מיקום: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> 
{ 
	"data": { 
        "id": "00000000-0000-0000-0000-00000-000000000123", 
        "שדות": { 
            "כותרת": "מר", 
            "fullName": "CRM3a", 
            "שם חברה": "חברה", 
            "jobTitle": "Job Title", 
            "phone1": "+44XXXXXXXXXXXX", 
            "phone2": "+44YYYYYYYYY", 
            "אימייל": "כתובת דוא"ל", 
            "field1": "field1", 
            "field2": "field2", 
            "crmId": "00000000-00000-00000-00000-0000000001" 
        }
    }, 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-11-29T16:03:23.9251680Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

מחק פריט

Mon, 01 Jan 0001 00:00:00 +0000

מחק פריט #

מוחק פריט קיים מתיקיה.

בקשה #

DELETE /v1.0/contactdirectoryies/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

דוגמה #

בקשה זו תמחק את הפריט הספציפי בתוך התיקיה.

בקשה #

 
מחק <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
הרשאה: נושא {TOKEN}

תגובה #

 
HTTP/1.1 200 OK
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
{  
	"data": { 
        "id": "00000000-0000-0000-0000-00000-000000000123", 
        "שדות": { 
            "כותרת": "מר", 
            "fullName": "CRM3a", 
            "שם חברה": "חברה", 
            "jobTitle": "Job Title", 
            "phone1": "+44XXXXXXXXXXXX", 
            "אימייל": "כתובת דוא"ל", 
            "field1": "field1", 
            "field2": "field2", 
            "crmId": "00000000-00000-00000-00000-0000000001" 
        }
    }, 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-01-01T10:00:00.2890319Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה