{"info":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","description":"

Краткое описание REST API ITSM 365 в примерах

\n

Как пользоваться руководством

\n

Вы можете использовать эту коллекцию как обычную документацию, либо импортировать себе в Postman и запускать примеры для своего инстанса ITSM 365.

\n

Настройка адреса сервера

\n

Перейдите на вкладу \"Variables\" в настройках коллекции и добавьте адрес своего сервера в переменной \"server\" в столбец \"CURRENT VALUE\", напримемер: https://your_domain.itsm365.com.

\n

Настройка ключа доступа

\n

Любые запросы, направленные в сторону ITSM 365 должны содержать ключ доступа в query параметрах url. Мы можете добавить свой ключ авторизации в настройках коллекции на вкладке \"Variables\" в столбец \"CURRENT VALUE\".

\n

Как получить ключ доступа

\n
    \n
  1. Откройте интерфейс технолога ITSM 365
    2. \n
  2. Перейдите в раздел \"Администрирование/Консоль\"
    3. \n
  3. return api.auth.getAccessKey('system').uuid
    4. \n
\n

Для настройки работающей интеграции вам потребуется ключ с определенным сроком жизни и другими параметрами. Подробную информацию вы можете получить в документации.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Краткое описание REST API ITSM 365 в примерах","slug":"kratkoe-opisanie-rest-api-itsm-365-v-primerah"}],"owner":"2892713","collectionId":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","publishedId":"TVeqd7ad","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-11-25T12:54:25.000Z"},"item":[{"name":"Стандартные запросы","item":[{"name":"Создание объектов","item":[{"name":"/sd/services/rest/create","id":"da61cdec-7197-4d47-8da7-0365f246f880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Object title\"\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/create/ou$ou","description":"

Назначение

\n

Создать объект

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/create/fqn

\n

Сервис: /sd/services/rest

\n

Метод: /create

\n

Метакласс: /fqn

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","create","ou$ou"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"da61cdec-7197-4d47-8da7-0365f246f880"},{"name":"/sd/services/rest/create","id":"443ff0fe-2acc-49a1-8c06-f24c1ea5336e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/create/ou$ou/{\"title\": \"Название объекта\"}","description":"

Назначение

\n

Создать объект

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/create/fqn

\n

Сервис: /sd/services/rest

\n

Метод: /create

\n

Метакласс: /fqn

\n

Параметры в виде ассоциативного массива: {\"title\": \"Название объекта\"}

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","create","ou$ou","{\"title\": \"Название объекта\"}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"443ff0fe-2acc-49a1-8c06-f24c1ea5336e"},{"name":"/sd/services/rest/create-m2m","id":"c34aa006-ed1f-4a28-a6c4-bfbacf8abf07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Test ou\"\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/create-m2m/ou$ou","description":"

Назначение

\n

Создать объект для межсистемного взаимодействия. Возвращает не только сообщение об успехе, но и параметры созданного объекта согласно ролевой модели доступа.

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/create-m2m/fqn

\n

Сервис: /sd/services/rest

\n

Метод: /create-m2m

\n

Метакласс: /fqn

\n

Результат

\n

Gараметры созданного объекта согласно ролевой модели доступа в формате JSON.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","create-m2m","ou$ou"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c34aa006-ed1f-4a28-a6c4-bfbacf8abf07"}],"id":"efb0c6b2-a6e0-45f6-94b5-1e1f3384f8ed","_postman_id":"efb0c6b2-a6e0-45f6-94b5-1e1f3384f8ed","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}}},{"name":"Редактирование объектов","item":[{"name":"/sd/services/rest/edit","id":"37c41dcd-504d-4ca8-a431-6089c8b3ab57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"New title\"\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/edit/ou$2293304","description":"

Назначение

\n

Изменить объект

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/edit/uuid

\n

Сервис: /sd/services/rest

\n

Метод: /edit

\n

Уникальный идентификатор объекта: /uuid

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","edit","ou$2293304"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"37c41dcd-504d-4ca8-a431-6089c8b3ab57"},{"name":"/sd/services/rest/edit","id":"534e63fb-9b12-4cc6-bf39-e40d928285a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/edit/ou$2293304/{'title':'New ou title'}","description":"

Назначение

\n

Изменить объект

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/edit/uuid/attrs

\n

Сервис: /sd/services/rest

\n

Метод: /edit

\n

Уникальный идентификатор объекта: /uuid

\n

Редактируемые атрибуты: {\"title\": \"Название\"}

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","edit","ou$2293304","{'title':'New ou title'}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"534e63fb-9b12-4cc6-bf39-e40d928285a8"},{"name":"Edit object m2m","id":"c91d6f43-a436-4b2e-8113-4b39fae7783b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Test ou\"\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/edit-m2m/ou$2293304","description":"

Назначение

\n

Редактировать объект в межсистемном взаимодействии. Возвращает не только сообщение об успехе, но и параметры созданного объекта согласно ролевой модели доступа.

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/edit-m2m/uuid

\n

Сервис: /sd/services/rest

\n

Метод: /edit-m2m

\n

Уникальный идентификатор: /uuid

\n

Результат

\n

Параметры созданного объекта согласно ролевой модели доступа в формате JSON.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","edit-m2m","ou$2293304"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c91d6f43-a436-4b2e-8113-4b39fae7783b"}],"id":"a68d0050-07b5-4f54-bcd0-05a3a0486c49","_postman_id":"a68d0050-07b5-4f54-bcd0-05a3a0486c49","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}}},{"name":"Работа с файлами","item":[{"name":"/sd/services/rest/add-file","id":"10312e46-3a99-4bda-a12a-7b5062208c9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"some_unic_key","type":"file","src":"/Users/mdemyanov/Downloads/grinning-face_1f600.png"}]},"url":"/sd/services/rest/add-file/serviceCall$2292802","description":"

Назначение

\n

Добавить файл к объекту

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/add-file/uuid?attrCode=fileAttrCode

\n

Сервис: /sd/services/rest

\n

Метод: /add-file

\n

Уникальный идентификатор объекта: /uuid

\n

Опциональный параметр \"Код атрибута\" (если файл нужно прикрепить в атрибуте): attrCode=fileAttrCode

\n

Примечание

\n

Данные передаются в виде form-data, поэтому в рамках одного запросам можно передать сразу несколько файлов.

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","add-file","serviceCall$2292802"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"10312e46-3a99-4bda-a12a-7b5062208c9f"}],"id":"3261680d-9f9d-46af-8fe3-5ad119d03a38","_postman_id":"3261680d-9f9d-46af-8fe3-5ad119d03a38","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}}},{"name":"/sd/services/rest/get","id":"e574fb12-ad9d-4b22-aec0-1e0221d99a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/get/serviceCall$2292803","description":"

Назначение

\n

Получить объект по уникальному идентификатору

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/get/uuid

\n

Сервис: /sd/services/rest

\n

Метод: /get

\n

Уникальный идентификатор объекта: /uuid

\n

Результат

\n

Параметры созданного объекта согласно ролевой модели доступа в формате JSON.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","get","serviceCall$2292803"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e574fb12-ad9d-4b22-aec0-1e0221d99a88"},{"name":"/sd/services/rest/delete","id":"91779514-4597-49c3-a759-ecb44f7b0e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/delete/serviceCall$2292803","description":"

Назначение

\n

Удалить объект по уникальному идентификатору

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/delete/uuid

\n

Сервис: /sd/services/rest

\n

Метод: /delete

\n

Уникальный идентификатор объекта: /uuid

\n

Результат

\n

Текстовое сообщение с информацией о статусе операции

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","delete","serviceCall$2292803"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"91779514-4597-49c3-a759-ecb44f7b0e4e"},{"name":"/sd/services/rest/find","id":"ddfbfd6a-8e0d-45cd-ac85-ce773832911a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"/sd/services/rest/find/ou/{'title':'Пользователи'}","description":"

Назначение

\n

Найти объекты по параметрам

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/find/fqn/attrs

\n

Сервис: /sd/services/rest

\n

Метод: /find

\n

Метакласс объекта: /fqn

\n

Атрибуты поиска по точному соответствию: {\"title\": \"Название\"}

\n

Результат

\n

Коллекция объектов в формате JSON с учетом ролевой модели.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","find","ou","{'title':'Пользователи'}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ddfbfd6a-8e0d-45cd-ac85-ce773832911a"},{"name":"/sd/services/rest/search/fqn","id":"a954c878-ee77-4351-815d-e0b7cb1fbcec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/search/ou/{'title':'Пользователи'}","description":"

Назначение

\n

Расширенный полнотекстовый поиск объектов

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/search/fqn/attrs

\n

Сервис: /sd/services/rest

\n

Метод: /search

\n

Метакласс объекта: /fqn

\n

Атрибуты поиска: {\"title\": \"Название\"}

\n

Результат

\n

Коллекция уникальных идентификаторов.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","search","ou","{'title':'Пользователи'}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a954c878-ee77-4351-815d-e0b7cb1fbcec"},{"name":"/sd/services/rest/search","id":"816f0654-7177-4031-82d4-89eed24408aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/sd/services/rest/search?term='Пользователи'","description":"

Назначение

\n

Быстрый полнотекстовый поиск объектов

\n

Параметры

\n

Схема: serverAddress/sd/services/rest/search?term='Строка для поиска'

\n

Сервис: /sd/services/rest

\n

Метод: /search

\n

Строка поиска: term='Строка для поиска'

\n

Результат

\n

Коллекция уникальных идентификаторов.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"path":["sd","services","rest","search"],"host":[""],"query":[{"key":"term","value":"'Пользователи'"}],"variable":[]}},"response":[],"_postman_id":"816f0654-7177-4031-82d4-89eed24408aa"},{"name":"New Request","id":"352ded61-793c-488e-bec5-1f60cd0800e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"352ded61-793c-488e-bec5-1f60cd0800e5"}],"id":"814f0358-5d03-4a62-88b1-71a28077d1d3","_postman_id":"814f0358-5d03-4a62-88b1-71a28077d1d3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","id":"5f603256-3b3d-4e80-a93f-bfb3a1de2354","name":"ITSM 365 REST ","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"accessKey"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"559a64e1-8485-413b-928d-49b726a04b1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7981f322-56b1-4b32-bb85-1c7a2432178f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"server","value":""},{"key":"accessKey","value":""}]}