API Dashboard

Taffy 4.0.0
Reload on every request: ? Yes
Return Exceptions as JSON: ? Yes
CORS: ? Yes
E-Tags: ? No
JSONP: ? No
Endpoint URL Param: ? endpoint
Serializer: ? taffy.core.nativeJsonSerializer
Return Formats: text/json, application/json
Global Headers: ? X-Application-Version: 0.266
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Location
Exception Log Adapter: ? taffy.bonus.LogToDevNull
Exception Log Adapter Config: ? redacted
Unhandled Paths: /flex2gateway

Resources:

user /user GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Контрольная информация по текущему пользователю для проверки контекста. Предполагается использовать только для интеграционной отладки. Исключения перехватываются, всегда возвращается код 200, структура ответа при этом не предназначена для разбора

svc_operation_cfs_subparam_compute /svcOperationCfsSubparams/compute/{svcOperationCfsSubparamId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

вычисляет выражение в поле expression

get

вычисление возможных значений cубпараметра CFS параметра операции, в текущем контексте

required string svcOperationCfsSubparamId

type:integer

optional string keys (default: {})

type:json keys we depend on: of the param uid itself, or operation uid, instance uid, service operation cfs param - if not all entities intstantiated yet

optional string params (default: {})

type:json any posted parameters we depend on

svc_operation_cfs_param_compute /svcOperationCfsParams/compute/{svcOperationCfsParamId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

вычисляет выражение в поле expression

get

вычисление возможных значений CFS параметра операции инстанса, в текущем контексте. Рекомендуется передавать keys.svcOperationCfsParamId для декларации класса параметра (а не keys.instanceOperationCfsParamUid) - он неизвестен для вновь создаваемых параметров

required string svcOperationCfsParamId

type:integer

optional string keys (default: {})

type:json keys we depend on: of the param uid itself, or operation uid, instance uid, service operation cfs param - if not all entities intstantiated yet

optional string params (default: {})

type:json any parameters we depend on

svc_grouped_ls /servicesGrouped GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список сервисов с группами для каталога. Без управления страницами и сортировкой (сортировка по порядку группы, сервисы вне групп в конце списка). Если сервис входит в несколько групп, он будет повторяться

svc_default /services/{svcId}/default GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

template for default instance

get

DEPRECATED. Шаблон экземпляра

required string svcId

type:integer

svc /services/{svcId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Сервис

required string svcId

type:integer

svc_ls /services GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список сервисов

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

optional string fields (default: "")

type:string, description:comma-separated list of fields to limit output to, empty string or omitted for default field set

optional string search (default: "")

type:string, free search (black box)

svc_operation /serviceOperation/{svcOperationId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Операция сервиса

required string svcOperationId

type:integer

catalog_service_ls /service-catalog/services GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Каталог конкретных услуг

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

catalog_service_param_ls /service-catalog/service-params GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Каталог конкретных услуг

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

resource_realm_type_ls /resourceRealmTypes GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список типов ресурсных платформ

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

available_resource_realms /resourceRealms/available GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список доступных ресурсных платформ для выбранного сервиса

required string svcId

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

resource_realm /resourceRealms/{resourceRealmId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Сервис

required string resourceRealmId

type:integer

resource_realm_ls /resourceRealms GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список ресурсных платформ

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

param_value_list /param-value-list/{svcOperationCfsParamId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

deprecated

get

Список значений CFS параметра операции

required string svcOperationCfsParamId

type:integer

instance_default /instances/default/{svcId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

template for default instance

get

Шаблон экземпляра

required string svcId

type:integer

vault_record /instances/{instanceUid}/vault/{secretName} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

getting secrets from the vault

get

Получить секрет

required string instanceUid

type:UUID

required string secretName

type:string

instance /instances/{instanceUid} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

delete

Удаление экземпляра сервиса по ключу. Допускается в статусе not configured

required string instanceUid

type:guid

get

Экземпляр сервиса

required string instanceUid

type:guid

patch
required string instanceUid

type:guid

optional string displayName

type:string

optional string descr (default: "")

type:varchar (no cleanup here!)

instance_ls /instances GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список экземпляров сервисов, принадлежащих данному клиенту

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC (performance not assured on arbitrary sorting)

optional string fields (default: "")

type:string, description:comma-separated list of fields to limit output to, empty string or omitted for default field set

optional string search (default: "")

type:string, free search (black box)

post

ВНИМАНИЕ! У текущего контрагента должна быть спецификация, в которую будет вписан создаваемый экземпляр. Новая пустая запись экземпляра. Фактическое развертывание выполняется отдельно,асинхронной операцией create сконфигурированного экземпляра. Одновременно мы создаем строку в спецификации по умолчанию и связываем экземпляр с этой строкой. Первичный ключ генерируется. Текущий пользователь, контракт, спецификация получаются из контекста.

required string displayName

type:string

required string serviceId

type:integer

optional string descr (default: "")

type:varchar (no cleanup here!)

optional string resourceRealmId (default: -1)

type:integer

instance_operation_validate /instanceOperations/{instanceOperationUid}/validate-cfs GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Проверка корректности CFS

required string instanceOperationUid

type:guid

instance_operation_run /instanceOperations/{instanceOperationUid}/run GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

post

Запуск выполнения операции

required string instanceOperationUid

type:guid

instance_operation_default /instanceOperations/{instanceUid}/{svcOperationId} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

template for default instance operation. Legacy URL: /instanceOperations/default/{svcOperationId}

get

Шаблон операции экземпляра

required string instanceUid

type:guid|'default'

required string svcOperationId

type:integer

instance_operation /instanceOperations/{instanceOperationUid} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Операция над экземпляром сервиса

required string instanceOperationUid

type:guid

instance_operation_ls /instanceOperations GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список операций

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

post

Создание новой операции. Отдельно загружаются CFS параметры, генерируются RFS параметры. Запускается операция отдельным вызовом. До запуска CFS параметры могут корректироваться (а надо?). Запущенная операция вместе с параметрами навсегда становится Read Only (при желании можем реализовать ее клонирование). Можем реализовать корректировку параметров, но непонятно, зачем. Когда мы конфигурируем инстанс, на самом деле мы задаем CFS параметры операции create. Можно править параметры, а можно пересоздать операцию с новыми параметрами. Предусмотреть удаление (метод DELETE) незапущенной операции?

required string instanceUid

type:guid

required string operation

type:string decsiption: operation name, e.g. create

optional string note (default: "")

type:string decsiption: user notes

instance_operation_cfs_subparam /instanceOperationCfsParams/{instanceOperationCfsParamUid}/subparams/{subparam} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

delete

Удаление метаданных субпараметра CFS-параметра операции экземпляра по ключу.

required string instanceOperationCfsParamUid

type:guid

required string subparam

type:string

get

Метаданные субпараметра CFS-параметра операции экземпляра (значение субпараметра находится в теле параметра)

required string instanceOperationCfsParamUid

type:guid

required string subparam

type:string

put

запись метаданных субпараметра CFS-параметра операции инстанса

required string instanceOperationCfsParamUid

type:guid

required string subparam

type:string

optional boolean isSensitive (default: false)

type:boolean

optional string note (default: "")
instance_operation_cfs_subparam_ls /instanceOperationCfsParams/{instanceOperationCfsParamUid}/subparams GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

post

создание метаданных субпараметра CFS параметра операции инстанса

required string instanceOperationCfsParamUid

type:guid

required string subparam

type:string

optional boolean isSensitive (default: false)

type:boolean

optional string note (default: "")

type:string

instance_operation_cfs_param /instanceOperationCfsParams/{instanceOperationCfsParamUid} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

delete

Удаление CFS параметра операции по ключу.

required string instanceOperationCfsParamUid

type:guid

get

CFS параметр операции инстанса

required string instanceOperationCfsParamUid

type:guid

put

запись CFS параметра операции инстанса

required string instanceOperationCfsParamUid

type:guid

required string paramValue
optional string note (default: "")
instance_operation_cfs_param_ls /instanceOperationCfsParams GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список CFS параметров

optional string pageSize (default: 1000)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

optional string instanceOperationUid

type:guid

post

Создание нового CFS параметра операции.

required string instanceOperationUid

type:guid

required string svcOperationCfsParamId

type:integer

required string paramValue

type:string ***Валидацию пока не проводим, а надо

optional string note (default: "")

type:string description: комментарий пользователя

err /error GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Имитация ошибки HTTP для тестирования

optional string statusCode (default: 200)

type:integer

optional string statusText (default: "")

type:string

bookmark /bookmarks/bookmarks/{bookmarkUid} GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Букмарк

required string bookmarkUid

type:guid

patch
required string bookmarkUid

type:guid

optional string bookmark

type:string

optional string descr

type:string (no cleanup here!)

optional string url

type:string description: url

optional string iconUrl

type:string description: url иконки

optional string sort

type:integer description: целое число для сортировки

optional string isEnabled

type:boolean description: вкл

bookmark_ls /bookmarks/bookmarks GET POST PUT PATCH DELETE
+Query Params +Accept +Headers +Basic Auth

Request Body:

Response:

get

Список букмарков

optional string pageSize (default: 100)

type:integer

optional string page (default: 1)

type:integer

optional string orderBy (default: "")

type:string, description:comma-separated list of fields to sort by, example:fld1.ASC,fld2.DESC,fld3.ASC

post

Создание нового букмарка.

required string bookmark

type:string description: заголовок

optional string descr (default: "")

type:boolean description: пользовательское примечание

optional string url (default: "")

type:string description: url

optional string iconUrl (default: "")

type:string description: url иконки

optional string sort (default: 100)

type:integer description: целое число для сортировки

optional string isEnabled (default: 1)

type:boolean description: вкл

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.