API для отправки данных с UI
/api/v1/Cms/PostDataSet
Отправить запрос с данными сервису
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController PostDataSet(ASE.MD.Platform.UI.Pipeline.RequestPipeline.DatasetPipeline, ASE.MD.Platform.UI.Core.Contracts.ClientRequestData)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |
/api/v1/Cms/PostMasterPage
Получить мастерпейдж
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController PostMasterPage(ASE.MD.Platform.UI.Pipeline.RequestPipeline.MasterPagePipeline, ASE.MD.Platform.UI.Core.Contracts.ClientRequestData)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:page:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |
/api/v1/Cms/PostPage
Получить пейдж
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обяза тельное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController PostPage(ASE.MD.Platform.UI.Pipeline.RequestPipeline.PagePipeline, ASE.MD.Platform.UI.Core.Contracts.ClientRequestData)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:page:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |
/api/v1/Cms/PostPageAnonymous
Получить пейдж анонимно
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Об язательное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
/api/v1/Cms/PostPartView
Получить частичное представление
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController PostPartView(ASE.MD.Platform.UI.Pipeline.RequestPipeline.PartViewPipeline, ASE.MD.Platform.UI.Core.Contracts.ClientRequestData)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:page:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |
/api/v1/Cms/PostQuery
Отправить запрос
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Запрос, содержащие данные от клиента
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| container | string | Название контейнера. | нет | |
| command | string | Название команды. | нет | |
| data | object | Данные. | нет | |
| locale | string | Локализация языка. | нет | |
| projectId | string | Идентификатор проекта. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| containerProps | object | Свойства контейнера | нет | |
| metadata | IDomElement | |||
| dataSets | DataSetContainer[] | Наборы данных | нет | |
| dictionaries | LocalizationDictionary[] | Словари локализаций | нет | |
| user | UserData | |||
| message | string | Сообщение | нет | |
| container | string | нет | ||
| data | object | нет | ||
| projectId | string | нет | ||
| request | ClientRequestData |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController PostQuery(ASE.MD.Platform.UI.Pipeline.RequestPipeline.QueryPipeline, ASE.MD.Platform.UI.Core.Contracts.ClientRequestData)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |
/api/v1/Cms/GetProjects
Получить проекты, установленные на контуре.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/cmsservice public CmsController GetProjects(CMSService.Utils.IPipelineUtilsWrapper)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:projects:read |
/components/securitySchemes/cmsservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | cmsservice:dataset:read, cmsservice:page:read, cmsservice:projects:read |