Вход в систему | Получение токена | URL: api/security/login
Метод: POST
Описание: Авторизация
Входные параметры:
json объект
{ "login": "логин", "password": "пароль" }
Ответ: токен пользователя (Токен пользователя передается в заголовке Authorization) Пример: Получить токен авторизации | Expand |
|---|
| { "id": "c2d06dbc-e251-403c-b7d8-bdf21e6ec5cb", "user": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "name": "admin", "email": "admin@email.test", "item": { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "e3a94bde-0ca9-456f-b338-4465d40389ee", "parentId": "c0857f66-fbfa-448f-a35d-afac00a3a9cb", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "e3a94bde-0ca9-456f-b338-4465d40389ee", "c0857f66-fbfa-448f-a35d-afac00a3a9cb" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "permissionList": null, "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-08-01T11:30:46.202188Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-08-01T11:30:46.202188Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "admin", "sequence": 60, "email": "admin@email.test", "login": "admin" } }, "isActive": true, "isAdmin": true, "groupList": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "e3a94bde-0ca9-456f-b338-4465d40389ee", "c0857f66-fbfa-448f-a35d-afac00a3a9cb", "aab39600-92b4-4c38-a55c-53efac8db9cc", "6ea6149b-5eac-4636-adf1-b01b00b7de4e" ] }, "token": "1TPeDt3ytwMvbfaNcPKXwipGlJrZ990V10JYwAWqndE_", "expires": "2024-10-07T06:34:55.3626915Z", "status": 1, "loginTypeList": [ { "id": "05ef8c8e-f104-4dc0-8887-b97c1475dd7a", "hidden": true }, { "id": "17a6ceda-cc38-416c-9f72-379d978a142f", "hidden": false, "is_two_factor_authentication_enabled": false } ], "requireLoginInactivityTimeoutMinuteCount": 0 } |
|
Все элементы
| Чтение метаданных | URL: api/item/get/{itemId}
Метод: POST
Описание: получить информацию об элементе по ID элемента
Входные параметры:
itemId: Guid - ID элемента списка
Выходные параметры:
json объект:
{
id: Guid - ID элемента
siteId: Guid - ID сайта
listId: Guid - ID списка
parentId: Guid - ID родительского элемента
itemPath: ItemPath - путь до элемента + количество дочерних элементов
сontentTypeId - ID типа контента элемента
fieldValueMap - объект ключ-значение. Ключ - internalName поля, значение - значение этого поля в элементе
} Пример: Получить метаданные элемента с id 6ecc311f-7df7-441d-8618-534392e9d31b | Expand |
|---|
| { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "966e62c5-a803-49a0-a1be-e680d130c481", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "6065b2ae-63e3-44aa-a92d-2d414c30f808", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "6ecc311f-7df7-441d-8618-534392e9d31b", "name": null, "isNew": false, "insertUser": { "id": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Administrator", "image": "ee17dc08-1297-b510-b79b-a530e5439e6c" } }, "insertUserId": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "insertUserName": "Administrator", "insertDate": "2024-09-02T07:18:27.587948Z", "updateUser": { "id": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Administrator", "image": "ee17dc08-1297-b510-b79b-a530e5439e6c" } }, "updateUserId": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "updateUserName": "Administrator", "updateDate": "2024-09-02T07:18:32.140205Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "rst_basic_sample_project.rvt", "project_item_revit_server_url": "RSN://79.143.70.137/EK/test1/rst_basic_sample_project.rvt", "document_status": { "id": "b9d061b1-7ce7-4756-8230-e502cfe3d8d8", "contentTypeId": "2067cdf9-2683-4658-9eef-ae6800802a2f", "fieldValueMap": { "name": "Размещено" } }, "approval_count": 0, "calc_field_test1": "--/rst_basic_sample_project.rvt", "parent_date": " - - ", "file": { "id": "a524fba8-409a-4b13-b12e-3924440d2eb8", "contentTypeId": "587f682a-fbf2-4647-8d91-e2f6460f59bf", "fieldValueMap": { "file_size": 6467584, "upd_date": "2024-09-02T07:18:27.582827Z" } }, "version": { "id": "7c4f3449-5896-45d8-b71e-9cf7b8e94c84", "contentTypeId": "61895e0d-ba2b-48f3-8864-e0d0836c2e53", "fieldValueMap": { "name": "0.1", "version_minor": 1, "version_major": 0 } } } } |
|
Создание/изменение | URL: api/item/update
Метод: POST
Описание: Создать/обновить элемент списка (или массив элементов)
Входные параметры:
multipart/form-data
itemListJson - строка, сериализованный в json массив элементов ItemUpdateRequest
{
list_id: Guid - ID списка, элемент которого нужно создать (обязательное)
content_type_id: Guid - ID типа контента элемента (обязательное при создании элемента).
parent_id: Guid - ID родительского элемента.
...поля типа контента элемента, которые нужно изменить, например:
name: "новое имя"
}
Правила передачи значений
1. Если поле является лукапом, то нужно передать строку с уникальным идентификатором нового значения. Пример:
"document_status":"583ba97b-4688-41cc-a21a-9e4d3f6794b1"
2. Если поле является множественным лукапом, то нужно передать массив строк - уникальных идентификаторов. Пример:
"approval_workflow_initiator":["aab39600-92b4-4c38-a55c-53efac8db9cc","3a9a648b-98a0-43e2-b5bf-b06d0084303a"]
3. Если поле является датой, то нужно передать строку в формате ISO 8601 в UTC. Пример:
"end_date_plan":"2024-01-28T08:40:26.168Z"
4. Если поле является числом, то нужно передать число:
"duration_plan":3
5. Если поле является строкой, то нужно передать строку. Пример:
"name":"План.pdf" Пример: Изменить статус элемента (документа) с id 6ecc311f-7df7-441d-8618-534392e9d31b | Expand |
|---|
| URL: http://my-site.ru/api/item/update ItemListJson: [ { "list_id":"966e62c5-a803-49a0-a1be-e680d130c481", "id":"6ecc311f-7df7-441d-8618-534392e9d31b", "content_type_id":"6065b2ae-63e3-44aa-a92d-2d414c30f808", "parent_id":"966e62c5-a803-49a0-a1be-e680d130c481", "document_status":"22a8669a-9674-4aac-950b-3379df1059bd" }, ] |
| Expand |
|---|
| [ { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "966e62c5-a803-49a0-a1be-e680d130c481", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "6065b2ae-63e3-44aa-a92d-2d414c30f808", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "6ecc311f-7df7-441d-8618-534392e9d31b", "name": null, "isNew": false, "insertUser": { "id": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Administrator", "image": "ee17dc08-1297-b510-b79b-a530e5439e6c" } }, "insertUserId": "12fadb08-5758-20d4-b460-0563cfdaa4bf", "insertUserName": "Administrator", "insertDate": "2024-09-02T07:18:27.587948Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-10-04T06:37:14.025188Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "rst_basic_sample_project.rvt", "project_item_revit_server_url": "RSN://79.143.70.137/EK/test1/rst_basic_sample_project.rvt", "document_status": { "id": "22a8669a-9674-4aac-950b-3379df1059bd", "contentTypeId": "2067cdf9-2683-4658-9eef-ae6800802a2f", "fieldValueMap": { "name": "На корректировке" } }, "approval_count": 0, "calc_field_test1": "--/rst_basic_sample_project.rvt", "parent_date": " - - ", "file": { "id": "a524fba8-409a-4b13-b12e-3924440d2eb8", "contentTypeId": "587f682a-fbf2-4647-8d91-e2f6460f59bf", "fieldValueMap": { "file_size": 6467584, "upd_date": "2024-09-02T07:18:27.582827Z" } }, "version": { "id": "7c4f3449-5896-45d8-b71e-9cf7b8e94c84", "contentTypeId": "61895e0d-ba2b-48f3-8864-e0d0836c2e53", "fieldValueMap": { "name": "0.1", "version_minor": 1, "version_major": 0 } } } } ] |
|
Удаление |
URL: api/item/delete
Метод: POST
Описание: Удалить элемент (массив элементов)
Входные параметры:
itemListJson - строка, сериализованный в json массив элементов
[
{
id : Guid - ID первого удаляемого элемента
},
{
id : Guid - ID второго удаляемого элемента
},
...
]
Примечание: при вызове данного метода элемент перемещается в корзину и может быть восстановлен методом описанным ниже. Для удаления элемента без возможности восстановления требуется вызвать данный метод повторно. Пример: Удалить элемент с id b128f641-7169-419f-b84f-99fc34b51aff
| Expand |
|---|
| ["b128f641-7169-419f-b84f-99fc34b51aff"] |
|
Восстановление из корзины | URL: api/item/restore/{itemId}
Метод: POST
Описание: восстановить ранее удаленный в корзину элемент
Входные параметры:
itemId: Guid - ID элемента списка Пример: Восстановить элемент с id b128f641-7169-419f-b84f-99fc34b51aff |
Установить уникальные права доступа к элементу | URL: api/security/setItemUniquePermission/
Метод: POST Описание: Прервать наследование прав/ установить уникальные права доступа к элементу Входные параметры: Входные параметры:
{
id : Guid - ID элемента, copy_permission: bool (требуется ли скопировать и установить прежние разрешения на элемент) } Пример: Установить уникальные права доступа для элемента с id b128f641-7169-419f-b84f-99fc34b51aff |
Удалить уникальные права доступа к элементу | URL: api/security/removeItemUniquePermission/{itemId}
Метод: POST Описание: Восстановить наследование прав/ Удалить уникальные права доступа к элементу Входные параметры:
itemId - ID элемента Пример: Удалить уникальные права доступа для элемента с id b128f641-7169-419f-b84f-99fc34b51aff |
Назначение прав доступа к элементу пользователю или группе | URL: api/item/update
Метод: POST
Описание: Задать права пользователю на элемент с уникальными правами. Задание прав происходит путем создания элемента «Разрешение пользователя» в списке «Разрывы прав».
Входные параметры:
multipart/form-data
itemListJson - строка, сериализованный в json массив элементов ItemUpdateRequest
{ list_id: Guid - ID списка «Разрывы прав» (обязательное) , content_type_id: Guid – ID типа элемента «Разрешение пользователя» (обязательное), source: Guid - ID элемента, для которого задаются права (обязательное), principal: Guid - ID пользователя или группы (обязательное), permission_level: Guid - ID уровня доступа (обязательное) } Пример: Установить уровень доступа "Изменить" (id 9d29f390-70d9-4598-816a-68035a0d6d9f) для пользователя с id ba2bdc08-f633-5666-94f7-a91901fdf3da к папке с id b128f641-7169-419f-b84f-99fc34b51aff | Expand |
|---|
| URL: http://my-site.ru/api/item/update ItemListJson: [ { "list_id":"ecc16787-6b93-40b9-b563-704d9b090fe8", "content_type_id":"30a13e40-f715-438d-af7e-cc47cf3a5891", "parent_id":"ecc16787-6b93-40b9-b563-704d9b090fe8", "name":"Разрывы прав - Test", "source":"b128f641-7169-419f-b84f-99fc34b51aff", "principal":"ba2bdc08-f633-5666-94f7-a91901fdf3da", "permission_level":"9d29f390-70d9-4598-816a-68035a0d6d9f" } ] |
| Expand |
|---|
| [ { "siteId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "listId": "ecc16787-6b93-40b9-b563-704d9b090fe8", "parentId": "ecc16787-6b93-40b9-b563-704d9b090fe8", "itemPath": { "path": [ "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "ecc16787-6b93-40b9-b563-704d9b090fe8" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "30a13e40-f715-438d-af7e-cc47cf3a5891", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "a67826fc-0cda-45af-b362-0809e02d38ca", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-10-04T07:40:37.065934Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-10-04T07:40:37.065934Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Разрывы прав - Test", "principal": { "id": "ba2bdc08-f633-5666-94f7-a91901fdf3da", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Мисюра Дмитрий" } }, "source": "b128f641-7169-419f-b84f-99fc34b51aff", "permission_level": { "id": "9d29f390-70d9-4598-816a-68035a0d6d9f", "contentTypeId": "363859fc-2bea-47ff-958d-9949779191f5", "fieldValueMap": { "name": "Изменить" } } } } ] |
|
Получить список прав текущего пользователя на элемент | URL: api/security/getItemPermissionList/{itemId}
Метод: POST Описание: Получить список элементарных прав пользователя на заданный элемент Входные параметры: itemId - ID элемента Пример: Получить список прав текущего пользователя на элемент с id 2bf2db08-c99d-716f-8cee-7028ebb8afe9 | Expand |
|---|
| ["read","create","download","update","delete"] |
|
Списки | Чтение метаданных | URL: api/list/get/{listId} Метод: POST Описание: получить информацию о списке по ID списка Входные параметры: listId: Guid - ID списка Выходные параметры: json объект List { id: Guid - ID списка name: string - Название списка description: string - описание списка } Пример: Получить метаданные списка "Пользователи" (id e3a94bde-0ca9-456f-b338-4465d40389ee) | Expand |
|---|
| { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "databaseTableName": "principal", "description": "Пользователи", "data": "{\n\t\"isTreeEnabled\": true,\n\t\"refreshMode\": \"none\"\n}", "isHidden": false, "isDocumentArchive": false, "id": "e3a94bde-0ca9-456f-b338-4465d40389ee", "name": "Пользователи", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-09-02T11:25:14.758643Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "isTreeEnabled": true, "refreshMode": "none" } } |
|
Элементы списка
| URL: api/item/getList/{parentId}
Метод: POST
Описание: получить информацию о всех дочерних элементах по ID родительского элемента
Входные параметры:
parentId - ID родительского элемента (ID списка или ID папки внутри списка)
Выходные параметры:
json объект Пример: Получить данные об элементах списка "Пользователи" (id e3a94bde-0ca9-456f-b338-4465d40389ee) | Expand |
|---|
| [ { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "e3a94bde-0ca9-456f-b338-4465d40389ee", "parentId": "e3a94bde-0ca9-456f-b338-4465d40389ee", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "e3a94bde-0ca9-456f-b338-4465d40389ee" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 3 }, "contentTypeId": "733af6e2-e187-4e75-8a2b-ae4072f402e0", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "e873dc08-6b36-669f-98bc-54161b14b08a", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-05-14T07:33:56.65254Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-05-14T07:33:56.65254Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "sequence": 560, "name": "ООО \"Проектировщики\"" } }, { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "e3a94bde-0ca9-456f-b338-4465d40389ee", "parentId": "e3a94bde-0ca9-456f-b338-4465d40389ee", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "e3a94bde-0ca9-456f-b338-4465d40389ee" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 1 }, "contentTypeId": "733af6e2-e187-4e75-8a2b-ae4072f402e0", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "d8059186-c988-4633-90ee-864073d8252b", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-08-01T07:32:17.006529Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-08-01T07:32:17.006529Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "sequence": 820, "name": "ПИР-1.08.24" } }, ] |
|
URL: api/item/getRecursive/{parentId}
Метод: POST
Описание: рекурсивно получить информацию о всех дочерних элементах по ID родительского элемента (дочерние элементы + их дочерние элементы и т.д.)
Входные параметры:
parentId - ID родительского элемента (ID списка или ID папки внутри списка)
Выходные параметры:
json объект Пример: Получить список всех дочерних элементов для папки с id 4a862423-20fe-4798-b013-1ea0471d6552 и их дочерних элементов | Expand |
|---|
| [ { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "966e62c5-a803-49a0-a1be-e680d130c481", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481" ], "scopeId": "4a862423-20fe-4798-b013-1ea0471d6552", "childCount": 2 }, "contentTypeId": "09ad2c16-6047-4dfb-8274-6c4a5f1edbe5", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "4a862423-20fe-4798-b013-1ea0471d6552", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-07-03T10:53:22.960485Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-07-03T10:55:04.151855Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "00_проверка прав на фг" } }, { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "4a862423-20fe-4798-b013-1ea0471d6552", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481", "4a862423-20fe-4798-b013-1ea0471d6552" ], "scopeId": "4a862423-20fe-4798-b013-1ea0471d6552", "childCount": 1 }, "contentTypeId": "09ad2c16-6047-4dfb-8274-6c4a5f1edbe5", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "52c15625-baf1-40ef-83c6-c47a5f520cea", "name": null, "isNew": false, "insertUser": { "id": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Левитин Андрей" } }, "insertUserId": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "insertUserName": "Левитин Андрей", "insertDate": "2024-07-03T10:56:19.905178Z", "updateUser": { "id": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Левитин Андрей" } }, "updateUserId": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "updateUserName": "Левитин Андрей", "updateDate": "2024-07-03T10:56:19.905178Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "123" } }, { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "52c15625-baf1-40ef-83c6-c47a5f520cea", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481", "4a862423-20fe-4798-b013-1ea0471d6552", "52c15625-baf1-40ef-83c6-c47a5f520cea" ], "scopeId": "4a862423-20fe-4798-b013-1ea0471d6552", "childCount": 0 }, "contentTypeId": "09ad2c16-6047-4dfb-8274-6c4a5f1edbe5", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "b128f641-7169-419f-b84f-99fc34b51aff", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-10-04T06:43:30.960319Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-10-04T06:46:35.554054Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Test", "sequence": 1050 } } ] |
|
URL: api/lookup/GetList/{fieldId}
Метод: POST
Описание: получить информацию об элементах списка на который ссылается lookup-атрибут по ID этого атрибута
Входные параметры:
fieldId - ID lookup-атрибута
Выходные параметры:
json объект Пример: Получить перечень элементов списка на который ссылается атрибут "Важность" (id атрибута 8abf69f6-52fd-46b3-b6e3-f2b3af46d151) | Expand |
|---|
| { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "parentId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "eafdcb20-d5b1-4893-8a2a-b94520d36a77" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "9d77cfc4-930b-4e29-b041-15e72c146788", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Высокая", "sequence": 10, "item_id": 1 } }, { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "parentId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "eafdcb20-d5b1-4893-8a2a-b94520d36a77" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "14c58a82-372f-4869-b4a0-43bc0a677882", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Низкая", "sequence": 30, "item_id": 3 } }, { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "parentId": "eafdcb20-d5b1-4893-8a2a-b94520d36a77", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "eafdcb20-d5b1-4893-8a2a-b94520d36a77" ], "scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "childCount": 0 }, "contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "34ba677c-bd32-4322-a47e-28add7e09a85", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Обычная", "sequence": 20, "item_id": 2 } } |
|
Типы элементов списка | URL: api/contenttype/getByList/{listId} Метод: POST Описание: получить информацию о типах контента списка по ID списка Входные параметры: listId: Guid - ID списка Выходные параметры: json объект ContentType[] - массив типов контента списка ContentType { id: Guid - ID типа контента name: string - Название типа контента description: string - описание типа контента isFolder: boolean - могут ли элементы этого типа контента содержать в себе дочерние элементы fieldList: Field[] - массив полей, которые привязаны к типу контента } Пример: Получить типы элементов списка "Пользователи" (id e3a94bde-0ca9-456f-b338-4465d40389ee) | Expand |
|---|
| [ { "description": "Функциональная группа", "parentId": "e1a0f60e-cafb-459f-aa14-721d9190e9d2", "isFolder": false, "isFile": false, "image": "7585a798-cb8a-439e-a306-b06e0073db6d", "fieldList": [ { "internalName": "name", "description": "Название", "fieldTypeId": "f1e86fdc-58b8-eb11-bfe3-00155d013401", "fieldType": { "dbType": "VARCHAR(255)", "dotNetTypeName": "System.String", "reactComponent": "Input", "id": "f1e86fdc-58b8-eb11-bfe3-00155d013401", "name": "String", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": {} }, "isRequired": true, "isVisible": false, "isReadOnly": false, "component": null, "id": "0d284b2f-5d1c-ed11-8015-00155d013401", "name": "Название", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "hidden": false } }, ……… ], "viewId": "5895263d-fb23-4e9a-b7c0-199999421bd4", "parentContentTypeIdList": [ "e1a0f60e-cafb-459f-aa14-721d9190e9d2" ], "id": "274e0738-d9ff-4482-84df-7b845d47fd8b", "name": "Функциональная группа", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": {} }, { "description": "Подразделение", "parentId": "e1a0f60e-cafb-459f-aa14-721d9190e9d2", "isFolder": true, "isFile": false, "image": "31e99b39-fc33-4f3e-9974-b06e0073db6d", "fieldList": [ { "internalName": "name", "description": "Название", "fieldTypeId": "f1e86fdc-58b8-eb11-bfe3-00155d013401", "fieldType": { "dbType": "VARCHAR(255)", "dotNetTypeName": "System.String", "reactComponent": "Input", "id": "f1e86fdc-58b8-eb11-bfe3-00155d013401", "name": "String", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": {} }, "isRequired": true, "isVisible": false, "isReadOnly": false, "component": null, "id": "0d284b2f-5d1c-ed11-8015-00155d013401", "name": "Название", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "hidden": false } }, ……… ], "viewId": "a9aa69be-fd08-435d-8df1-01248294d709", "parentContentTypeIdList": [ "e1a0f60e-cafb-459f-aa14-721d9190e9d2" ], "id": "733af6e2-e187-4e75-8a2b-ae4072f402e0", "name": "Подразделение", "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2023-11-30T07:02:44.776582Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2023-11-30T07:02:44.776582Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": {} } ] |
|
Папки / элементы | Перемещение | URL: api/item/move/{itemId}/{toItemId}/{moveItemType}
Метод: POST
Описание: Переместить элемент
Входные параметры:
itemId - ID перемещаемого элемента
toItemId - ID элемента назначения
moveItemType - тип перемещения:
1 - выше элемента назначения
2 - в конец дочерних элементов элемента назначения
3 - ниже элемента назначения
Пример: Переместить папку с id b128f641-7169-419f-b84f-99fc34b51aff в папку с id 4a862423-20fe-4798-b013-1ea0471d6552 | Expand |
|---|
| { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "4a862423-20fe-4798-b013-1ea0471d6552", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481", "4a862423-20fe-4798-b013-1ea0471d6552" ], "scopeId": "4a862423-20fe-4798-b013-1ea0471d6552", "childCount": 0 }, "contentTypeId": "09ad2c16-6047-4dfb-8274-6c4a5f1edbe5", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "b128f641-7169-419f-b84f-99fc34b51aff", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-10-04T06:43:30.960319Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-10-04T09:48:20.166882Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Test", "sequence": 1050 } } |
|
| Копирование | URL: api/item/move/{toItemId}
Метод: POST
Описание: Скопировать элементы Входные параметры: toItemId - ID родительского элемента, в который выполняется копирование.
Тело запроса: json объект, массив элементов, которые нужно скопировать: | Code Block |
|---|
| [
{
"id": "id первого элемента, который нужно скопировать",
"isChildListCopyRequired": true/false нужно ли копировать дочерние элементы
},
{
"id": "id второго элемента, который нужно скопировать",
"isChildListCopyRequired": true/false нужно ли копировать дочерние элементы
},
...
] |
Пример:- Скопировать папку с ID "ID 1cdc3a56-a733-4b19-b8a0-c1cbfd6fdfdb" и все ее дочерние элементы внутрь папки c ID "2153dc08-2630-ea0c-acb3-daeb5db6e595"
2. Скопировать только папку элемент с ID "ID 1cdc3a56-a733-4b19-b8a0-c1cbfd6fdfdb" без ее дочерних элементов внутрь папки c ID "ID 2153dc08-2630-ea0c-acb3-daeb5db6e595" |
Файлы
| Создание | URL: api/item/update
Метод: POST
Описание: Создать/обновить элемент списка (или массив элементов)
Входные параметры:
multipart/form-data
itemListJson - строка, сериализованный в json массив элементов ItemUpdateRequest
fileList - двоичные данные - массив файлов (экземпляр File)
{
id: Guid - ID обновляемого элемента. Если создается новый элемент, то это поле не указывается (не обязательное)
list_id: Guid - ID списка, элемент которого нужно обновить (обязательное)
content_type_id: Guid - ID типа контента элемента. Указывается только при создании или при изменении типа контента существующего элемента (не обязательное)
parent_id: Guid - ID типа родительского элемента. Указывается только при создании или при изменении родителя существующего элемента (не обязательное)
file: int - ID тела файла, индекс из массива fileList . Указывается только при добавлении тела файла или при изменении тела существующего файла (не обязательное)
...поля типа контента элемента, которые нужно изменить, например:
name: "новое имя"
} Пример: Загрузить файл список "Файлы" (id: 966e62c5-a803-49a0-a1be-e680d130c481) в папку с id 0b19b8bb-db6c-4057-9fdd-b79c2a0262e4 | Expand |
|---|
| URL: http://my-site.ru/api/item/update itemListJson: [ { "list_id":"966e62c5-a803-49a0-a1be-e680d130c481", "content_type_id":"6065b2ae-63e3-44aa-a92d-2d414c30f808", "parent_id":"0b19b8bb-db6c-4057-9fdd-b79c2a0262e4", "name":"Пример ответа.xml","file":0 } ] fileList: (binary) |
| Expand |
|---|
| [ { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "966e62c5-a803-49a0-a1be-e680d130c481", "parentId": "0b19b8bb-db6c-4057-9fdd-b79c2a0262e4", "itemPath": { "path": [ "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "966e62c5-a803-49a0-a1be-e680d130c481", "c7196d6a-9918-4e14-a8bb-25eab2020524", "0b19b8bb-db6c-4057-9fdd-b79c2a0262e4" ], "scopeId": "4a862423-20fe-4798-b013-1ea0471d6552", "childCount": 0 }, "contentTypeId": "6065b2ae-63e3-44aa-a92d-2d414c30f808", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "8764e7a0-9a51-456b-81fe-9145345e17da", "name": null, "isNew": false, "insertUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "insertUserName": "admin", "insertDate": "2024-10-04T10:01:03.145883Z", "updateUser": { "id": "aab39600-92b4-4c38-a55c-53efac8db9cc", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "admin", "image": "ee17dc08-4e9e-2c7d-99b7-db3c3e1fa4ac" } }, "updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc", "updateUserName": "admin", "updateDate": "2024-10-04T10:01:03.145883Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "name": "Тестовый документ.docx", "document_status": { "id": "b9d061b1-7ce7-4756-8230-e502cfe3d8d8", "contentTypeId": "2067cdf9-2683-4658-9eef-ae6800802a2f", "fieldValueMap": { "name": "Размещено" } }, "approval_count": 0, "calc_field_test1": "--/Пример ответа.xml", "sequence": 1070, "file": { "id": "a3c65fbd-4e44-408d-91e7-fe5e6e6ad586", "contentTypeId": "587f682a-fbf2-4647-8d91-e2f6460f59bf", "fieldValueMap": { "file_size": 6675, "upd_date": "2024-10-04T10:01:03.137597Z" } }, "version": { "id": "b19601ab-a272-4db1-9ba4-332cc133cd1c", "contentTypeId": "61895e0d-ba2b-48f3-8864-e0d0836c2e53", "fieldValueMap": { "name": "0.1", "version_minor": 1, "version_major": 0 } } } } ] |
|
Получить список версий файла | URL: api/fileversion/get/{sourceId} Метод: GET Описание: получить список версий файла по ID файла Входные параметры: sourceId: Guid - ID элемента/файла Выходные параметры: массив – список версий файла Пример: Получить список версий файла с id 5bca4c6f-b7f6-47c8-974a-62d1622faf7e | Expand |
|---|
| [ { "siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "listId": "2c269439-6848-4b3d-a7ad-4d55f1b9e499", "parentId": "2c269439-6848-4b3d-a7ad-4d55f1b9e499", "itemPath": { "path": [ "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "2c269439-6848-4b3d-a7ad-4d55f1b9e499" ], "scopeId": "2c269439-6848-4b3d-a7ad-4d55f1b9e499", "childCount": 0 }, "contentTypeId": "61895e0d-ba2b-48f3-8864-e0d0836c2e53", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "85945d0b-72fa-421c-b772-9ac10dc13652", "name": null, "isNew": false, "insertUser": { "id": "ba2bdc08-f633-5666-94f7-a91901fdf3da", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Мисюра Дмитрий" } }, "insertUserId": "ba2bdc08-f633-5666-94f7-a91901fdf3da", "insertUserName": "Мисюра Дмитрий", "insertDate": "2024-08-21T10:15:41.463385Z", "updateUser": { "id": "ba2bdc08-f633-5666-94f7-a91901fdf3da", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Мисюра Дмитрий" } }, "updateUserId": "ba2bdc08-f633-5666-94f7-a91901fdf3da", "updateUserName": "Мисюра Дмитрий", "updateDate": "2024-08-21T10:15:41.463385Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "source_id": "5bca4c6f-b7f6-47c8-974a-62d1622faf7e", "source_list_id": "966e62c5-a803-49a0-a1be-e680d130c481", "source_site_id": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b", "version_minor": 1, "version_major": 0, "file": { "id": "eabad87c-4329-495f-bc25-3454c909afae", "contentTypeId": "587f682a-fbf2-4647-8d91-e2f6460f59bf", "fieldValueMap": { "file_size": 714488, "upd_date": "2024-08-21T10:15:42.956058Z" } }, "name": "0.1" } } ] |
|
Скачивание файла | URL: api/file/getbyitemid/{itemId}/{version}
Метод: GET
Описание: получить файл по ID элемента/файла
Входные параметры:
itemId: Guid - ID элемента/файла version: имя версии файла (0.1, 1.0, 1.1, …)
Выходные параметры: тело файла с добавленным номером версии в конуе имени файла. Пример: Скачать версию 0.1 файла с id 7efc4818-5e79-41ea-86d8-cf9bbcb3269c |
Бизнес-процессы | Создание бизнес-процесса | URL: api/item/update
Метод: POST
Описание: Создать/обновить бизнес-процесс
Входные параметры:
multipart/form-data
itemListJson - строка, сериализованный в json массив элементов ItemUpdateRequest
{ list_id: Guid – ID списка «Процессы», content_type_id: Guid – ID типа элемента запускаемого процесса, name: Наименование создаваемого процесса, start_date_plan:дата и время запуска процесса в формате "YYYY-MM-DDThh:mm:ss[.f{1,7}]<TZDSuffix>", importance: Guid – ID уровня важности процесса из списка «Важность», workflow_template: Guid – ID шаблона проесса из списка «Шаблоны процессов», ... … (поля типа контента процесса, которые нужно изменить), reference_list: список вложений рабочего процесса [ { content_type_id: Guid – ID типа элемента «Вложение рабочего процесса» из списка «Типы контента», destination: Guid – ID элемента, вкладываемого в процесс }, ] } Пример: Создать бизнес-процесс согласования (id типа процесса b3d71386-28c7-4e13-aab8-f11a65d69dd6) с одним этапом, в качестве исполнителя указать едиснтвенного пользователя с id aab39600-92b4-4c38-a55c-53efac8db9cc, продолжительность этапа задать в 1 час, вложение в процесс - документс id 56fc1764-06ef-4bbc-ada2-88d16b4aa736 | Expand |
|---|
| URL: http://my-site.ru/api/item/update itemListJson: [ { "list_id":"c63507f9-c892-4685-92e4-97b787199422", "content_type_id":"b3d71386-28c7-4e13-aab8-f11a65d69dd6", "parent_id":"c63507f9-c892-4685-92e4-97b787199422", "name":"Согласовать /TEST","start_date_plan":"2024-10-07T10:40:21.1307321Z", "importance":"34ba677c-bd32-4322-a47e-28add7e09a85", "initiator":"aab39600-92b4-4c38-a55c-53efac8db9cc", "workflow_status":"e5ac8947-7a27-4a12-8e88-09c297377890", "approval_user_list_1":[], "approval_user_list_2":[], "approval_user_list_final":["aab39600-92b4-4c38-a55c-53efac8db9cc"], "duration_plan_stage_final":1, "reference_list": [ { "content_type_id":"9ea7ecc3-0886-4b4b-9e40-b0a957d689dd", "destination":"56fc1764-06ef-4bbc-ada2-88d16b4aa736" } ] } ] |
| Expand |
|---|
| [
{
"siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b",
"listId": "c63507f9-c892-4685-92e4-97b787199422",
"parentId": "c63507f9-c892-4685-92e4-97b787199422",
"itemPath": {
"path": [
"3064dc08-2e02-8de4-aa70-1b2ae9eb890b",
"c63507f9-c892-4685-92e4-97b787199422"
],
"scopeId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205",
"childCount": 0
},
"contentTypeId": "b3d71386-28c7-4e13-aab8-f11a65d69dd6",
"permissionList": [
"read",
"create",
"download",
"update",
"delete"
],
"id": "bf9ffbae-f773-4f63-af15-38b17036ec36",
"name": null,
"isNew": false,
"insertUser": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"insertUserName": "admin",
"insertDate": "2024-10-07T10:40:32.023427Z",
"updateUser": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"updateUserName": "admin",
"updateDate": "2024-10-07T10:40:32.023427Z",
"deleteUser": null,
"deleteUserId": "00000000-0000-0000-0000-000000000000",
"deleteUserName": null,
"deleteDate": null,
"status": 1,
"fieldValueMap": {
"approval_user_list_1": [],
"approval_user_list_2": [],
"approval_user_list_final": [
{
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
}
],
"name": "Согласовать /TEST",
"sequence": 780,
"item_id": 78,
"start_date_plan": "2024-10-07T10:40:21.130732Z",
"importance": {
"id": "34ba677c-bd32-4322-a47e-28add7e09a85",
"contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79",
"fieldValueMap": {
"name": "Обычная"
}
},
"initiator": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"workflow_status": {
"id": "e5ac8947-7a27-4a12-8e88-09c297377890",
"contentTypeId": "dbcfff84-772e-4682-bd51-496369b43f2f",
"fieldValueMap": {
"name": "Не начат"
}
},
"approval_user_list_1_lookup": [],
"approval_user_list_2_lookup": [],
"approval_user_list_final_lookup": [
"aab39600-92b4-4c38-a55c-53efac8db9cc"
],
"duration_plan_stage_final": 1
}
}
] |
|
Запуск бизнес-процесса | URL: workflow/api/workflow/start/{processId} Метод: POST
Описание: Запустить бизнес-процесс Входные параметры:
processId - Guid – ID запускаемого процесса Пример: Запустить созданный в предыдущем примере процесс с id bf9ffbae-f773-4f63-af15-38b17036ec36 | Expand |
|---|
| {
"siteId": "3064dc08-2e02-8de4-aa70-1b2ae9eb890b",
"listId": "c63507f9-c892-4685-92e4-97b787199422",
"parentId": "c63507f9-c892-4685-92e4-97b787199422",
"itemPath": {
"path": [
"3064dc08-2e02-8de4-aa70-1b2ae9eb890b",
"c63507f9-c892-4685-92e4-97b787199422"
],
"scopeId": "bf9ffbae-f773-4f63-af15-38b17036ec36",
"childCount": 0
},
"contentTypeId": "b3d71386-28c7-4e13-aab8-f11a65d69dd6",
"permissionList": [
"read",
"create",
"download",
"update",
"delete"
],
"id": "bf9ffbae-f773-4f63-af15-38b17036ec36",
"name": null,
"isNew": false,
"insertUser": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"insertUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"insertUserName": "admin",
"insertDate": "2024-10-07T10:40:32.023427Z",
"updateUser": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"updateUserId": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"updateUserName": "admin",
"updateDate": "2024-10-07T10:40:35.008649Z",
"deleteUser": null,
"deleteUserId": "00000000-0000-0000-0000-000000000000",
"deleteUserName": null,
"deleteDate": null,
"status": 1,
"fieldValueMap": {
"approval_user_list_1": [],
"approval_user_list_2": [],
"approval_user_list_final": [
{
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
}
],
"name": "Согласовать /TEST",
"sequence": 780,
"item_id": 78,
"start_date_plan": "2024-10-07T10:40:21.130732Z",
"start_date_fact": "2024-10-07T00:00:00Z",
"end_date_plan": "2024-10-07T00:00:00Z",
"importance": {
"id": "34ba677c-bd32-4322-a47e-28add7e09a85",
"contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79",
"fieldValueMap": {
"name": "Обычная"
}
},
"initiator": {
"id": "aab39600-92b4-4c38-a55c-53efac8db9cc",
"contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45",
"fieldValueMap": {
"name": "admin"
}
},
"workflow_status": {
"id": "e4334055-7f27-4aa4-8de7-bde7e77b330e",
"contentTypeId": "dbcfff84-772e-4682-bd51-496369b43f2f",
"fieldValueMap": {
"name": "Утверждающие"
}
},
"workflow_route": {
"id": "4c4d2875-be96-49c9-915f-bb92b7fa27c0",
"contentTypeId": "8698be63-2959-46e1-b511-3dd379c0b194",
"fieldValueMap": {
"name": "Согласовать /TEST"
}
},
"approval_user_list_1_lookup": [],
"approval_user_list_2_lookup": [],
"approval_user_list_final_lookup": [
"aab39600-92b4-4c38-a55c-53efac8db9cc"
],
"duration_plan_stage_final": 1
}
} |
|
Связи | Получить список связей элемента | URL: api/reference/ getByDestination/{itemId}
Метод: POST
Описание: Получить список связей элемента по id элемента и id типа связи.
Входные параметры:
itemId: Guid - ID элемента Json: Список id типов связей, которые надо получить [“referenceTypeId1”, “referenceTypeId2”] Пример: Получить список замечаний (id типа связи 4bc42916-9e3c-4c96-a25d-8a1b9b4bbc35) к файлу с id 4922dc08-bb93-ec14-a0a9-eae1ebf177bb | Expand |
|---|
| [ { "siteId": "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "listId": "02b4fda6-01b9-4ddb-a7cd-7a56fa415f11", "parentId": "02b4fda6-01b9-4ddb-a7cd-7a56fa415f11", "itemPath": { "path": [ "8d0bc7d7-f8af-ec11-bfeb-000c29f44205", "02b4fda6-01b9-4ddb-a7cd-7a56fa415f11" ], "scopeId": "02b4fda6-01b9-4ddb-a7cd-7a56fa415f11", "childCount": 0 }, "contentTypeId": "4bc42916-9e3c-4c96-a25d-8a1b9b4bbc35", "permissionList": [ "read", "create", "download", "update", "delete" ], "id": "1f32dc08-63a6-7c67-afa3-b060f96084d1", "name": null, "isNew": false, "insertUser": { "id": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Левитин Андрей" } }, "insertUserId": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "insertUserName": "Левитин Андрей", "insertDate": "2024-02-20T14:24:29.858865Z", "updateUser": { "id": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Левитин Андрей" } }, "updateUserId": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "updateUserName": "Левитин Андрей", "updateDate": "2024-02-20T14:24:29.858865Z", "deleteUser": null, "deleteUserId": "00000000-0000-0000-0000-000000000000", "deleteUserName": null, "deleteDate": null, "status": 1, "fieldValueMap": { "source": { "id": "1f32dc08-63a6-7c66-8379-d422ba2491d2", "contentTypeId": "8231527e-3cba-4cb3-8196-4e2b13db362c", "fieldValueMap": { "end_date_fact": "2024-07-15T10:47:16.735948Z", "assignedto": { "id": "3a9a648b-98a0-43e2-b5bf-b06d0084303a", "contentTypeId": "99c92e22-4e60-48c0-ab70-add500e71a45", "fieldValueMap": { "name": "Левитин Андрей" } }, "markup": "{\"id\":\"new-1708439228600\",\"pageNr\":1, \"position\":{\"x\":343.1880005720824,\"y\":390.1762013729977}, \"content\":{\"creator\":\"\",\"date\":\"20.02.2024 17:27\", \"label\":\"1-[object Promise]1\",\"desc\":\"\"},\"svg\":{\"id\":\"new- 1708439228600\", \"pageNr\":1,\"type\":\"rect\", \"position\":{\"x\":363.1880005720824,\"y\":405.1762013729977}, \"width\":381.55606407322654, \"height\":279.80778032036613, \"stroke\":{\"color\":\"tlbr\",\"width\":3},\"fill\":\"none\"}}", "answer": "", "question_for_designer": "", "task_status": { "id": "646ac5e3-d5d4-4f88-b213-af0a0058c25c", "contentTypeId": "2067cdf9-2683-4658-9eef-ae6800802a2f", "fieldValueMap": { "name": "Не начато", "color": "#2d9cdb" } }, "item_id": 259, "sequence": 2590, "importance": { "id": "34ba677c-bd32-4322-a47e-28add7e09a85", "contentTypeId": "55231344-ec21-46e5-ac17-a4d00dc21a79", "fieldValueMap": { "name": "Обычная" } }, "name": "1", "description": "" } }, "destination": "4922dc08-bb93-ec14-a0a9-eae1ebf177bb", "destination_version": "f2c01a74-c06a-473a-8ce3-b8ecf49e6837" } } ] |
|
Пользователи | Задать/изменить пароль пользователя | URL: api/security/setPassword
Метод: POST
Описание: Задать/изменить пароль пользователя (требуются права админа).
Входные параметры: json объект
{ "principal": id пользователя, для которого надо задать пароль, "password": новый пароль пользователя, "is_change_password_at_next_login": bool, требовать ли смену пароля при следующем входе в систему, "is_two_factor_authentication_enabled": bool, включить двухфакторную авторизацию } Пример: Установить пароль для пользователя с id ba3bdc08-f633-5666-94f7-a91901fdf3da | Expand |
|---|
| URL: http://my-site.ru/api/security/setPassword Тело: { "principal":"ba3bdc08-f633-5666-94f7-a91901fdf3da", "password":"Pass123word", "is_change_password_at_next_login":false, "is_two_factor_authentication_enabled":false } |
|