{"info":{"_postman_id":"30b5e8fa-113a-488a-8589-8ac4b99adb2c","name":"NSMP JSON-RPC API","description":"

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

\n

Примечание: текущая документация более не обновляется. Актуальная документация модуля JSON-RPC будет публиковаться и обновляться по ссылке https://portal.itsm365.com/docs/jsonrpc/json-rpc-docs/

\n

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

\n

Импортировать коллекцию в Postman можно по кнопке \"Run in Postman\".

\n

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

\n

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

\n

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

\n

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

\n

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

\n
    \n

  1. Перейдите в интерфейс технолога

    \n
    2. \n

  2. Перейдите в раздел \"Администрирование\" -> \"Консоль\"

    \n
    3. \n

  3. Выполните метод генерации ключа доступа. Например:
    return api.auth.getAccessKey('system').uuid

    \n
    4. \n
\n

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

\n

Описание формата запросов

\n

Json-Rpc повторяет и расширяет возможности популярных методов для работы с объектами NSMP API, который описан в документации платформы.

\n

Структура тела одинарного запроса:

\n
{\n    //Версия Json-Rpc\n    \"jsonrpc\": \"2.0\",\n    //Название метода\n    //Доступные методы: get, find, findFirst, count, create, edit, delete\n    \"method\": \"get\",\n    //Json-объект с параметрами для метода, указанного выше\n    //В зависимости от метода параметры отличаются\n    \"params\": {},\n    //Идентификатор запроса\n    //При выполнении нескольких запросов в рамках одного REST-запроса идентификатор\n    //для каждого запроса должен отличаться\n    \"id\": 0\n}\n\n
\n

Структура тела пачки запросов

\n
//Список Json-объектов, каждый из которых является отдельным Json-Rpc запросом\n[\n    {\n        \"jsonrpc\": \"2.0\",\n        \"method\": \"get\",\n        \"params\": {},\n        \"id\": 0\n    },\n    {\n        \"jsonrpc\": \"2.0\",\n        \"method\": \"find\",\n        \"params\": {},\n        \"id\": 1\n    },\n    {\n        \"jsonrpc\": \"2.0\",\n        \"method\": \"create\",\n        \"params\": {},\n        \"id\": 2\n    }\n]\n\n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Как пользоваться руководством","slug":"kak-polzovatsya-rukovodstvom"},{"content":"Описание формата запросов","slug":"opisanie-formata-zaprosov"}],"owner":"23104587","collectionId":"30b5e8fa-113a-488a-8589-8ac4b99adb2c","publishedId":"2s8Ysrwt5W","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-25T09:25:46.000Z"},"item":[{"name":"Структура запросов","item":[{"name":"attachFile","id":"1bc96b6a-bf60-43da-bea7-ceac4d84ed11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"attachFile\",\n \"params\": {\n \"uuid\": \"serviceCall$1234567\",\n \"attrs\": {\n \"name\": \"бизнес_процесс.png\",\n \"relation\" : \"tempFiles\",\n \"contentType\": \"image/png\",\n \"description\": \"схема бизнес-процесса\",\n \"url\": \"https://ссылка_на_изображение.домен\"\n },\n \"view\": [\n \"UUID\"\n ]\n },\n \"id\": 0\n}\n","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Прикрепление файлов к объектам.

\n

Например, когда к заявке (UUID заявки – serviceCall$1234567) нужно прикрепить файл (файл доступен по ссылке https://ссылка_на_изображение.домен либо его содержимое представлено строкой формата Base64) с изображением схемы бизнес-процесса.

\n

Параметры из attrs:
name — название файла;
relation — код атрибута типа \"Файл\", к которому будет прикреплен файл (необязательный параметр - если не указан, файл будет прикреплен к объекту);
contentType — mime-тип файла;
description — описание файла;
url — ссылка на скачивание файла
data – содержимое файла в формате строки Base64 (используется только если не указан параметр url)

\n

Примечание: при указании двух параметров url и data, приоритет имеет data, данные из url в таком случае считываться не будут

\n

Аналог
utils.attachFile(source, fileName, contentType, description, data).UUID

\n

Параметры:
source — объект, к которому прикрепляется файл;
fileName — название файла с расширением;
contentType — mime-тип файла;
description — описание файла;
data (bytes) — содержимое файла

\n

Пример использования аналога:
def firstServiceCall = utils.get('serviceCall$6541304')

\n

def secondServiceCall = utils.get('serviceCall$6541303')

\n

def file = utils.files(firstServiceCall).first()

\n

def data = utils.readFileContent(file)

\n

return utils.attachFile(secondServiceCall, 'бизнес_процесс.png', 'image/png', 'схема бизнес-процесса', data).UUID

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"1bc96b6a-bf60-43da-bea7-ceac4d84ed11"},{"name":"get (UUID)","id":"87b9eecc-bc57-4061-a84e-15164ad0430c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"get\",\n \"params\": {\n //uuid - уникальный идентификатор объекта в системе (атрибут UUID)\n \"uuid\": \"serviceCall$2711402\",\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Получение объекта по уникальному идентификатору (UUID). UUID имеет формат - код_класса$номер_объекта.

\n

Например, serviceCall$2711402, где serviceCall - код класса \"Запрос\".

\n

Аналог utils.get('serviceCall$2711402')

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"87b9eecc-bc57-4061-a84e-15164ad0430c"},{"name":"get (fqn & attributes)","id":"678af8c8-a786-44fd-87c5-d0395b459080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"get\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"number\": \"5\"\n },\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Поиск единственного объекта по коду метакласса и по набору атрибутов. Если в системе есть несколько объектов подходящих под условия, то вернет ошибку. Если объекта не будет найден, запрос вернет null.

\n

Например, если нужно найти объект класса \"Запрос\" со значением атрибута \"Номер\" (код атрибута \"number\") равный 5.

\n

Аналог utils.get('serviceCall', ['number': 5])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"678af8c8-a786-44fd-87c5-d0395b459080"},{"name":"find","id":"d1832cc6-8842-4b21-87c4-3dc53f458ecb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"state\": \"inprogress\"\n },\n //[Опциональный] limit - ограничение на количество возвращаемых объектов\n //Значение по умолчанию - 1000\n \"limit\": 100,\n //[Опциональный] offset - сдвиг c начала списка найденных объектов\n //Значение по умолчанию - 0\n \"offset\": 0,\n \"ignoreCase\" : true,\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Поиск набора объектов удовлетворяющих условию.

\n

Например, если нужно найти объекты класса \"Запрос\" в статусе \"В работе\" (код атрибута \"state\") и с темой (код атрибута \"shortDescr\") \"Не работает wi-fi\".

\n

Параметр \"limit\" в теле запроса отвечает за количество возвращаемых объектов. Если не указан, то вернется до 1000 объектов. Во избежание проблем с производительностью рекомендуется получать объекты небольшими пачками, используя параметр \"offset\".

\n

Параметр \"ignoreCase\" в теле запроса отвечает за то, нужно ли игнорировать регистр при поиске объектов. Если стоит true – поиск для строковых атрибутов происходит без учета регистра, если false или параметр не указан – регистр учитывается

\n

Аналог utils.find('serviceCall', ['state': 'inprogress', 'shortDescr' : 'Не работает wi-fi'], sp.limit(100).offset(0).ignoreCase())

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"d1832cc6-8842-4b21-87c4-3dc53f458ecb"},{"name":"findFirst","id":"f763686e-fde8-45da-ad92-5b010020d76e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"findFirst\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"state\": \"inprogress\"\n },\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Поиск первого попавшегося объекта удовлетворяющего условию.

\n

Например, если нужно найти любой объект класса \"Запрос\" в статусе \"В работе\" (код атрибута \"state\").

\n

Аналог utils.findFirst('serviceCall', ['state': 'inprogress'])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"f763686e-fde8-45da-ad92-5b010020d76e"},{"name":"count","id":"1784edba-5a61-4685-845f-d975735462fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"count\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"state\": \"inprogress\"\n }\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Подсчет количества объектов удовлетворяющих условию.

\n

Например, если нужно посчитать количество объектов класса \"Запрос\" в статусе \"В работе\" (код атрибута \"state\").

\n

Аналог utils.count('serviceCall', ['state': 'inprogress'])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"1784edba-5a61-4685-845f-d975735462fe"},{"name":"create","id":"fb4561cd-1d15-467c-915d-2ea3f1be5d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"create\",\n \"params\": {\n //fqn - код метакласса типа создаваемого объекта\n //Например, serviceCall$request\n \"fqn\": \"serviceCall$request\",\n //attrs - набор атрибутов создаваемого объекта,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"attrs\": {\n \"shortDescr\": \"Тема заявки\",\n \"descriptionRTF\": \"Описание заявки\",\n \"clientOU\": \"ou$2386103\",\n \"clientEmployee\": \"employee$2502201\",\n \"agreement\": \"agreement$605301\",\n \"service\": \"slmService$605005\"\n },\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Создание объекта с указанием значений его атрибутов.

\n

Например, если нужно создать объект класса \"Запрос\" (код класса \"serviceCall\") типа \"Запрос на обслуживание\" (код типа \"request\") с указанием темы, описания, контрагента, соглашения и услуги.

\n

Для указания связи с объектами, например, для соглашения, нужно передать уникальный идентификатор соглашения (например, agreement$605301). Можно также сразу производить поиск нужного объекта с помощью подзапроса \"get (UUID)\". Примеры такого запроса можно найти в папке \"Примеры запросов\" -> \"Создание объекта с поиском и заполнением ссылочных атрибутов\" в этой документации.

\n

Аналог utils.create('serviceCall$request', ['shortDescr': 'Тема заявки', 'descriptionRTF': 'Описание заявки', 'clientOU': 'ou$2386103', 'clientEmployee': 'employee$2502201', 'agreement': 'agreement$605301', 'service': 'slmService$605005'])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"fb4561cd-1d15-467c-915d-2ea3f1be5d37"},{"name":"edit (UUID)","id":"1e3ec48b-6804-42e3-84c7-ae8073ac662e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"edit\",\n \"params\": {\n //uuid - уникальный идентификатор объекта в системе (атрибут UUID)\n \"uuid\": \"serviceCall$2711402\",\n //attrs - набор редактируемых атрибутов объекта,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"attrs\": {\n \"state\": \"resolved\",\n \"resultDescr\": \"Отчёт о решении\"\n },\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

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

\n

Например, если нужно изменить у объекта класса \"Запрос\" статус на \"Решена\" (код нового статуса \"resolved\") и указать значение обязательного атрибута \"Отчет о решении\" (код атрибута \"resultDescr\") в новом статусе.

\n

Аналог utils.edit('serviceCall$2711402', ['state': 'resolved', 'resultDescr': 'Отчёт о решении'])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"1e3ec48b-6804-42e3-84c7-ae8073ac662e"},{"name":"edit (fqn & attributes)","id":"103a3ac2-bd26-43ef-baa3-b43cdc14d46c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"edit\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"number\": \"5\"\n },\n //attrs - набор редактируемых атрибутов объекта,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"attrs\": {\n \"state\": \"resolved\",\n \"resultDescr\": \"Отчёт о решении\"\n },\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Поиск и редактирование единственного объекта с указанием значений редактируемых атрибутов.

\n

Например, если нужно изменить у объекта класса \"Запрос\" с номером 5 статус на \"Решена\" (код нового статуса \"resolved\") и указать значение обязательного атрибута \"Отчет о решении\" (код атрибута \"resultDescr\") в новом статусе.

\n

Аналог utils.edit(utils.get('serviceCall', ['number': 5]), ['state': 'resolved', 'resultDescr': 'Отчёт о решении'])

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"103a3ac2-bd26-43ef-baa3-b43cdc14d46c"},{"name":"delete (UUID)","id":"b49e0ee6-54f7-466a-a03f-b5c5e17e6dc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"delete\",\n \"params\": {\n //uuid - уникальный идентификатор объекта в системе (атрибут UUID)\n \"uuid\": \"serviceCall$2711402\"\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

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

\n

Например, если нужно удалить объект класса \"Запрос\" с уникальным идентификатором serviceCall$2711402.

\n

Аналог utils.delete('serviceCall$2711402')

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"b49e0ee6-54f7-466a-a03f-b5c5e17e6dc9"},{"name":"delete (fqn & attributes)","id":"b4ed3673-fe09-467b-9026-46804adcbf42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"delete\",\n \"params\": {\n //fqn - код метакласса для поиска\n //Например, serviceCall или serviceCall$request\n \"fqn\": \"serviceCall\",\n //query - набор атрибутов, по которым будет производится поиск,\n //где ключ - код атрибута, значение - значение атрибута объекта\n \"query\": {\n \"number\": \"5\"\n }\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Поиск и удаление единственного объекта.

\n

Например, если нужно удалить объект класса \"Запрос\" со значением атрибута \"Номер\" (код атрибута \"number\") равный 5.

\n

Аналог utils.delete(utils.get('serviceCall', ['number': 5]))

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"b4ed3673-fe09-467b-9026-46804adcbf42"}],"id":"77885b1f-1361-4491-8b6b-0b5fe2b466fc","_postman_id":"77885b1f-1361-4491-8b6b-0b5fe2b466fc","description":""},{"name":"Расширенные возможности","item":[{"name":"Возможности view","id":"5de8c3ad-7c26-49a6-97e7-b02efc35935c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"get\",\n \"params\": {\n \"uuid\": \"serviceCall$2715803\",\n //[Опциональный] view - список кодов атрибутов, значения которых вернутся в ответе\n //Значение по умолчанию - UUID\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\",\n //По умолчанию дата в формате yyyy.MM.dd HH:mm:ss\n \"creationDate\",\n //Для ссылочных атрибутов по умолчанию вернется UUID\n \"responsibleEmployee\",\n //Можно вернуть конкретные атрибуты объекта, обернув в Json-объект список этих атрибутов\n {\"responsibleTeam\": [\"UUID\", \"title\"]},\n //И даже так\n {\"agreement\": [\"title\", \"UUID\", {\"services\": [\"title\", \"UUID\", \"removed\"]}]}\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Практически в любом запросе можно дополнительно передать параметр \"view\". В параметре списком перечислены коды атрибутов объектов, которые должны вернуться после выполнения запроса.

\n

Например, нужно получить объект класса \"Запрос\" по его UUID и вернуть значения его атрибутов: название, уникальный идентификатор, статус, дату создания. В этом случае во \"view\" нужно перечислить коды этих атрибутов.

\n

Если нужно вернуть определенный поля связанных с объектом класса \"Запрос\" объектов, то необходимо передать JSON-объект с кодом атрибута и для него в отдельном списке указать коды атрибутов этого объекта, как это продемонстрированно для ответственной команды (responsibleTeam), соглашения (agreement) и вложенных в соглашение услуг (services).

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"5de8c3ad-7c26-49a6-97e7-b02efc35935c"},{"name":"Подзапросы","id":"c3f507ca-73d7-4a85-8c32-fa8b845dd9a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"create\",\n \"params\": {\n //Создаем нового сотрудника\n \"fqn\": \"employee$employee\",\n //Определяем атрибуты в новом объекте\n \"attrs\": {\n \"lastName\": \"Фамилия\",\n \"firstName\": \"Имя\",\n \"login\": \"newLogin\",\n //Находим нужный отдел по названию с помощью подзапроса\n //Сначала указываем код атрибута, который заполняем - parent\n //И передаем JSON-объект, где указываем метод подзапроса и его параметры\n \"parent\": {\n //В данному случае нам нужно получить единственный объект - метод get\n \"method\": \"get\",\n \"params\": {\n //Класс \"Отдел\", тип \"Отдел\"\n \"fqn\": \"ou$ou\",\n //Неархивный с названием \"IT\"\n \"query\": {\n \"title\": \"IT\",\n \"removed\": false\n }\n }\n }\n },\n \"view\": [\n \"UUID\",\n \"number\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Обычно, если необходимо указать значение ссылочного атрибута (ссылка на БО, набор ссылок на БО, элемент справочника, набор элементов справочника, обратная ссылка) в объекте, то необходимо передать уникальный идентификатор или набор уникальных идентификаторов нужных объектов.

\n

Если нам не известны уникальные идентификаторы этих объектов, то мы можем выполнить их поиск с помощью подзапроса. Для этого в атрибут вместо строки с UUID нужно передать JSON-объект в формате:

\n
...\n\"код_атрибута\": {\n    //Код метода подзапроса\n    //Доступны все методы из блока \"Структура запросов\" и \"Расширенный возможности\" -> \"Работа с op методами\"\"\n    \"method\": \"get\",\n    //Параметры метода. Могут быть разные и зависят от метода\n    \"params\": {\n        \"fqn\": \"ou$ou\",\n        \"query\": {\n            \"title\": \"IT\",\n            \"removed\": false\n        }\n    }\n}\n...\n\n
\n

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

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"c3f507ca-73d7-4a85-8c32-fa8b845dd9a4"},{"name":"Работа с op методами","id":"aee3ad26-374f-47e1-96ba-6ac103e5ef9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"serviceCall\",\n \"query\": {\n //С помощью вложенного запроса можно работать с методами op\n //op.isNotNull()\n \"clientEmployee\": {\"method\": \"isNotNull\"},\n //op.isNull()\n \"responsibleEmployee\": {\"method\": \"isNull\"},\n //op.like()\n \"shortDescr\": {\n \"method\": \"like\",\n \"params\": {\n \"args\": [\"%заявки\"]\n }\n },\n //op.orEq()\n \"metaClass\": {\n \"method\": \"orEq\",\n \"params\": {\n \"args\": [\"serviceCall\", \"call\"]\n }\n },\n //op.not()\n \"state\": {\n \"method\": \"not\",\n \"params\": {\n \"args\": [\"closed\"]\n }\n },\n //op.eq()\n \"wayAddressing\": {\n \"method\": \"eq\",\n \"params\": {\n \"args\": [\"wayAdressing$647201\"]\n }\n },\n //op.in()\n \"responsibleTeam\": {\n \"method\": \"in\",\n \"params\": {\n \"args\": [\"team$2493901\", \"team$558101\"]\n }\n },\n //op.between()\n \"creationDate\": {\n \"method\": \"between\",\n \"params\": {\n \"args\": [\"2022.01.01 10:00\", \"2022.12.31 10:00\"]\n }\n },\n //op.gt()\n \"number\": {\n \"method\": \"gt\",\n \"params\": {\n \"args\": [100]\n }\n },\n //op.lt()\n \"dateDecision\": {\n \"method\": \"lt\",\n \"params\": {\n \"args\": [\"2022.08.01\"]\n }\n }\n }\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Условные операции описаны в документации платформы (блок \"Условные операции\")

\n\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"aee3ad26-374f-47e1-96ba-6ac103e5ef9c"},{"name":"Работа со строками","id":"466acfe2-a13e-4271-9f90-55d1cc2a52e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"serviceCall\",\n \"query\": {\n \"state\": \"inprogress\"\n },\n \"limit\": 100,\n \"view\": [\n \"number\",\n {\n \"descriptionRTF\": {\n \"method\": \"htmlToText\",\n \"params\": {\n \"args\": [\n \"descriptionRTF\"\n ]\n }\n }\n }\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Методы работы со строками описаны в документации платформы. В JSON-RPC реализованы на данный момент такие методы:

\n\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"466acfe2-a13e-4271-9f90-55d1cc2a52e7"}],"id":"967c23e2-3d91-4410-bba3-5cc843b4f16c","_postman_id":"967c23e2-3d91-4410-bba3-5cc843b4f16c","description":""},{"name":"Контекстные переменные","item":[{"name":"@ctxUser","id":"cba33035-3b3b-4fdf-9df7-e11a36581505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"serviceCall\",\n \"query\": {\n \"state\": \"registered\",\n \"responsibleEmployee\" : \"@ctxUser\"\n },\n \"limit\": 100,\n \"view\": [\n \"UUID\",\n \"title\",\n \"state\",\n {\"responsibleEmployee\" : [\"title\"]}\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Переменная @ctxUser позволяет обратиться к пользователю, чей ключь используется в запросе. Например, если нужно найти заявки, где пользователь, от чьего имени выполняем действие является ответственным.

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"cba33035-3b3b-4fdf-9df7-e11a36581505"},{"name":"@ctxSubject","id":"18bb5ff5-b927-43bc-b485-30463f162a80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"serviceCall\",\n \"query\": {\n \"tasks\" : {\"method\": \"isNotNull\"}\n },\n \"limit\": 10,\n \"view\": [\n \"number\",\n {\n \"tasks\": {\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"task\",\n \"query\": {\n \"serviceCall\": \"@ctxSubject\",\n \"state\" : \"inprogress\"\n }\n },\n \"view\": [\n \"description\"\n ]\n }\n }\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

В параметре \"view\" можно обратиться к текущему объекту через переменную @ctxSubject. Это может быть полезно, когда нужно получить какие-то объекты, связанные с найденным по сложной логике.

\n

Например, если нужно получить все задачи по текущей заявке в статусе \"В работе\"

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"18bb5ff5-b927-43bc-b485-30463f162a80"}],"id":"9168c77d-a428-4943-aa30-941c9c6a57ec","_postman_id":"9168c77d-a428-4943-aa30-941c9c6a57ec","description":""},{"name":"Примеры запросов","item":[{"name":"Получить все комментарии по заявке","id":"78e580af-4b11-4acf-8751-36c59e4ce7af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"comment\",\n \"query\": {\n \"source\": \"serviceCall$2715803\"\n },\n \"view\": [\n \"UUID\",\n {\"author\": [\"UUID\", \"title\"]},\n \"text\",\n \"creationDate\"\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

Аналог utils.find('comment', ['source': 'serviceCall$2715803'], sp.limit(1000).offset(0))

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"78e580af-4b11-4acf-8751-36c59e4ce7af"},{"name":"Получить все неприватные комментарии по заявке через view","id":"3cb8f8f7-0f1a-4c42-9b5b-2822b1cc3897","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"serviceCall\",\n \"query\": {\n \"state\": \"inprogress\"\n },\n \"limit\": 100,\n \"view\": [\n \"number\",\n {\n \"comments\": {\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"comment\",\n \"query\": {\n \"source\": \"@ctxSubject\",\n \"private\": {\n \"method\": \"in\",\n \"params\": {\n \"args\": [\n false\n ]\n }\n }\n },\n \"limit\": 10\n },\n \"view\": [\n {\n \"text\": {\n \"method\": \"htmlToText\",\n \"params\": {\n \"args\": [\n \"text\"\n ]\n }\n }\n }\n ]\n }\n }\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","description":"

В поле \"view\" можно получить также инфорацию по всем комментариям искомых объектов.

\n","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"3cb8f8f7-0f1a-4c42-9b5b-2822b1cc3897"},{"name":"Создание объекта с поиском и заполнением ссылочных атрибутов","id":"d4fcbae4-bd50-44ff-b11a-32f3aa19a55d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"create\",\n \"params\": {\n //Создаем заявку типа \"Инцидент\"\n \"fqn\": \"serviceCall$serviceCall\",\n //Определяем атрибуты в новом объекте\n \"attrs\": {\n //Указываем соглашения по его уникальному номеру\n \"agreement\": {\n \"method\": \"get\",\n \"params\": {\n \"fqn\": \"agreement\",\n \"query\": {\n \"inventoryNumber\": \"B001\"\n }\n }\n },\n //Указываем услугу по ее уникальному номеру\n \"service\": {\n \"method\": \"get\",\n \"params\": {\n \"fqn\": \"slmService\",\n \"query\": {\n \"inventoryNumber\": \"00\"\n }\n }\n },\n //Ищем неархивный отдел по названию атрибут \"Контрагент (Отдел)\"\n \"clientOU\": {\n \"method\": \"get\",\n \"params\": {\n \"fqn\": \"ou$ou\",\n \"query\": {\n \"title\": \"IT\",\n \"removed\": false\n }\n }\n },\n //Создаем нового пользователя в найденный отдел выше и указываем в заявке\n //Сразу указываем логин, соглашения, ФИО и отдел\n \"clientEmployee\": {\n \"method\": \"create\",\n \"params\": {\n \"fqn\": \"employee$employee\",\n \"attrs\": {\n \"lastName\": \"Тестовый\",\n \"firstName\": \"Тест\",\n \"login\": \"testLogin6\",\n //Можно сразу добавить соглашения для сотрудника, если необходимо\n \"recipientAgreements\": {\n \"method\": \"find\",\n \"params\": {\n \"fqn\": \"agreement\",\n \"query\": {\n \"inventoryNumber\": {\n \"method\": \"in\",\n \"params\": {\n \"args\": [\"B001\", \"B002\"]\n }\n }\n }\n }\n },\n \"parent\": {\n \"method\": \"get\",\n \"params\": {\n \"fqn\": \"ou$ou\",\n \"query\": {\n \"title\": \"IT\",\n \"removed\": false\n }\n }\n }\n }\n }\n },\n //Указываем тему заявки\n \"shortDescr\": \"Тема заявки\"\n },\n \"view\": [\n \"UUID\",\n \"number\",\n {\"clientEmployee\": [\"title\", \"UUID\"]}\n ]\n },\n \"id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/sd/services/rest/exec-post?accessKey=&func=modules.jsonRpc.process¶ms=request,response,user&raw=true","urlObject":{"path":["sd","services","rest","exec-post"],"host":[""],"query":[{"key":"accessKey","value":""},{"key":"func","value":"modules.jsonRpc.process"},{"key":"params","value":"request,response,user"},{"key":"raw","value":"true"}],"variable":[]}},"response":[],"_postman_id":"d4fcbae4-bd50-44ff-b11a-32f3aa19a55d"}],"id":"52be6b3e-776a-4ca8-bfc7-5146cf260294","_postman_id":"52be6b3e-776a-4ca8-bfc7-5146cf260294","description":""}],"event":[{"listen":"prerequest","script":{"id":"2b3bc31d-6ecb-4af9-a2cd-d317ade598f0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3989068d-03d2-46b1-879a-bc847b34be9d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"application","value":"","type":"string"},{"key":"accessKey","value":"","type":"string"}]}