Начиная с версии 11200 изменены формат и имена полей API V3 решений (URL начинаются с /api/v3/solutions). Рекомендуем учесть изменения как можно раньше. Поддержка прежней версии прекратится после 30 сентября 2021 года. До этой даты поддерживаются обе версии.
Для получения новой версии добавьте следующий заголовок в API-запрос:
accept : vnd.manageengine.v3+json
Основные различия полей решений:
|
Прежняя версия |
Новая версия |
|
key_words [массив JSON] |
keywords [строка со значениями через запятую] |
|
comment * |
- |
|
public |
is_public |
|
user_groups |
user_group_mapping |
|
view_count |
no_of_hits |
|
- |
is_reviewdate_elapsed |
|
- |
is_expirydate_elapsed |
|
expiry_notified |
is_expiry_notified |
|
review_notified |
is_review_notified |
|
solution_owner |
owner |
|
- |
attachments |
|
"statuscode": "200" |
"status_code": 2000 |
* Поле comment удалено в новой версии API, поскольку comment соответствует полю reasonв решениях, а эти сведения уже фиксируются в истории.
Для полученияистории решения используйте следующий URL:
http://localhost:8080/api/v3/solutions/<solutionid>/history
Ex: http://localhost:8080/api/v3/solutions/1/history
Изменение формата input_data:
|
Прежняя версия |
Новая версия |
|
{ "solutions": { "title": "sample", "description": "sample description", "topic": { "name": "General" } } } |
{ "solution": { "title": "sample", "description": "sample description", "topic": { "name": "General" } } } |
View All Solutions >> Supported values for the filter attribute:
|
Прежняя версия |
Новая версия |
|
Approved |
ApprovedSolutions |
|
Rejected |
RejectedSolutions |
|
Approval Pending |
Approval_Pending |
|
UnApproved |
UnApprovedSolutions |
|
|
ExpiredSolutions |
|
|
AllSolutions |
Пример input_data для просмотра решений с фильтром:
|
Прежняя версия |
Новая версия |
|
{ "list_info": { "row_count": "3", "start_index": "1", "end_index": "2", "sort_field": "topic", "sort_order": "A", "filter": "Approved" } } |
{ "list_info": { "row_count": "3", "start_index": "1", "sort_field": "topic", "sort_order": "A", "filter_by": { "name": "ApprovedSolutions" } } } |
Для получения вложений:
<Server-Host>/api/v3/solutions/<solutionid>/attachments/
Для скачивания вложений:
<Server-Host>/api/v3/solutions/<solutionid>/attachments/<attachment-id>/download
Полное сравнение ответов:
|
Прежний формат ответа: |
Новый формат ответа: |
|
{ "solution": {
"created_time": { "display_value": "Aug 18, 2020 02:30 PM", "value": "1597741248946" },
"has_attachments": true,
"approval_status": { "name": "Approved", "id": "2" }, "review_notified": false,
"expiry_date": { "display_value": ,"Oct 30, 2021 12:00 PM" "value": "1635575400000" }, "description": "<div>gkghk<br /></div>",
"key_words": [ "printer", "problem" ],
"title": "test solution", "solution_owner": [ { "name": "administrator", "id": "4" }, { "name": "tech1", "id": "301" } ],
"created_by": { "email_id": null, "name": "administrator", "is_vipuser": false, "id": "4" },
"expiry_notified": false,
"last_updated_by": { "email_id": null, "name": "administrator", "is_vipuser": false, "id": "4" },
"review_date": { "display_value": "Sep 29, 2021 12:00 PM", "value": "1632897000000" }, "public": true,
"last_updated_time": { "display_value": "Jul 1, 2021 04:43 PM", "value": "1625138005507" } , "topic": { "name": "Hardware", "id": "1" },
"id": "1",
"view_count": "6",
"user_groups": [ { "name": "test1", "id": "1" }, { "name": "user group 2", "id": "2" } ] }
"comment": "Solution Approved Through Save And Approve mode",
},
"response_status": { "messages": [ { "status_code": "200", "type": "success", "message": "Solution details fetched successfully" } ], "status": "success" } }
|
{ "solution": {
"created_time": { "display_value": "Aug 18, 2020 11:20 AM", "value": "1597729800000" },
"has_attachments": true,
"approval_status": { "name": "Approved", "id": "2" },
"is_review_notified": false,
"expiry_date": { "display_value": "Dec 29, 2021 12:00 PM", "value": "1640759400000" },
"description": "<div>gkghk<br /></div>",
"keywords": "printer , skype",
"title": "test solution",
"owner": [ { "email_id": null, "phone": "1234455", "name": "administrator", "mobile": "1234567890", "is_vipuser": false, "id": "4", "department": null }, { "email_id": null, "phone": "925-852-2588", "name": "Shawn Adams", "mobile": null, "is_vipuser": false, "id": "5", "department": null } ] ,
"created_by": { "email_id": null, "name": "administrator", "is_vipuser": false, "id": "4", "department": null },
"is_expiry_notified": false,
"last_updated_by": { "email_id": null, "name": "administrator", "is_vipuser": false, "id": "4", "department": null },
"review_date": { "display_value": "Sep 29, 2021 12:00 PM", "value": "1632897000000" },
"is_public": true,
"last_updated_time": { "display_value": "Aug 18, 2020 05:54 PM", "value": "1597753478443" },
"topic": { "name": "Hardware", "id": "1" },
"id": "1",
"no_of_hits": "6",
"user_group_mapping": [ { "name": "ug1", "id": "1" }, { "name": "ug2", "id": "2" } ] }
"attachments": [ { "content_type": "image/png", "size": { "display_value": "176.99KB", "value": 181246 }, "module": "solution", "name": "Screen Shot 2020-08-18 at 8.51.40 AM.png", "content_url": "/api/v3/solutions/1/attachments/1/dow nload", "id": "1" } ],
"is_reviewdate_elapsed": false, "is_expirydate_elapsed": false,
},
"response_status": {
"status_code": 2000, "status": "success" }
}
|