Получение всех файлов: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Список всех файлов в указанной версии схемы расширения Extensions 2.0. Запрос создает <code>applicati...») |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}</nowiki></code> | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru</nowiki><nowiki/>/api/v2/extensions/schemas/{schemaVersion}</code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивныйШлюз | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read extensions ( <code>extensions.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Read extensions''' ( <code>extensions.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 22: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |schemaVersion | ||
| | |string | ||
|Версия схемы. | |Версия схемы. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |Accept | ||
| | |string | ||
|Принять заголовок. Указывает часть расширения 2.0, которая будет возвращена: | |Принять заголовок. Указывает часть расширения 2.0, которая будет возвращена: | ||
* приложение/json; charset=utf-8 — возвращает метаданные расширения 2.0 в JSON | * приложение/json; charset=utf-8 — возвращает метаданные расширения 2.0 в JSON | ||
* application/octet-stream — возвращает zip-архив с расширением 2.0, хранящийся на сервере. | * application/octet-stream — возвращает zip-архив с расширением 2.0, хранящийся на сервере. | ||
| | |header | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 50: | Строка 50: | ||
|- | |- | ||
|200 | |200 | ||
| | |SchemaFiles | ||
|Успех | |Успех | ||
|- | |- | ||
| Строка 64: | Строка 64: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>SchemaFiles</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 70: | Строка 70: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |files | ||
| | |string[] | ||
|Список файлов схемы. | |Список файлов схемы. | ||
|} | |} | ||
Текущая версия на 11:12, 7 октября 2022
Список всех файлов в указанной версии схемы расширения Extensions 2.0.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}
|
| SaaS | https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/schemas/{schemaVersion}
| |
| Окружающая среда АктивныйШлюз | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/schemas/{schemaVersion}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read extensions ( extensions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| schemaVersion | string | Версия схемы. | path | требуется |
| Accept | string | Принять заголовок. Указывает часть расширения 2.0, которая будет возвращена:
|
header | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | SchemaFiles | Успех |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
| 406 | ErrorEnvelope | Неприемлимо |
Объекты тела ответа
Объект SchemaFiles
| Элемент | Тип | Описание |
|---|---|---|
| files | string[] | Список файлов схемы. |
JSON-модель тела ответа
{
"files": [
"string"
]
}
