Сравнение API V1 и V3 · ServiceDesk Plus

В этом документе описаны общие различия API V1 и V3, а также изменения атрибутов заявок и их форматов.

Общие различия	V1	V3
Ключи входного JSON и изменения формата	Регистр входных данных не учитывается. [ex : "requester": "Shawn Adams"] Выходные данные всегда в верхнем регистре. [ex : "REQUESTER": "Shawn Adams"]	Строгая проверка регистра ключей: нижний регистр. [ex : "requester": { "id":"4", "name":"Shawn Adams" } ]
INPUT_DATA	Учитывает регистр — верхний	Учитывает регистр — нижний
Ключ специалиста	TECHNICIAN_KEY	TECHNICIAN_KEY (or) AUTHTOKEN
Представление отсутствующего значения	Для полей даты: "-1" или "0". Для остальных полей: "null" или "" — пустая строка. Пример [ "FR_DUETIME": "-1", "RESPONDEDTIME": "0" ]	Используется значение null. Пример: "first_response_due_by_time": null
Представление логического значения	Используется строка "true" или "false".	Используется true или false.
Проверка обязательности и типа данных	Мягкая проверка	Строгая проверка
Формат даты во входных данных	"dd MMM yyyy, HH:mm:ss" Единственный поддерживаемый формат.	Поддерживается только значение Long.

Некоторые различия атрибутов заявок приведены в следующей таблице.

	Различие
Имя поля	v1	V1	V3	v3
Workorderid	"WORKORDERID": "8"	✓	✓	"id": "8",
requester	"REQUESTER": "administrator"	✓	✓	"requester": { "id": "3", "name": "administrator", "email_id": null, "is_vipuser" : true }
created by	"CREATEDBY": "administrator"	✓	✓	"created_by": { "id": "3", "name": "administrator", "email_id": null }
created time	"CREATEDTIME": "1482754093346"	✓	✓	"created_time": { "display_value": "Dec 26, 2016 05:38 PM", "value": "1482754093346" }
due by time	"DUEBYTIME": "1482755700000"	✓	✓	"due_by_time": { "display_value": "Dec 26, 2016 06:05 PM", "value": "1482755700000" }
is_overdue	NA	X	✓	"is_overdue": true,
response due by time	"RESPONSEDUEBYTIME": "1482753960000"	✓	X	NA В V3 обозначается как "first_response_due_by_time"
first_response_due_by_ time	"FR_DUETIME": "1482755400000"	✓	✓	"first_response_due_by_time": { "display_value": "Dec 26, 2016 06:00 PM", "value": "1482755400000" }
is_first_response_overdue	NA	X	✓	"is_first_response_overdue": true
responded time	"RESPONDEDTIME": "1482756527476"	✓	✓	"responded_time": { "display_value": "Dec 26, 2016 06:18 PM", "value": "1482756527476" }
resolvedtime	"RESOLVEDTIME": "1482756700093"	✓	✓	"resolved_time": { "display_value": "Dec 26, 2016 06:21 PM", "value": "1482756700093" }
completedtime	"COMPLETEDTIME": "1482756700093"	✓	✓	"completed_time": { "display_value": "Dec 26, 2016 06:21 PM", "value": "1482756700093" }
shortdescription	"SHORTDESCRIPTION": Router access	✓	X	"short_description": router access Примечание: shortdescription доступно только в операции get_all.
timespentonreq	"TIMESPENTONREQ": "53hrs 38min"	✓	✓	"time_elapsed": { "display_value": "53hrs 38min", "value": "193103767" }
subject		✓	✓	Формат остаётся прежним.
requesttemplate	"REQUESTTEMPLATE": "Request a CRM account"	✓	✓	"template": { "id": "8", "name": "Request a CRM account" }
mode	"MODE": "Phone Call"	✓	✓	"mode": { "id": "1", "name": "Phone Call" }
sla	"SLA": "Low SLA"	✓	✓	"sla": { "id": "4", "name": "Low SLA" }
asset	"ASSET": "mewin10.csez.zoho.com"	✓	✓	"assets": [ { "id": "79", "name": "mewin7.csez.zoho.com" },{ "id": "301", "name": "mewin10.csez.zoho.com" } ],
department	"DEPARTMENT": "Engineering"	✓	✓	"department": { "id": "11", "name": "Engineering", }
editor	"EDITOR": "Heather Graham"	✓	✓	"editor": { "id": "14", "name": "Heather", "email_id": “heather@zohocorp.com" }
editorid	"EDITORID": "6"	✓	✓	В V3 входит в поле editor.
editing_status	"EDITING_STATUS": "1"	✓	✓	"is_editing_completed": false
is_catalog_template	"IS_CATALOG_TEMPLATE": "true"	✓	✓	"is_service_request": true
site	"SITE": "test_refer"	✓	✓	"site": { "id": "2", "name": "test refer" }
isvipuser	"ISVIPUSER": "true"	✓	X	Включается в requester.
service	"SERVICE": "Communication"	✓	✓	"service_category": { "id": "1", "name": "Communication" }
category	"CATEGORY": "Hardware"	✓	✓	"category": { "id": "8", "name": "Hardware" }
subcategory	"SUBCATEGORY": "Desktop Hardware"	✓	✓	"subcategory": { "id": "2", "name": "Desktop Hardware" }
item	"ITEM": "Keyboard",	✓	✓	"item": { "id": "301", "name": "Keyboard" },
technician	"TECHNICIAN": "administrator"	✓	✓	"technician": { "id": "3", "name": "administrator", "email_id": null }
technician_loginname		✓	X	NA
status	"STATUS": "Open"	✓	✓	"status": { "id": "3", "name": "Open" }
priority	"PRIORITY": "Low"	✓	✓	"priority": { "id": "4", "name": "Low" }
level	"LEVEL": "Tier 1"	✓	✓	"level": { "id": "1", "name": "Tier 1" }
impact	"IMPACT": "High"	✓	✓	"impact": { "id": "1", "name": "High" }
urgency	"URGENCY": "High"	✓	✓	"urgency": { "id": "2", "name": "High" }
impactdetails	"IMPACTDETAILS": "test impact details"	✓	✓	"impact_details": "test impact details"
requesttype	"REQUESTTYPE": "Incident"	✓	✓	"request_type": { "id": "1", "name": "Incident" }
appr_statusid	"APPR_STATUSID": "Pending Approval"	✓	X	Информация находится в атрибуте approval_status.
approval_status	APPROVAL_STATUS": "Pending Approval"	✓	✓	"approval_status":{ "id" : "1", "name": "Pending Approval" }
closurecode	"CLOSURECODE": "Success"	✓	✓	В V3 входит в closure_info.
closurecomments	"CLOSURECOMMENTS": "Status Change Comment test"	✓	✓	В V3 входит в closure_info.
closure_info	NA	X	✓	В V3: "closure_info": { "closure_code": { "id": "1", "name": "Success" }, "requester_ack_comments": "comment", "closure_comments": "status change comment", "requester_ack_resolution": true }
fcr	"FCR": "true"	✓	✓	"is_fcr": true
yettoreplycount	"YETTOREPLYCOUNT": "1"	✓	X	NA
group	"GROUP": "Hardware Problems"	✓	✓	"group": { "id": "4", "name": "Hardware Problems" }
description	NA	✓	✓	Формат description одинаков в V1 и V3.
Interestedparty	"INTERESTEDPARTY": "hiju.s@zohocorp.com"	✓	✓	"email_ids_to_notify": [ "hiju.s@zohocorp.com" ]
resource	"resource": { "Software": { "Choose the sofwares to be installed": [ "IDE", "Browser" ], "Request a DID extension resources plain": [ "AErnqrqr!@#@$AD" ], "Request a DID extension resources drop": [ "Microsoft Office Enterprise 2007" ], "Request a DID extension resources simple": [ "Yes" ] } }	✓	✓	В V3 ключ Resources (res_RESOURCE_ID) определяет ресурс, а Question (qstn_TYPE_QUESTION_ID) — конкретный вопрос этого ресурса (res_304). Для текстовых вопросов ключ — qstn_text_309. Для вопросов со списком выбора ключ — qstn_select_309. Для вопросов с флажками ключ — qstn_check_309. Для простых вопросов «Да/Нет» ключ — qstn_simple_309. Вскоре появится возможность получать ключи Resources и Question из самого продукта. "resources": { "res_1203": { "qstn_check_3": [ { "name": "External Harddisk" }, { "name": "CD RW" } ], "qstn_check_304": [ { "name": "Ad Account resources checkbox 2" }, { "name": "Ad Account resources checkbox 1" } ], "qstn_simple_301": { "name": "Yes" }, "qstn_select_302": { "id" : "901", "name": "HP" }, "qstn_select_5": { "name": "Dell" }, "qstn_text_303":{ "value": "Additional space required" } }, "res_1201": { "qstn_check_307": [ { "id": "301", "name": "access point 1", "cost": "0.00" }, { "id": "302", "name": "access point 2", "cost": "0.00" } ] } }
last_update_time	NA	X	✓	В V3: "last_updated_time": { "display_value": "Dec 26, 2016 07:15 PM", "value": "1482759949641" }
attachments	NA	X	✓	В V3: "attachments": [ { "id": "1", "file_name": "sample descrip.txt", "content_url": "/api/v3/attachments/1", "size": "520.45KB" } ]
assigned_time	NA	X	✓	В V3: "assigned_time": { "display_value": "Dec 27, 2016 11:13 AM", "value": "1482817403130" }
resolution	NA	X	✓	В V3: "resolution": { "content": "Attached the details in screenshot", "resolution_attachments": [ { "id": "2", "file_name": "sample description.txt", "content_url": "/api/v3/attachments/2", "size": "520.45KB" } ], "submitted_by": { "id": "4", "name": "administrator", "email_id": null, "is_vipuser": false }, "submitted_on": { "display_value": "Jul 5, 2018 01:27 PM", "value": "1530777475554" } }
is_read	NA	X	✓	В V3: "is_read": true,
is_trashed	NA	X	✓	В V3: "is_trashed": true,
is_reopened	NA	X	✓	В V3: "is_reopened": true,
udf_fields	"test_udf": "Single line field test", "test_pick_udf": "pick2",	✓	✓	В V3 все дополнительные поля объединены в udf_fields и представлены как “udf_TYPE”+columnaliasid. Например, UDF_CHAR1 и UDF_LONG1 представлены как udf_sline_301 и udf_long_302 (columnaliasid) и так далее. Ключ API дополнительного поля отображается в списке дополнительных полей. "udf_fields": { "udf_pick_305": "12", "udf_long_303": "12", "udf_decimal_304": "34.00", "udf_mline_302": "Multi \r\nLine", "udf_multiselect_306": [ "Adam", "Geoffrey", "Abdul", "Jaffer" ], "udf_date_307": { "display_value": "Jul 6, 2018 01:22 PM", "value": "1530863520000" }, "udf_sline_301": "Single Line" }
email_to	NA	X	✓	В V3: "email_to": [ “malt@zohocorp.com", “farooq@sdplinmail.com", “gk@sdplinmail.com" ]
email_cc	NA	X	✓	В V3: "email_cc": [ "jack@sdplinmail.com" ]
on_behalf_of	NA	X	✓	В V3: "on_behalf_of": { "id": "14", "name": "requester_all", "email_id": "Mel.r@zohocorp.com" }
onhold_scheduler	NA	X	✓	"onhold_scheduler": { "scheduled_time": { "display_value": "06/07/2018 01:00 PM", "value": "1530862200000" }, "change_to_status": { "id": "1", "color": "#0066ff", "name": "Open" }, "held_by": { "id": "4", "name": "administrator", "email_id": null, "is_vipuser": false }, "comments": "Waiting for resource" }
linked_to_request	NA	X	✓	"linked_to_request": { "request": { "id": "341", "subject": "Title" }, "link_comments": "Similar Request" }
callback_url	NA	X	✓	"callback_url": "demo.servicedesk.com"
is_shared	NA	X	✓	"is_shared": true
has_dependency	NA	X	✓	"has_dependency": false
has_linked_requests	NA	X	✓	"has_linked_requests": false
has_draft	NA	X	✓	"has_draft": true
has_notes	NA	X	✓	"has_notes": true
has_project	NA	X	✓	"has_project": true
has_problem	NA	X	✓	"has_problem": false
has_attachments	NA	X	✓	"has_attachments": true
has_request_caused_by_change	NA	X	✓	"has_request_caused_by_change": false
has_request_initiated_change	NA	X	✓	"has_request_initiated_change": false
deleted_assets	NA	X	✓	"deleted_assets": [ "mewin1.csez.zoho.com", "mewin2.csez.zoho.com" ]
deleted_on	NA	X	✓	"deleted_on": { "display_value": "Dec 27, 2016 11:32 AM", "value": "1482818539816" }
deleted_by	NA	X	✓	"deleted_by": { "id": "3", "name": "Lyod", "email_id": lyod@zylker.com }