| Method Name | Usage |
|---|---|
| handleTaskSplittingResult() | This is pre-processing method which gets executed before shoppingCart is created. This is callled \"pre-processing\" logic. |
| handleSignal() | This is post-processing method which gets executed after shoppingCart is created.This is callled the functionality defined here the \"post-processing\" logic. |
| Task Signal Name | Usage |
|---|---|
| shoppingcart-pre-process | This signal name is used to read the ShoppingCartOracle object from shoppingcart service as pre processing payload before cart is created and business logical extensions applied on the payload and return ShoppingCartOracle object as response. |
| shoppingcart-post-process | This signal name is used to read the ShoppingCartOracle object from shoppingcart service as post processing payload after cart is created and business logical extensions applied on the payload and return ShoppingCartOracle object as response. |
| audit-info-signal-pre-process | This signal name is used to update the audit details inside Processing Information for pre-processing business logic and emit this task signal. |
| audit-info-signal-post-process | This signal name is used to update the audit details inside Processing Information for post-processing business logic and emit this task signal. |
| Status code | Usage |
|---|---|
| SUCCESS | This status code is used when successful response from spoke system. |
| WARNING | This status code is used when error response from spoke system and still want to process the ShoppingCart and return error to user. |
| FAILURE | This status code is used when successful response from spoke system and don't want to process the ShoppingCart and return error to user. |
import { MappingContext, SignalDefinition } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/oracle-builtins.mjs\";\nimport { DataSignal, DIRECTION, ActionableDataSignal, SignalMetaMap, SPOKE_ID, ACTION } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/signals.mjs\";\nexport const spokeDiscriminator = () => \"oracle\";\nexport const providedSignals = () => [];\nexport const handleSignal = async (payload, ctx, signalInfo) => {\n}\nexport const handleTaskSplittingResult = async (requestJson, ctx, {apiName, apiVersion, pathId, requestHTTPMethod, sourcePropertyName}) => {\n} Example-2:Processing Information code sample calling with signals and calling external system Two signals in this example- callAddressValidation and addressValidateResponseSignal. The callAddressValidation signal is the outbound signal that will tell the framework to make the call to the address validation system. The first argument specifies the signal name as a string, which can be any value you want. It makes sense to give it an appropriate name for what the signal is doing, so in this case we name it \"address-validate-request\". The second argument is the HTTP method to be used for the request, in this case it is a POST. The third argument should always be DIRECTION.FROM_MODEL. The framework derives the baseURL of the call from the 4th argument, which is pre-registered with the framework. The fifth argument is where you specify the name of the response signal. As mentioned previously, the calls are happening asynchronously, so once a signal is fired, we have to explicitly wait for the framework to come back with a response in the form of another signal (which carries the response data and metadata from the API we are calling).
import { MappingContext, SignalDefinition } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/oracle-builtins.mjs\";\nimport { DataSignal, DIRECTION, ActionableDataSignal, SignalMetaMap, SPOKE_ID, ACTION } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/signals.mjs\";\nexport const spokeDiscriminator = () => \"oracle\";\nlet addressValidateResponseSignal = new DataSignal(\"address-validate-reply\", DIRECTION.FROM_MODEL);\nlet callAddressValidation = new ActionableDataSignal(\"address-validate-request\", ACTION.POST, DIRECTION.FROM_MODEL, SPOKE_ID.RMS_SPOKE_ID, \"address-validate-reply\");\nexport const providedSignals = () => [callAddressValidation]; Example-3:Processing Information code sample calling with signals and calling external system /* * Copyright (c) 2020, 2022, Oracle and/or its affiliates. */ import {MappingContext, SignalDefinition} from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/oracle-builtins.mjs\"; import { DataSignal, DIRECTION, ActionableDataSignal, SignalMetaMap, SPOKE_ID, ACTION } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/signals.mjs\";\nexport const spokeDiscriminator = () => \"oracle\";\nlet addressValidateResponseSignal = new DataSignal(\"address-validate-reply\", DIRECTION.FROM_MODEL);\nlet callAddressValidation = new ActionableDataSignal(\"address-validate-request\", ACTION.POST, DIRECTION.FROM_MODEL, SPOKE_ID.RMS_SPOKE_ID, \"address-validate-reply\");\nexport const providedSignals = () => [callAddressValidation];\nexport const handleSignal = async (payload, ctx, signalInfo) => {\n} /** * * @param requestJson {ITObject} the request object acting as input * @param ctx {MappingContext} the mapping context */ export const handleTaskSplittingResult = async (requestJson, ctx) => { console.log(\"In pre processing logic in PI\"); let shoppingCart = ctx.workOnTaskSignalPayload(\"shoppingcart-pre-process\");\nconst validateAddressMetaMap = ctx.createMeta(); validateAddressMetaMap.apiPath = \"/api/shoppingCart/v4/validateBillingAddress\";\nfor (let cartItemIndex in shoppingCart.cartItem) { let cartItem = shoppingCart.cartItem[cartItemIndex]; let addressToValidate = cartItem.shippingAddress;\n//call spoke system ctx.emitSignal({ signalName:\"address-validate-request\", //based on signal name, the EDK knows which system to go to signalValue:addressToValidate, signalMetaMap:validateAddressMetaMap });\n//wait for reply from spoke system let validateAddressResponse = await ctx.dependOn(\"address-validate-reply\", undefined, false); let responsePayload = JSON.stringify(validateAddressResponse.payload()); let responseMeta = JSON.stringify(validateAddressResponse.meta()); } } export const sendSpokeResponseInfo = async (spokeCallResponseBody, spokeCallResponseMeta, signalName, ctx, successValue) => { console.log(\"Sending audit info for signal \" + signalName);\n//we have to emit a signal that is a regular json obj, not a SignalMetaMap obj type let metaObj = JSON.parse(JSON.stringify(spokeCallResponseMeta)); let payloadObjStr = JSON.stringify(spokeCallResponseBody); let auditInfoObj = {}; auditInfoObj['meta'] = metaObj; auditInfoObj['responsePayload'] = payloadObjStr; auditInfoObj['status'] = successValue;\nlet meta = ctx.createMeta(); ctx.emitSignal({ signalName:signalName, signalValue:auditInfoObj, signalMetaMap:meta, signalScope:\"audit\" }); } import {MappingContext, SignalDefinition} from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/oracle-builtins.mjs\"; import { DataSignal, DIRECTION, ActionableDataSignal, SignalMetaMap, SPOKE_ID, ACTION } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/signals.mjs\";\nexport const spokeDiscriminator = () => \"oracle\";\nlet addressValidateResponseSignal = new DataSignal(\"address-validate-reply\", DIRECTION.FROM_MODEL);\nlet callAddressValidation = new ActionableDataSignal(\"address-validate-request\", ACTION.POST, DIRECTION.FROM_MODEL, SPOKE_ID.RMS_SPOKE_ID, \"address-validate-reply\");\nexport const providedSignals = () => [callAddressValidation];\nexport const handleSignal = async (payload, ctx, signalInfo) => {\n} /** * * @param requestJson {ITObject} the request object acting as input * @param ctx {MappingContext} the mapping context */ export const handleTaskSplittingResult = async (requestJson, ctx) => { try { console.log(\"In pre processing logic in PI\"); let shoppingCart = ctx.workOnTaskSignalPayload(\"shoppingcart-pre-process\"); const validateAddressMetaMap = ctx.createMeta(); validateAddressMetaMap.apiPath = \"/api/shoppingCart/v4/validateBillingAddress\";\nfor (let cartItemIndex in shoppingCart.cartItem) { let cartItem = shoppingCart.cartItem[cartItemIndex]; let addressToValidate = cartItem.shippingAddress; //call spoke system ctx.emitSignal({ signalName:\"address-validate-request\", //based on signal name, the EDK knows which system to go to signalValue:addressToValidate, signalMetaMap:validateAddressMetaMap });\n//wait for reply from spoke system let validateAddressResponse = await ctx.dependOn(\"address-validate-reply\", undefined, false); let responsePayload = JSON.stringify(validateAddressResponse.payload()); let responseMeta = JSON.stringify(validateAddressResponse.meta()); if (validateAddressResponse.meta().error != null) { console.log(\"Error calling the address validation system\"); sendSpokeResponseInfo(validateAddressResponse.payload(), validateAddressResponse.meta(), \"audit-info-signal-pre-process\", ctx, \"FAILURE\"); } else { console.log(\"Successfully called the address validation system\"); sendSpokeResponseInfo(validateAddressResponse.payload(), validateAddressResponse.meta(), \"audit-info-signal-pre-process\", ctx, \"SUCCESS\"); }\n}\n\n} catch (e) { console.log(\"Error encountered in PI.\"); console.log(e.stack); console.log(e.name); console.log(e.message); } }\nexport const sendSpokeResponseInfo = async (spokeCallResponseBody, spokeCallResponseMeta, signalName, ctx, successValue) => { console.log(\"Sending audit info for signal \" + signalName);\n//we have to emit a signal that is a regular json obj, not a SignalMetaMap obj type let metaObj = JSON.parse(JSON.stringify(spokeCallResponseMeta)); let payloadObjStr = JSON.stringify(spokeCallResponseBody); let auditInfoObj = {}; auditInfoObj['meta'] = metaObj; auditInfoObj['responsePayload'] = payloadObjStr; auditInfoObj['status'] = successValue; let meta = ctx.createMeta(); ctx.emitSignal({ signalName:signalName, signalValue:auditInfoObj, signalMetaMap:meta, signalScope:\"audit\" }); }\n \"code\" \"CXI-BUY-0022\", \"reason\" \"Invalid body\", \"message\" \"Action specified on the cart items [cartItem[0]] is either empty or not one of the supported types. \"", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error. Refer to the Error schema for information of the errors returned for different scenarios. For example, if an issue is related to processing the request because of server errors, the following error message is populated.
\"code\" \"CXI-BUY-0001\",
\"reason\" \"Internal Server Error\"
",
"content":{
"application/json;charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"security":[
{
"oAuth2AuthCodeForSupportSpecialistRole":[
"/buyingX"
]
}
],
"x-internal-id":"publisher-apiManagement-processingInformation-shoppingcartAdapter-shoppingCart-v4-schemas-oracle-buying-{component_name}-post",
"x-filename-id":"publisher-apimanagement-processinginformation-shoppingcartadapter-shoppingcart-v4-schemas-oracle-buying-component_name-post"
},
"patch":{
"tags":[
"Business Logical Extensions"
],
"summary":"Update a business logical extension.",
"description":"This method is used to create Processing Information file(PI). The Processing Information file is JavaScript file that is associated with a particular business entity - example - ShoppingCartOracle. The PI file will be stored in the Object Storage with POST operation and the processing information file will be used for ShoppingCartOracle POST and PATCH requests for processing the external busieness logic defined inside this file. Every processing information file should have the two functions defined in them, handleSignal and handleTaskSplittingResult. Therefor you can think of each Processing Information file as a javascript file that must implement a sort of interface that defines those two functions. The naming of these functions corresponds to the purpose these functions serve in the underlying framework that allows for the extensibility of business objects.
JavaScript Methods that need to be overriden in Processing Information
| Method Name | Usage |
|---|---|
| handleTaskSplittingResult() | This is the pre-processing method which gets executed before shoppingCart is created. This is callled \"pre-processing\" logic. |
| handleSignal() | This is post-processing method which gets executed after shoppingCart is created.This is callled the functionality defined here the \"post-processing\" logic. |
| Task Signal Name | Usage |
|---|---|
| shoppingcart-pre-process | This signal name is used to read the ShoppingCartOracle object from shoppingcart service as pre processing payload before cart is created and business logical extensions applied on the payload and return ShoppingCartOracle object as response. |
| shoppingcart-post-process | This signal name is used to read the ShoppingCartOracle object from shoppingcart service as post processing payload after cart is created and business logical extensions applied on the payload and return ShoppingCartOracle object as response. |
| audit-info-signal-pre-process | This signal name is used to update the audit details inside Processing Information for pre-processing business logic and emit this task signal. |
| audit-info-signal-post-process | This signal name is used to update the audit details inside Processing Information for post-processing business logic and emit this task signal. |
| Status code | Usage |
|---|---|
| SUCCESS | This status code is used when successful response from spoke system. |
| WARNING | This status code is used when error response from spoke system and still want to process the ShoppingCart and return error to user. |
| FAILURE | This status code is used when successful response from spoke system and don't want to process the ShoppingCart and return error to user. |
import { MappingContext, SignalDefinition } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/oracle-builtins.mjs\";\nimport { DataSignal, DIRECTION, ActionableDataSignal, SignalMetaMap, SPOKE_ID, ACTION } from \"src/it/resources/com/oracle/cx/sdk/providers/it/lib/signals.mjs\";\nexport const spokeDiscriminator = () => \"oracle\";\nexport const providedSignals = () => [];\nexport const handleSignal = async (payload, ctx, signalInfo) => {\n}\nexport const handleTaskSplittingResult = async (requestJson, ctx, {apiName, apiVersion, pathId, requestHTTPMethod, sourcePropertyName}) => {\n} Example-1:Basic Skeleton of the Processing Information JavaScript Code.",
"operationId":"createBLEShoppingCartOracle",
"parameters":[
{
"name":"component_name",
"in":"path",
"description":"Identifier of the TMF Component.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"The Javascript logic to create shoppingcart.",
"content":{
"application/javascript;charset=utf-8":{
"example":null
}
},
"required":true
},
"responses":{
"201":{
"description":"Updated. After successful updation of processing information."
},
"400":{
"description":"Bad Request. Refer Error schema for information of the errors returned for different validation scenarios. For example, if an invalid action is provided in the request body, the following error message is populated.\"code\" \"CXI-BUY-0022\", \"reason\" \"Invalid body\", \"message\" \"Action specified on the cart items [cartItem[0]] is either empty or not one of the supported types. \"", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error. Refer Error schema for information of the errors returned for different scenarios. For example, if issue is related to processing the request because of server errors, the following error message is populated.
\"code\" \"CXI-BUY-0001\",
\"reason\" \"Internal Server Error\"
", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "security":[ { "oAuth2AuthCodeForSupportSpecialistRole":[ "/buyingX" ] } ], "x-internal-id":"publisher-apiManagement-processingInformation-shoppingcartAdapter-shoppingCart-v4-schemas-oracle-buying-{component_name}-patch", "x-filename-id":"publisher-apimanagement-processinginformation-shoppingcartadapter-shoppingcart-v4-schemas-oracle-buying-component_name-patch" }, "delete":{ "tags":[ "Business Logical Extensions" ], "summary":"Delete a business logical extension.", "description":"This method is used to create Processing.", "parameters":[ { "name":"component_name", "in":"path", "description":"Identifier of the ShoppingCart.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "201":{ "description":"Deleted after successful deletion of the Processing Information." }, "400":{ "description":"Bad Request. Refer Error schema for information of the errors returned for different validation scenarios. For example, if an invalid action is provided in the request body, the following error message is populated.
\"code\" \"CXI-BUY-0022\", \"reason\" \"Invalid body\", \"message\" \"Action specified on the cart items [cartItem[0]] is either empty or not one of the supported types. \"", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error. Refer Error schema for information of the errors returned for different scenarios. For example, if issue is related to processing the request because of server errors, the following error message is populated.
\"code\" \"CXI-BUY-0001\",
\"reason\" \"Internal Server Error\"
", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "security":[ { "oAuth2AuthCodeForSupportSpecialistRole":[ "/buyingX" ] } ], "x-internal-id":"publisher-apiManagement-processingInformation-shoppingcartAdapter-shoppingCart-v4-schemas-oracle-buying-{component_name}-delete", "x-filename-id":"publisher-apimanagement-processinginformation-shoppingcartadapter-shoppingcart-v4-schemas-oracle-buying-component_name-delete" } }, "/publisher/shoppingCart/v4/shoppingCart/audit/{id}":{ "get":{ "tags":[ "Business Logical Extensions" ], "summary":"Get the audit details for the business logical extension process.", "description":"This method gets the audit details for a shopping cart.", "operationId":"getShoppingCartAuditDetails", "parameters":[ { "name":"id", "in":"path", "description":"Identifier of the ShoppingCart.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success. Complete response is returned.", "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ShoppingCartAuditDetails" } } } } }, "400":{ "description":"Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Your request isn't authorized. The authentication credentials included with this request are missing or invalid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"You don't have authorization to perform this request. You may not have the necessary roles and privileges to use this REST resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Your request includes a resource URI that doesn't exist.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error. Refer Error schema for information of the errors returned for different scenarios. For example, if issue is related to processing the request because of server errors, the following error message is populated.
\"code\" \"CXI-BUY-0001\",
\"reason\" \"Internal Server Error\"
", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "security":[ { "oAuth2AuthCodeForSupportSpecialistRole":[ "/buyingX" ] } ], "x-internal-id":"publisher-shoppingCart-v4-shoppingCart-audit-{id}-get", "x-filename-id":"publisher-shoppingcart-v4-shoppingcart-audit-id-get" } }, "/admin/apiAnnexes":{ "get":{ "tags":[ "Administration/API Annexes" ], "summary":"Get all API annexes.", "parameters":[ { "name":"base-api", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnexResponses" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apiAnnexes-get", "x-filename-id":"admin-apiannexes-get" }, "post":{ "tags":[ "Administration/API Annexes" ], "summary":"Create an API annex.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnex" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-apiAnnexes-post", "x-filename-id":"admin-apiannexes-post" } }, "/admin/apiAnnexes/{id}":{ "get":{ "tags":[ "Administration/API Annexes" ], "summary":"Get an API annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the APIAnnex.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apiAnnexes-{id}-get", "x-filename-id":"admin-apiannexes-id-get" }, "put":{ "tags":[ "Administration/API Annexes" ], "summary":"Replace an API annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the API Annex to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnex" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-apiAnnexes-{id}-put", "x-filename-id":"admin-apiannexes-id-put" }, "delete":{ "tags":[ "Administration/API Annexes" ], "summary":"Delete an API annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the APIAnnex to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apiAnnexes-{id}-delete", "x-filename-id":"admin-apiannexes-id-delete" }, "patch":{ "tags":[ "Administration/API Annexes" ], "summary":"Update an API annex.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the APIAnnex to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apiAnnexes-{id}-patch", "x-filename-id":"admin-apiannexes-id-patch" } }, "/admin/apis":{ "get":{ "tags":[ "Administration/APIs" ], "summary":"Get all APIs.", "parameters":[ { "name":"api-id", "in":"query", "schema":{ "type":"string" } }, { "name":"api-name", "in":"query", "schema":{ "type":"string" } }, { "name":"api-version", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/APIs" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apis-get", "x-filename-id":"admin-apis-get" }, "post":{ "tags":[ "Administration/APIs" ], "summary":"Create an API.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-apis-post", "x-filename-id":"admin-apis-post" } }, "/admin/apis/{id}":{ "get":{ "tags":[ "Administration/APIs" ], "summary":"Get an API.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the API.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apis-{id}-get", "x-filename-id":"admin-apis-id-get" }, "put":{ "tags":[ "Administration/APIs" ], "summary":"Replace an API.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the API to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-apis-{id}-put", "x-filename-id":"admin-apis-id-put" }, "delete":{ "tags":[ "Administration/APIs" ], "summary":"Delete an API.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the API to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apis-{id}-delete", "x-filename-id":"admin-apis-id-delete" }, "patch":{ "tags":[ "Administration/APIs" ], "summary":"Update an API.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the API to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/API" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-apis-{id}-patch", "x-filename-id":"admin-apis-id-patch" } }, "/admin/connectionDescriptors":{ "get":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Get all connection descriptors.", "parameters":[ { "name":"endpoint-name", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } }, { "name":"scope", "in":"query", "schema":{ "type":"string" } }, { "name":"system-descriptor", "in":"query", "schema":{ "type":"string" } }, { "name":"type", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "external" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-connectionDescriptors-get", "x-filename-id":"admin-connectiondescriptors-get" }, "post":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Create a connection descriptor.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-connectionDescriptors-post", "x-filename-id":"admin-connectiondescriptors-post" } }, "/admin/connectionDescriptors/{id}":{ "get":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Get a connection descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the ConnectionDescriptor to be retrieved.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-connectionDescriptors-{id}-get", "x-filename-id":"admin-connectiondescriptors-id-get" }, "put":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Replace a connection descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the ConnectionDescriptor to be replaced.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } }, "required":false }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-connectionDescriptors-{id}-put", "x-filename-id":"admin-connectiondescriptors-id-put" }, "delete":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Delete a connection descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the ConnectionDescriptor to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-connectionDescriptors-{id}-delete", "x-filename-id":"admin-connectiondescriptors-id-delete" }, "patch":{ "tags":[ "Administration/Connection Descriptors" ], "summary":"Update a connection descriptor.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the ConnectionDescriptor to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-connectionDescriptors-{id}-patch", "x-filename-id":"admin-connectiondescriptors-id-patch" } }, "/admin/endpointRules":{ "get":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Get all endpoint rules.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "items":{ "$ref":"#/components/schemas/EndpointRule" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-endpointRules-get", "x-filename-id":"admin-endpointrules-get" }, "post":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Create an endpoint rule.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRuleRequestPayload" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRule" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-endpointRules-post", "x-filename-id":"admin-endpointrules-post" } }, "/admin/endpointRules/{id}":{ "get":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Get an endpoint rule.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Endpoint Rule.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRule" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-endpointRules-{id}-get", "x-filename-id":"admin-endpointrules-id-get" }, "put":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Replace an endpoint rule.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Endpoint Rule to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRuleRequestPayload" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRule" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-endpointRules-{id}-put", "x-filename-id":"admin-endpointrules-id-put" }, "delete":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Delete an endpoint rule.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the EndpointRule to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-endpointRules-{id}-delete", "x-filename-id":"admin-endpointrules-id-delete" }, "patch":{ "tags":[ "Administration/Endpoint Rules" ], "summary":"Update an endpoint rule.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the EndpointRule to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EndpointRule" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-endpointRules-{id}-patch", "x-filename-id":"admin-endpointrules-id-patch" } }, "/admin/export":{ "get":{ "tags":[ "Administration/Export" ], "summary":"Export all configurations.", "parameters":[ { "name":"export-default", "in":"query", "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/zip":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-export-get", "x-filename-id":"admin-export-get" } }, "/admin/export/{configurationName}":{ "get":{ "tags":[ "Administration/Export" ], "summary":"Export an individual configuration.", "responses":{ "200":{ "description":"OK", "content":{ "application/zip":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "parameters":[ { "name":"configurationName", "in":"path", "description":"Name of the configuration to be exported.", "required":true, "schema":{ "type":"string", "enum":[ "apis", "apiAnnexes", "systemDescriptors", "connectionDescriptors", "gatekeepingRules", "gatekeepingRuleAnnexes", "routingCriteria", "listenerRegistrations", "scimConfigurations", "interactionContextEnrichments", "utilityConfigurations", "tenantConfigurations", "stockResponses" ] } }, { "name":"export-default", "in":"query", "schema":{ "type":"boolean" } } ], "x-internal-id":"admin-export-{configurationName}-get", "x-filename-id":"admin-export-configurationname-get" } }, "/admin/extensibilitySecrets":{ "get":{ "tags":[ "Administration/Extensibility Secrets" ], "summary":"Get all extensibility secrets.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SecretsMasked" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-extensibilitySecrets-get", "x-filename-id":"admin-extensibilitysecrets-get" }, "post":{ "tags":[ "Administration/Extensibility Secrets" ], "summary":"Create an extensibility secret.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Secret" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SecretMasked" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-extensibilitySecrets-post", "x-filename-id":"admin-extensibilitysecrets-post" } }, "/admin/extensibilitySecrets/{id}":{ "put":{ "tags":[ "Administration/Extensibility Secrets" ], "summary":"Replace an extensibility secret.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Secret to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Secret" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SecretMasked" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-extensibilitySecrets-{id}-put", "x-filename-id":"admin-extensibilitysecrets-id-put" } }, "/admin/featureFlags":{ "get":{ "tags":[ "Administration/Feature Flags" ], "summary":"Get all feature flags.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FeatureFlags" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-featureFlags-get", "x-filename-id":"admin-featureflags-get" } }, "/admin/featureFlags/{flag}":{ "get":{ "tags":[ "Administration/Feature Flags" ], "summary":"Get a feature flag.", "parameters":[ { "name":"flag", "in":"path", "description":"The flag of the FeatureFlag.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FeatureFlag" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-featureFlags-{flag}-get", "x-filename-id":"admin-featureflags-flag-get" }, "put":{ "tags":[ "Administration/Feature Flags" ], "summary":"Enable/Disable a feature flag.", "parameters":[ { "name":"flag", "in":"path", "description":"The ID of the FeatureFlag to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FeatureFlag" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FeatureFlag" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-featureFlags-{flag}-put", "x-filename-id":"admin-featureflags-flag-put" } }, "/admin/gatekeepingRuleAnnexes":{ "get":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Get all gatekeeping rule annexes.", "parameters":[ { "name":"gatekeepingrule-name", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnexResponses" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRuleAnnexes-get", "x-filename-id":"admin-gatekeepingruleannexes-get" }, "post":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Create a gatekeeping rule annex.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnex" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-gatekeepingRuleAnnexes-post", "x-filename-id":"admin-gatekeepingruleannexes-post" } }, "/admin/gatekeepingRuleAnnexes/{id}":{ "get":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Get a gatekeeping rule annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRuleAnnex.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRuleAnnexes-{id}-get", "x-filename-id":"admin-gatekeepingruleannexes-id-get" }, "put":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Replace a gatekeeping rule annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRuleAnnex to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnex" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-gatekeepingRuleAnnexes-{id}-put", "x-filename-id":"admin-gatekeepingruleannexes-id-put" }, "delete":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Delete a gatekeeping rule annex.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRuleAnnex to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRuleAnnexes-{id}-delete", "x-filename-id":"admin-gatekeepingruleannexes-id-delete" }, "patch":{ "tags":[ "Administration/Gatekeeping Rule Annexes" ], "summary":"Update a gatekeeping rule annex.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRuleAnnex to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRuleAnnexResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRuleAnnexes-{id}-patch", "x-filename-id":"admin-gatekeepingruleannexes-id-patch" } }, "/admin/gatekeepingRules":{ "get":{ "tags":[ "Administration/Gatekeeping Rules" ], "summary":"Get all gatekeeping rules.", "parameters":[ { "name":"endpoint-name", "in":"query", "schema":{ "type":"string" } }, { "name":"internal-event-emitter-ref", "in":"query", "schema":{ "type":"string" } }, { "name":"listener-registration-refs", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } }, { "name":"rule-name", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRules" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRules-get", "x-filename-id":"admin-gatekeepingrules-get" } }, "/admin/gatekeepingRules/{id}":{ "get":{ "tags":[ "Administration/Gatekeeping Rules" ], "summary":"Get a gatekeeping rule.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRule.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRules" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRules-{id}-get", "x-filename-id":"admin-gatekeepingrules-id-get" }, "put":{ "tags":[ "Administration/Gatekeeping Rules" ], "summary":"Replace a gatekeeping rule.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the GatekeepingRule to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRule" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GatekeepingRule" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-gatekeepingRules-{id}-put", "x-filename-id":"admin-gatekeepingrules-id-put" } }, "/admin/import":{ "post":{ "tags":[ "Administration/Import" ], "summary":"Import all configurations.", "parameters":[ { "name":"strategy", "in":"query", "schema":{ "type":"string", "enum":[ "clean-import", "override-merge" ] } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"string", "format":"binary" } } }, "required":true }, "responses":{ "202":{ "description":"Accepted", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Import" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-import-post", "x-filename-id":"admin-import-post" } }, "/admin/interactionContextEnrichments":{ "get":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Get all interaction context enrichments.", "parameters":[ { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichments" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-interactionContextEnrichments-get", "x-filename-id":"admin-interactioncontextenrichments-get" }, "post":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Create an interaction context enrichment.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichmentNoID" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-interactionContextEnrichments-post", "x-filename-id":"admin-interactioncontextenrichments-post" } }, "/admin/interactionContextEnrichments/{id}":{ "get":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Get an interaction context enrichment.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the InteractionContextEnrichment.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-interactionContextEnrichments-{id}-get", "x-filename-id":"admin-interactioncontextenrichments-id-get" }, "put":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Replace an interaction context enrichment.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the InteractionContextEnrichment to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichmentNoID" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-interactionContextEnrichments-{id}-put", "x-filename-id":"admin-interactioncontextenrichments-id-put" }, "delete":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Delete an interaction context enrichment.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the InteractionContextEnrichment to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-interactionContextEnrichments-{id}-delete", "x-filename-id":"admin-interactioncontextenrichments-id-delete" }, "patch":{ "tags":[ "Administration/Interaction Context Enrichments" ], "summary":"Update an interaction context enrichment.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the InteractionContextEnrichment to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InteractionContextEnrichment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-interactionContextEnrichments-{id}-patch", "x-filename-id":"admin-interactioncontextenrichments-id-patch" } }, "/admin/listenerRegistrations":{ "get":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Get all listener registrations.", "parameters":[ { "name":"api-id", "in":"query", "schema":{ "type":"string" } }, { "name":"api-version", "in":"query", "schema":{ "type":"string" } }, { "name":"type", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "external" ] } }, { "name":"api-name", "in":"query", "schema":{ "type":"string" } }, { "name":"listener-url", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistrations" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-listenerRegistrations-get", "x-filename-id":"admin-listenerregistrations-get" }, "post":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Create a listener registration.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-listenerRegistrations-post", "x-filename-id":"admin-listenerregistrations-post" } }, "/admin/listenerRegistrations/{id}":{ "get":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Get a listener registration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Listener Registration.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-listenerRegistrations-{id}-get", "x-filename-id":"admin-listenerregistrations-id-get" }, "put":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Replace a listener registration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Listener Registration to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-listenerRegistrations-{id}-put", "x-filename-id":"admin-listenerregistrations-id-put" }, "delete":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Delete a listener registration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Listener Registration to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-listenerRegistrations-{id}-delete", "x-filename-id":"admin-listenerregistrations-id-delete" }, "patch":{ "tags":[ "Administration/Listener Registrations" ], "summary":"Update a listener registration.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Listener Registration to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ListenerRegistration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-listenerRegistrations-{id}-patch", "x-filename-id":"admin-listenerregistrations-id-patch" } }, "/admin/oidcServers":{ "get":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Get all OIDC servers.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServers" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-oidcServers-get", "x-filename-id":"admin-oidcservers-get" }, "post":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Create an OIDC server.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServerRequestPayload" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServer" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-oidcServers-post", "x-filename-id":"admin-oidcservers-post" } }, "/admin/oidcServers/{id}":{ "get":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Get an OIDC server.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the OIDC Server.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServer" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-oidcServers-{id}-get", "x-filename-id":"admin-oidcservers-id-get" }, "put":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Replace an OIDC server.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the OIDCServer to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServerRequestPayload" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServer" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-oidcServers-{id}-put", "x-filename-id":"admin-oidcservers-id-put" }, "delete":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Delete an OIDC server.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the OIDCServer to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-oidcServers-{id}-delete", "x-filename-id":"admin-oidcservers-id-delete" }, "patch":{ "tags":[ "Administration/OIDC Servers" ], "summary":"Update an OIDC server.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the OIDCServer to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OIDCServer" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-oidcServers-{id}-patch", "x-filename-id":"admin-oidcservers-id-patch" } }, "/admin/routingCriteria":{ "get":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Get all routing criteria.", "parameters":[ { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriterion" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-routingCriteria-get", "x-filename-id":"admin-routingcriteria-get" }, "post":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Create a routing criteria.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteriaWithoudID" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteria" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-routingCriteria-post", "x-filename-id":"admin-routingcriteria-post" } }, "/admin/routingCriteria/{id}":{ "get":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Get a routing criteria.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the RoutingCriteria.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteria" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-routingCriteria-{id}-get", "x-filename-id":"admin-routingcriteria-id-get" }, "put":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Replace a routing criteria.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the routing criteria.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteria" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteria" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-routingCriteria-{id}-put", "x-filename-id":"admin-routingcriteria-id-put" }, "delete":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Delete a routing criteria.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the routing criteria.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-routingCriteria-{id}-delete", "x-filename-id":"admin-routingcriteria-id-delete" }, "patch":{ "tags":[ "Administration/Routing Criteria" ], "summary":"Update a routing criteria.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the RoutingCriteria to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RoutingCriteria" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-routingCriteria-{id}-patch", "x-filename-id":"admin-routingcriteria-id-patch" } }, "/admin/scimConfigurations":{ "get":{ "tags":[ "Administration/SCIM Configurations" ], "summary":"Get all SCIM configurations.", "parameters":[ { "name":"connection-descriptor", "in":"query", "schema":{ "type":"string" } }, { "name":"profile", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfigurations" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-scimConfigurations-get", "x-filename-id":"admin-scimconfigurations-get" }, "post":{ "tags":[ "Administration/SCIM Configurations" ], "summary":"Create a SCIM configuration.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfigurationNoID" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfiguration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-scimConfigurations-post", "x-filename-id":"admin-scimconfigurations-post" } }, "/admin/scimConfigurations/{id}":{ "get":{ "tags":[ "Administration/SCIM Configurations" ], "summary":"Get a SCIM configuration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the SCIM configuration.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfiguration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-scimConfigurations-{id}-get", "x-filename-id":"admin-scimconfigurations-id-get" }, "put":{ "tags":[ "Administration/SCIM Configurations" ], "summary":"Replace a SCIM configuration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the SCIMConfiguration to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfigurationNoID" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfiguration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-scimConfigurations-{id}-put", "x-filename-id":"admin-scimconfigurations-id-put" }, "patch":{ "tags":[ "Administration/SCIM Configurations" ], "summary":"Update a SCIM configuration.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the SCIMConfiguration to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SCIMConfiguration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-scimConfigurations-{id}-patch", "x-filename-id":"admin-scimconfigurations-id-patch" } }, "/admin/stockResponses":{ "get":{ "tags":[ "Administration/Stock Responses" ], "summary":"Get all stock responses.", "parameters":[ { "name":"type", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "external" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "items":{ "$ref":"#/components/schemas/StockResponseWithID" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-stockResponses-get", "x-filename-id":"admin-stockresponses-get" }, "post":{ "tags":[ "Administration/Stock Responses" ], "summary":"Create a stock response.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponse" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponseWithID" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-stockResponses-post", "x-filename-id":"admin-stockresponses-post" } }, "/admin/stockResponses/{id}":{ "get":{ "tags":[ "Administration/Stock Responses" ], "summary":"Get a stock response.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Stock Response to be retrieved.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponseWithID" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-stockResponses-{id}-get", "x-filename-id":"admin-stockresponses-id-get" }, "put":{ "tags":[ "Administration/Stock Responses" ], "summary":"Replace a stock response.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Stock Response to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponse" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponseWithID" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-stockResponses-{id}-put", "x-filename-id":"admin-stockresponses-id-put" }, "delete":{ "tags":[ "Administration/Stock Responses" ], "summary":"Delete a stock response.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Stock Response to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-stockResponses-{id}-delete", "x-filename-id":"admin-stockresponses-id-delete" }, "patch":{ "tags":[ "Administration/Stock Responses" ], "summary":"Update a stock response.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the StockResponse to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/StockResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-stockResponses-{id}-patch", "x-filename-id":"admin-stockresponses-id-patch" } }, "/admin/systemDescriptors":{ "get":{ "tags":[ "Administration/System Descriptors" ], "summary":"Get all system descriptors.", "parameters":[ { "name":"api-id", "in":"query", "schema":{ "type":"string" } }, { "name":"api-version", "in":"query", "schema":{ "type":"string" } }, { "name":"domain", "in":"query", "schema":{ "type":"string" } }, { "name":"owner", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "tenant" ] } }, { "name":"system", "in":"query", "schema":{ "type":"string" } }, { "name":"type", "in":"query", "schema":{ "type":"string", "enum":[ "internal", "external" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-systemDescriptors-get", "x-filename-id":"admin-systemdescriptors-get" }, "post":{ "tags":[ "Administration/System Descriptors" ], "summary":"Create a system descriptor.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } }, "required":false }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-systemDescriptors-post", "x-filename-id":"admin-systemdescriptors-post" } }, "/admin/systemDescriptors/{id}":{ "get":{ "tags":[ "Administration/System Descriptors" ], "summary":"Get a system descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the SystemDescriptors to be retrieved.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-systemDescriptors-{id}-get", "x-filename-id":"admin-systemdescriptors-id-get" }, "put":{ "tags":[ "Administration/System Descriptors" ], "summary":"Replace a system descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the SystemDescriptors to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } }, "required":false }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-systemDescriptors-{id}-put", "x-filename-id":"admin-systemdescriptors-id-put" }, "delete":{ "tags":[ "Administration/System Descriptors" ], "summary":"Delete a system descriptor.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the system descriptor.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-systemDescriptors-{id}-delete", "x-filename-id":"admin-systemdescriptors-id-delete" }, "patch":{ "tags":[ "Administration/System Descriptors" ], "summary":"Update a system descriptor.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "parameters":[ { "name":"id", "in":"path", "description":"Identifier of system descriptor.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SystemDescriptors" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-systemDescriptors-{id}-patch", "x-filename-id":"admin-systemdescriptors-id-patch" } }, "/admin/tenantConfigurations":{ "get":{ "tags":[ "Administration/Tenant Configurations" ], "summary":"Get all tenant configurations.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TenantConfigurations" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-tenantConfigurations-get", "x-filename-id":"admin-tenantconfigurations-get" } }, "/admin/tenantConfigurations/{id}":{ "put":{ "tags":[ "Administration/Tenant Configurations" ], "summary":"Replace a tenant configuration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the tenant configuration.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TenantConfigurations" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TenantConfigurations" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-tenantConfigurations-{id}-put", "x-filename-id":"admin-tenantconfigurations-id-put" } }, "/admin/utilityConfigurations":{ "get":{ "tags":[ "Administration/Utility Configurations" ], "summary":"Get all utility configurations.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UtilityConfigurations" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-utilityConfigurations-get", "x-filename-id":"admin-utilityconfigurations-get" } }, "/admin/utilityConfigurations/{id}":{ "put":{ "tags":[ "Administration/Utility Configurations" ], "summary":"Replace a utility configuration.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the UtilityConfigurations to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UtilityConfiguration" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UtilityConfiguration" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-utilityConfigurations-{id}-put", "x-filename-id":"admin-utilityconfigurations-id-put" } }, "/admin/workspaceClients":{ "get":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Get all workspace clients.", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClients" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaceClients-get", "x-filename-id":"admin-workspaceclients-get" }, "post":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Create a workspace client.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClientRequestPayload" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClient" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-workspaceClients-post", "x-filename-id":"admin-workspaceclients-post" } }, "/admin/workspaceClients/{id}":{ "get":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Get a workspace client.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the WorkspaceClient.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClient" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaceClients-{id}-get", "x-filename-id":"admin-workspaceclients-id-get" }, "put":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Replace a workspace client.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the WorkspaceClient to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClientRequestPayload" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClient" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-workspaceClients-{id}-put", "x-filename-id":"admin-workspaceclients-id-put" }, "delete":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Delete a workspace client.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the WorkspaceClient to be deleted.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"No Content", "content":{ "*/*":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad Request", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaceClients-{id}-delete", "x-filename-id":"admin-workspaceclients-id-delete" }, "patch":{ "tags":[ "Administration/Workspace Clients" ], "summary":"Update a workspace client.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the WorkspaceClient to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WorkspaceClient" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaceClients-{id}-patch", "x-filename-id":"admin-workspaceclients-id-patch" } }, "/admin/workspaces":{ "get":{ "tags":[ "Administration/Workspaces" ], "summary":"Get all workspaces.", "parameters":[ { "name":"workspace-name", "in":"query", "schema":{ "type":"string" } }, { "name":"workspace-path-param", "in":"query", "schema":{ "type":"string" } }, { "name":"workspace-type", "in":"query", "schema":{ "type":"string", "enum":[ "Production", "Test" ] } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Workspaces" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaces-get", "x-filename-id":"admin-workspaces-get" } }, "/admin/workspaces/{id}":{ "get":{ "tags":[ "Administration/Workspaces" ], "summary":"Get a workspace.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the workspace.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Workspace" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaces-{id}-get", "x-filename-id":"admin-workspaces-id-get" }, "put":{ "tags":[ "Administration/Workspaces" ], "summary":"Replace a workspace.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Workspace to be updated.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Workspace" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Workspace" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"body", "x-internal-id":"admin-workspaces-{id}-put", "x-filename-id":"admin-workspaces-id-put" }, "patch":{ "tags":[ "Administration/Workspaces" ], "summary":"Update a workspace.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } }, "required":true }, "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Workspace to be updated.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Workspace" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"admin-workspaces-{id}-patch", "x-filename-id":"admin-workspaces-id-patch" } } }, "tags":[ { "name":"Administration/API Annexes", "description":"The API Annexes are accessible through Industries Framework. An API Annex can be used as extension to the existing API. For a single API there can be multiple API Annexes." }, { "name":"Administration/APIs", "description":"The API resource lets you to define APIs that are accessible through Industries Framework. An API can be used to configure an adapter for a service that implements the API. An API can also be used to configure a listener for API events." }, { "name":"Administration/Connection Descriptors", "description":"The Connection Descriptors resource lets you create, view, update and delete connection descriptors." }, { "name":"Administration/Endpoint Rules", "description":"Endpoint Rules helps Tenant to define outer detection configurations for any host that is Routed through CXIF." }, { "name":"Administration/Export", "description":"Export is used to move configuration data between different clusters." }, { "name":"Administration/Extensibility Secrets", "description":"Secrets API helps Tenant to store non public information like UserName, Password ..etc securely to the CXIF Vault." }, { "name":"Administration/Feature Flags", "description":"The Feature Flags resource lets you view and update feature flags." }, { "name":"Administration/Gatekeeping Rule Annexes", "description":"The operations from the Administration/Gatekeeping Rule Annexes category." }, { "name":"Administration/Gatekeeping Rules", "description":"The Gatekeeping Rules resource lets you view gatekeeping rules and update them." }, { "name":"Administration/Import", "description":"The exported configurable configurations can be imported into another cluster." }, { "name":"Administration/Interaction Context Enrichments", "description":"Captures the operations that create or update a routing interaction context. Such a context is a short-lived map of information that is retained in an in-memory cache as part of the Industries Framework. In case a routing target specifies that it requires the publishing of a key/value pair on the context, Industries Framework automatically extracts the relevant information from the request and response and either creates or updates such an interaction context. The call to the request source is then receiving the ID of the interaction context via the ORA-INTERACTION-CTX custom HTTP header." }, { "name":"Administration/Listener Registrations", "description":"The Listener Registrations resource lets you create, view, update and delete listener registrations." }, { "name":"Administration/OIDC Servers", "description":"List of the OpenID Connect servers that Industries Framework will interact with. This document appears both globally and on a per-workspace basis. Global documents are stored within the on-cluster control plane to describe for example the OIDC server that Fabric is secured with itself. Per-workspace servers are stored in a single respective document per namespace." }, { "name":"Administration/Routing Criteria", "description":"RoutingCriteria is a collection of different Criterias used by different end systems for routing. Will be used in RoutingMS to evaluate the criteria based on Incoming call." }, { "name":"Administration/SCIM Configurations", "description":"Captures SCIM Adapter configurations of user management APIs." }, { "name":"Administration/Stock Responses", "description":"The Stock Responses provide a static responses for the APIs. This resource lets you view, create, update, and delete stock responses." }, { "name":"Administration/System Descriptors", "description":"The System Descriptors resource lets you create, view, update and delete system descriptors." }, { "name":"Administration/Tenant Configurations", "description":"The Tenant Configurations resource lets you view and update tenant configuration. A tenant configuration object includes all configurations of a tenant or workspace." }, { "name":"Administration/Utility Configurations", "description":"The Utility Configurations resource lets you view and update utility configurations." }, { "name":"Administration/Workspace Clients", "description":"This document type describes the lookup of client application specific OAuth/OpenID Connect secrets that identify the client application on the various different AuthZ servers. It also references the secrets that are needed to sign OIDC token assertions." }, { "name":"Administration/Workspaces", "description":"Workspace is a collection of Industries Framework configurations. Will be used in identifying the workspace to which the Microservice needs the call to be routed to." }, { "name":"After-Market Extensibility", "description":"The resource lets you to view after-market extentions available. You can view the list of objects that can be extended, the current extensions available, and get information about a current extension. Currently, you can extend all TMF objects available in the framework.
Below is the mapping table for design time after market extensions.The extensions created at Shopping Cart (TMF 663) will be copied over Product Order (TMF 622) and Product Inventory (Asset) (TMF 637) based on below mappings
| Shopping Cart (TMF 663) | Product Order (TMF 622) | Product Inventory (Asset) (TMF 637) |
|---|---|---|
| AccountRefOracle | AccountRefOracle | AccountRefOracle |
| AddressOracle | AddressOracle | AddressOracle |
| BillingAccountRefOracle | BillingAccountRefOracle | BillingAccountRefOracle |
| ContactMedium | ||
| EligibilityProfileOracle | EligibilityProfileOracle | |
| MediumCharacteristic | ||
| OracleContractCreateJob | ||
| OracleCouponManagement | OracleCouponManagement | |
| OracleDeliverySchedule | OracleDeliverySchedule | |
| OracleFulfillmentInfo | OracleFulfillmentInfo | |
| OracleInstallation | OracleInstallation | |
| OracleLoyaltyManagement | OracleLoyaltyManagement | |
| OraclePayment | OraclePayment | |
| OracleRelatedParty | OracleRelatedParty | |
| OracleShipmentTracking | OracleShipmentTracking | |
| OracleStorePickUp | OracleStorePickUp | |
| OracleTSQ | OracleTSQ | |
| OracleValidateCart | ||
| Quantity | Quantity | Quantity |
| TimePeriod | TimePeriod | TimePeriod |
| Money | Money | Money |
| OracleContact | OracleContact | |
| OracleItemFulfillmentInfo | OracleItemFulfillmentInfo | |
| CharacteristicOracle | CharacteristicOracle | CharacteristicOracle |
| CartItemOracle | ProductOrderItemOracle | ProductOracle |
| BillStructure | ||
| OracleValidateOrder | ||
| BillingCycleSpecificationRefOrValue | ||
| BillFormatRefOrValue | ||
| BillPresentationMediaRefOrValue |