IntraDesk API. Получение списка заявок.
Каждый запрос к IntraDesk API должен содержать токен авторизации в заголовке authorization, см. Статья №1229.
GET https://apigw.intradesk.ru/tasklist/odata/tasks
Параметры запроса:
?$skip=0&$orderby=updatedat%20desc&$top=40&$filter={параметры фильтрации}&$count=true&searchStringMode=fast&excludelifetime=true
$skip - количество заявок которое нужно пропустить, используется для постраничного листания заявок
$orderby - название поля для сортировки
$top - количество заявок которое нужно вернуть, используется для постраничного листания заявок
$filter - используется для фильтрации заявок. "$filter:(contains('_term','автомоат))" для поиска по текстовым полям (подробнее в Статья №2901 )
$count - true - будет подсчитано количество заявок удовлетворяющих запросу
searchStringMode - поиск в номере заявки, названии, описании, доп. полях, названиях файлов, комментариях, содержимом файлов. fast - поиск по не точному совпадению, по основе слова; slow - поиск по точному совпадению
Headers:
content-type: application/json
authorization: Bearer {указываем_токен_доступа}
Response:
Описание ответа:
{
"@odata.count": 1125,
"@odata.countrelation": 1,
"value": [
{
"id": 4453148,
"tasknumber": 1709521,
"customerid": 36,
"status": 346,
"priority": 170,
"name": "Заменить доводчик входной двери 1-ого подъезда",
"description": "Доводчик не выполняет свою работу, дверь хлопает.",
"initiator": 354543,
"executor": 841,
"executorgroup": null,
"creator": 1476,
"createdby": "Кристина В",
"createdat": "2021-03-12T10:18:38.1278410Z",
"updatedat": "2021-03-15T14:59:00.8203220Z",
"updatedby": "Кристина В.",
"service": 210,
"servicename": "Обслуживание дома ул. Пушкина д. 21",
"tasktype": 88,
"evaluation": null,
"evaluationname": null,
"initiatorgroup": 97695,
"resolutiondateplan": "2021-03-15T15:00:00.0000000Z",
"resolutiondatefact": null,
"reactiondateplan": null,
"reactiondatefact": null,
"tags": [],
"servicepath": "209/210/",
"workflow": 76,
"observerlist": [
354543
],
"observergrouplist": [],
"closedat": null,
"notresponsibleexecutors": [],
"notresponsibleexecutorgroups": [],
"additionalfields": {
"data": [
{
"alias": "addfield_kpanch_chisloNumber",
"value": {
"numericvalue": 111,
"boolvalue": null,
"datevalue": null,
"stringvalue": null,
"liststringvalue": null
}
},
{
"alias": "addfield_dop_tekstText",
"value": {
"numericvalue": null,
"boolvalue": null,
"datevalue": null,
"stringvalue": "111",
"liststringvalue": null
}
},
{
"alias": "addfield_dop_strokaString",
"value": {
"numericvalue": null,
"boolvalue": null,
"datevalue": null,
"stringvalue": "111",
"liststringvalue": null
}
},
{
"alias": "addfield_dop_da_netBoolean",
"value": {
"numericvalue": null,
"boolvalue": null,
"datevalue": null,
"stringvalue": null,
"liststringvalue": null
}
},
{
"alias": "addfield_dop_dataDateTime",
"value": {
"numericvalue": null,
"boolvalue": null,
"datevalue": "2021-03-15T15:00:00.0000000Z",
"stringvalue": null,
"liststringvalue": null
}
}
],
"count": 9
},
"lifetime": null,
"servicefullname": "Обслуживание домов > Обслуживание дома ул. Пушкина д. 21",
"isserviceadmin": false,
"servicesettingadminid": 107,
"attachments": "[{"Id":"604b2b0865ce6100010b59b5","Name":"Screenshot-0.png","ContentType":"image/png","Size":43513,"Target":10,"UploadedAt":"2021-03-12T08:49:12.6750000Z","UploadedBy":"Скворцова Светлана"},{"Id":"604b2b0865ce6100010b59b5","Name":"Screenshot-1.png","ContentType":"image/png","Size":43513,"Target":10,"UploadedAt":"2021-03-12T08:49:12.6750000Z","UploadedBy":"Скворцова Светлана"}]",
"weight": 0,
"filledfieldslist": null,
"isreactionexpired": null,
"isresolutionexpired": true,
"_searchhighlights": null,
"sla": 78,
"resolutionleftminutes": null,
"tasknumberpath": "1709521/",
"taskbranchid": "e6345c97-e516-408c-a095-3af5ee5b4e64",
"taskexpenses": null,
"isvisited": true,
"privateattachments": "[]"
},
...
],
"dictionaries": [
{
"id": 88,
"name": "Запрос на обслуживание",
"type": "tasktype",
"isarchived": false
},
{
"id": 174,
"name": "Слесарные работы",
"type": "tags",
"isarchived": false
},
{
"id": 321,
"name": "Слесаря Иванова",
"type": "usergroup",
"isarchived": false
},
{
"id": 5356,
"name": "Петров Василий",
"type": "user",
"isarchived": false
},
{
"id": 866,
"name": "Иванов Иван",
"type": "user",
"isarchived": false
},
...
],
}
Описание ответа:
"value" - массив заявок (описание ниже в разделе "Формат данных заявки")
"dictionaries" - справочник для получения названий статуса, приоритета, сервиса, ... по id статуса, приоритета, сервиса, ... (описание ниже в разделе "Формат данных справочника названий")
Формат данных заявки
"tasknumber" - номер заявки
"status" - id статуса заявки
"priority" - id приоритета заявки
"name" - название заявки
"description" - описание заявки
"initiator" - id заявителя заявки
"executor" - Id исполнителя заявки (ответственный исполнитель)
"executorgroup" - id группы исполнителей
"creator" - id создателя заявки
"updatedat" - дата/время последнего изменения заявки
"service" - id сервиса заявки
"servicename" - название сервиса заявки
"tasktype" - id типа заявки
"initiatorgroup" - id компании заявителя заявки (ответственная группа исполнителей)
"resolutiondateplan" - плановая дата выполнения заявки
"resolutiondatefact" - фактическая дата выполнения заявки
"reactiondateplan" - плановая дата реакции по заявке
"reactiondatefact" - фактическая дата реакции по заявке
"tags" - массив id тегов заявки
"servicepath" - путь сервиса заявки, в котором указаны id родителей сервиса заявки
"workflow" - id БП заявки
"observerlist" - массив id пользователей наблюдателей заявки
"observergrouplist" - массив id групп наблюдателей заявки
"closedat" - дата/время закрытия заявки, когда заявка была переведена в статус с признаком "Статус конечный"
"notresponsibleexecutors" - массив id не ответственных пользователей исполнителей заявки (тех сотрудников, кто ранее был исполнителей на заявке)
"notresponsibleexecutorgroups" - массив id не ответственных групп исполнителей заявки (тех групп сотрудников, которые ранее были исполнителями на заявке)
"additionalfields" - массив дополнительных полей заявки с указанием их значений (описание ниже в разделе "Формат данных дополнительных полей заявки")
"servicefullname" - путь названий сервиса, в которых указано названия родителей сервиса заявки
"isserviceadmin" - true - если авторизованный пользователь является администратором сервиса заявки, false - не является
"servicesettingadminid" - id настройки администраторов сервиса заявки
"attachments" - вложения на заявке (описание ниже в разделе "Формат данных вложений на заявке")
"isreactionexpired" - true - просрочена реакция по заявке
"isresolutionexpired" - true - просрочено выполнение заявки
"sla" - id sla заявки
"resolutionleftminutes" - время которое осталось для выполнения заявки, заполняется когда заявка в статусе с признаком "Требует уточнения", т.о. "замораживается" время оставшееся для выполнения
"tasknumberpath" - путь в дереве заявок
"taskbranchid" - guid дерева заявок, заполнен только у заявок которые являются частью дерева заявок, являются дочерней или родительской заявкой
"taskexpenses" - сумма часов списанных по заявке (рассчитывается если в параметрах запроса указано "$select=taskexpenses")
"isvisited" - true - заявка заполнена пользователем
"privateattachments" - вложения на заявке добавленные с приватным комментарием, формат аналогичен "attachments"
Формат данных дополнительных полей заявки
"alias" - алиас дополнительного поля заявки, для всех дополнительных полей название начинается с "addfield"
"value" - значение дополнительного поля, в зависимости от типа заполнено в:
- "numericvalue" - для числовых значений
- "boolvalue" - для bool значений
- "datevalue" - для дата/время значений
- "stringvalue" - для текстовых значений
- "liststringvalue" - для нескольких значений
Формат данных вложения на заявке
"id" - id файла
"Name" - название файла
"Size" - размер файла
"Target" - 10 - файл использован в тексте комментария или описания, 20 - файл приложен к описанию, 30 - файл приложен к комментарию