/
contracts / Договоры

contracts / Договоры

Owned by Антон Белопухов (Unlicensed)

Обмен данными по договорам.

contracts/list

Операции со списком элементов справочника “Договоры”

GET

Возвращает список договоров, по указанным параметрам

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

Параметры запроса GET .../list (lkp rest api)

Параметры для отбора

Ссылка

Строка (100)

Внутренний или внешний идентификатор договора

Код

Строка (9)

Код элемента справочника Договоры

Наименование

Строка (150)

Наименование договора (поиск по вхождению строки)

Ответ

Код ответа

Тело

Код ответа

Тело

200

Массив array (lkp rest api)

Элемент массива Договоры / lkp rest api

404

по умолчанию

POST

Создает новые договоры по переданному массиву данных.

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

Тело запроса

Массив. Элемент массива - Договоры / lkp rest api

Ответ

Код ответа

Тело

Код ответа

Тело

200

Массив array (lkp rest api)
Элемент массива Договоры / lkp rest api

contracts/item

Операции с отдельным элементом справочника “Договоры”

GET

Возвращает структуру договора, по указанному идентификатору

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

id

Строка (45)

Внутренний или внешний идентификатор договора

Ответ

Код ответа

Тело

Код ответа

Тело

200

Договоры / lkp rest api

POST

Создает новый договор по переданным данным

Тело запроса

Договоры / lkp rest api

Ответ

Код ответа

Тело

Код ответа

Тело

200

Договоры / lkp rest api

PATCH

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

Тело запроса

Договоры / lkp rest api

Ответ

Код ответа

Тело

Код ответа

Тело

200

Договоры / lkp rest api

DELETE

Выполняет пометку удаления элемента справочника.

Непосредственно удаление файла произойдет при регламентной обработке помеченных в ЛКП.

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

id

Строка

Внутренний или внешний идентификатор договора

deletionmark

Булево

Значение пометки удаления. По умолчанию Истина
Для снятия пометки можно передать Ложь

childitems

Булево

Признак необходимости установки пометки для вложенных элементов

Ответ

В случае успешного выполнения удаления возвращается ответ с кодом 200

contracts/table

Операции с табличными частями отдельного элемента справочника “Договоры”

GET

Возвращает массив строк табличной части по указанным параметрам

Доступные табличные части:

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

id

Строка

Внутренний или внешний идентификатор договора

name

Строка

Имя табличной части

Параметры для отбора

НомерСтроки

Число

Номер строки табличной части

[ИмяРеквизита]

Соответственно типу имени реквизита

В качестве отбора может быть использован любой реквизит табличной части

Ответ

Код ответа

Тело

Код ответа

Тело

200

array (lkp rest api) . Элемент массива - строка табличной части.

 

POST

Создает новую строку табличной части

Доступные табличные части:

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

id

Строка

Внутренний или внешний идентификатор договора

name

Строка

Имя табличной части

Тело запроса

Массив. Элемент массива - строка табличной части:

Ответ

Код ответа

Тело

Код ответа

Тело

200

Массив добавленных строк ТЧ.

PATCH

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

Доступные табличные части:

Параметры запроса

Имя параметра

Тип параметра

Описание

Имя параметра

Тип параметра

Описание

id

Строка

Внутренний или внешний идентификатор договора

name

Строка

Имя табличной части

Тело запроса

Массив. Элемент массива - строка табличной части:

Ответ

Код ответа

Тело

Код ответа

Тело

200

Массив измененных строк ТЧ.

Related content