Element
/api/element/add/object
Добавить объект в пространство имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры нового объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет | ||
| title | string | нет | ||
| description | string | нет | ||
| isGroup | boolean | нет | ||
| parentsCode | string[] | нет | ||
| childrenCode | string[] | нет | ||
| readOnly | boolean | нет | ||
| meta | MetaInfoItem[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/add/subject
Добавить субъект в пространство имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры нового субъекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет | ||
| title | string | нет | ||
| description | string | нет | ||
| isGroup | boolean | нет | ||
| parentsCode | string[] | нет | ||
| childrenCode | string[] | нет | ||
| readOnly | boolean | нет | ||
| meta | MetaInfoItem[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/change/object
Изменить информацию об объекте
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные для изменения объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет | ||
| title | string | нет | ||
| description | string | нет | ||
| needChangeParents | boolean | нет | ||
| parentsCode | ElementIdentifier[] | нет | ||
| needChangeChildren | boolean | нет | ||
| childrenCode | ElementIdentifier[] | нет | ||
| needDeleteCrossRelation | boolean | нет | ||
| meta | MetaInfoItem[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Р езультат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/change/subject
Изменить информацию о субъекте
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные для изменения субъекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет | ||
| title | string | нет | ||
| description | string | нет | ||
| needChangeParents | boolean | нет | ||
| parentsCode | ElementIdentifier[] | нет | ||
| needChangeChildren | boolean | нет | ||
| childrenCode | ElementIdentifier[] | нет | ||
| needDeleteCrossRelation | boolean | нет | ||
| meta | MetaInfoItem[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/object/del
Удалить объект
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор удаляемого объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nameSpace | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/subject/del
Удалить субъект
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор удаляемого субъекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nameSpace | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/detail/object/get
Получить детальную информацию об объекте
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nameSpace | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ElementDetail | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/element/detail/subject/get
Получить детальную информацию о субъекте
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор субъекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nameSpace | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ElementDetail | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/element/list/Object
Получить список объектов в пространстве имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Пространство имен
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ElementItemWithMeta[] | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/element/list/Subject
Получить список субъектов в пространстве имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Пространство имен
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ElementItemWithMeta[] | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/element/ingroup
Добавить элемент в группу.
Элемент и группа должны принадлежать одному пространству имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о добавляемом элементе
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | нет | ||
| groupCode | string | нет | ||
| elementCode | string | нет | ||
| elementNamespace | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/fromgroup
Удалить элемент из группы.
Элемент и группа должны принадлежать одному пространству имен
Тип HTTP запроса: post
Отсылаемый запрос
MIME-т ип HTTP запроса: application/json
Информация об исключаемом элементе
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | нет | ||
| groupCode | string | нет | ||
| elementCode | string | нет | ||
| elementNamespace | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/mark/readonly
Выставить элементу признак "только для чтения"
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор элемента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/element/unmark/readonly
Убрать у элемнта признак "только для чтения"
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор элемента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespaceCode | string | нет | ||
| code | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |