نظرة عامة على العناصر on ~.Dimensions.~

احصل على العناصر

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.

مثال #

سيقوم هذا الطلب بالاستعلام عن جميع العناصر التي تحتوي على حقل هاتف يحتوي على +44XXXXXXXXXXXX

احصل على العنصر

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

احصل على العنصر #

يحصل على عنصر دليل محدد.

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

مثال #

هذا الطلب سيحصل على عنصر محدد من دليل أو معرفه.

طلب #

 
احصل على <https://api.eu.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": [{ 
            "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
            "الحقول": { 
                "العنوان": "السيد", 
                "الاسم الكامل": "CRM2", 
                "اسم الشركة": "الشركة", 
                "مسمى الوظيفة": "مسمى الوظيفة", 
                "phone1": "+44XXXXXXXXXXXXX", 
                "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
                "الحقل1": "الحقل1", 
                "الحقل2": "الحقل2", 
                "crmId": "00000000-00000-0000-0000-000000000001" 
            }
        }
    ][{
            "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

إنشاء عنصر #

ينشئ عنصر دليل جديد في الدليل المرفق.

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

مثال #

هذا الطلب سينشئ عنصرا جديدا في الدليل.

طلب #

 
منشور <https://api.eu.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
نوع المحتوى: application/json
القبول-الرسوم: صحيح
التفويض: حامل {TOKEN}
الاتصال: البقاء على قيد الحياة
{ 
	"الحقول": { 
        "العنوان": "السيد", 
        "الاسم الكامل": "CRM3a", 
        "اسم الشركة": "الشركة", 
        "مسمى الوظيفة": "مسمى الوظيفة", 
        "phone1": "+44XXXXXXXXXXXXX", 
        "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
        "الحقل1": "الحقل1", 
        "الحقل2": "الحقل2", 
        "crmId": "00000000-00000-0000-0000-000000000001" 
    }
}

الرد #

 
تم إنشاء HTTP/1.1 201
نوع المحتوى: application/json; charset=utf-8
مدة المحتوى: xx
الموقع: <https://api.eu.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> 
{ 
	"data": { 
        "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
        "الحقول": { 
            "العنوان": "السيد", 
            "الاسم الكامل": "CRM3a", 
            "اسم الشركة": "الشركة", 
            "مسمى الوظيفة": "مسمى الوظيفة", 
            "phone1": "+44XXXXXXXXXXXXX", 
            "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
            "الحقل1": "الحقل1", 
            "الحقل2": "الحقل2", 
            "crmId": "00000000-00000-0000-0000-000000000001" 
        }
    }, 
	"المكانة": "نجاح", 
	"الطابع الزمني": "2019-11-29T16:03:23.9251680Z" 
}

الأخطاء #

غير مصرح به #

عندما لا يتم توفير الرمز أو غير صالح أو منتهية الصلاحية

 
HTTP/1.1 401 غير مصرح به

استبدال العنصر

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

استبدال العنصر #

يستبدل عنصر الدليل الموجود.

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

مثال #

سيقوم هذا الطلب بتحديث عنصر دليل موجود.

طلب #

 
ضع <https://api.eu.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
نوع المحتوى: application/json
القبول-الرسوم: صحيح
التفويض: حامل {TOKEN}
الاتصال: البقاء على قيد الحياة
{ 
    "الحقول": { 
        "العنوان": "السيد", 
        "الاسم الكامل": "CRM3a", 
        "اسم الشركة": "الشركة", 
        "مسمى الوظيفة": "مسمى الوظيفة", 
        "phone1": "+44XXXXXXXXXXXXX", 
        "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
        "الحقل1": "الحقل1", 
        "الحقل2": "الحقل2", 
        "crmId": "00000000-00000-0000-0000-000000000001" 
    }
}

الرد #

 
تم إنشاء HTTP/1.1 201
نوع المحتوى: application/json; charset=utf-8
مدة المحتوى: xx
الموقع: <https://api.eu.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> 
{ 
	"data": { 
        "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
        "الحقول": { 
            "العنوان": "السيد", 
            "الاسم الكامل": "CRM3a", 
            "اسم الشركة": "الشركة", 
            "مسمى الوظيفة": "مسمى الوظيفة", 
            "phone1": "+44XXXXXXXXXXXXX", 
            "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
            "الحقل1": "الحقل1", 
            "الحقل2": "الحقل2", 
            "crmId": "00000000-00000-0000-0000-000000000001" 
        }
    }, 
	"المكانة": "نجاح", 
	"الطابع الزمني": "2019-11-29T16:03:23.9251680Z" 
}

الأخطاء #

غير مصرح به #

عندما لا يتم توفير الرمز أو غير صالح أو منتهية الصلاحية

 
HTTP/1.1 401 غير مصرح به

عنصر التحديث

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

عنصر التحديث #

يقوم بتحديث مجموعة محددة من خصائص عنصر الدليل. يستخدم هذا تنسيق JSON Patch لأي تغييرات.

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

مثال #

سيضيف هذا الطلب حقل هاتف جديد إلى عنصر دليل موجود.

طلب #

 
التحديث <https://api.eu.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", 
    "قيمة": "+44YYYYYYYYYYYY" 
}

الرد #

 
تم إنشاء HTTP/1.1 201
نوع المحتوى: application/json; charset=utf-8
مدة المحتوى: xx
الموقع: <https://api.eu.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> 
{ 
	"data": { 
        "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
        "الحقول": { 
            "العنوان": "السيد", 
            "الاسم الكامل": "CRM3a", 
            "اسم الشركة": "الشركة", 
            "مسمى الوظيفة": "مسمى الوظيفة", 
            "phone1": "+44XXXXXXXXXXXXX", 
            "phone2": "+44YYYYYYYYYYY", 
            "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
            "الحقل1": "الحقل1", 
            "الحقل2": "الحقل2", 
            "crmId": "00000000-00000-0000-0000-000000000001" 
        }
    }, 
	"المكانة": "نجاح", 
	"الطابع الزمني": "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.eu.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": { 
        "المعرف": "00000000-0000-0000-0000-00000-000000000123", 
        "الحقول": { 
            "العنوان": "السيد", 
            "الاسم الكامل": "CRM3a", 
            "اسم الشركة": "الشركة", 
            "مسمى الوظيفة": "مسمى الوظيفة", 
            "phone1": "+44XXXXXXXXXXXXX", 
            "البريد الإلكتروني": "عنوان البريد الإلكتروني", 
            "الحقل1": "الحقل1", 
            "الحقل2": "الحقل2", 
            "crmId": "00000000-00000-0000-0000-000000000001" 
        }
    }, 
	"المكانة": "نجاح", 
	"الطابع الزمني": "2019-01-01T10:00:00.2890319Z" 
}

الأخطاء #

غير مصرح به #

عندما لا يتم توفير الرمز أو غير صالح أو منتهية الصلاحية

 
HTTP/1.1 401 غير مصرح به