-
Dynamic Endpoint Manage
-
If you want to create endpoints from Swagger / Open API specification files, use Dynamic EndpointsMore...
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
-
Dynamic Endpoint Manage
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
v5.1.0 filtered by tag: Dynamic-Endpoint-Manage (12 APIs)
Delete Bank Level Dynamic Endpoint
Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
-
CanDeleteBankLevelDynamicEndpoint
- Please login to request this Role
-
CanDeleteDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Dynamic Endpoint
Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
-
CanDeleteDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Bank Level Dynamic Endpoint
Get a Bank Level Dynamic Endpoint.
Authentication is Mandatory
{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}
-
CanGetBankLevelDynamicEndpoint
- Please login to request this Role
-
CanGetDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get Dynamic Endpoints
Get Dynamic Endpoints.
Authentication is Mandatory
{
"dynamic_endpoints":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}]
}
-
CanGetDynamicEndpoints
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update Bank Level Dynamic Endpoint Host
Update Bank Level dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
{
"host":"dynamic_entity"
}
-
CanUpdateBankLevelDynamicEndpoint
- Please login to request this Role
-
CanUpdateDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update Dynamic Endpoint Host
Update dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
{
"host":"dynamic_entity"
}
-
CanUpdateDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Create Bank Level Dynamic Endpoint
Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
If the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
Authentication is Mandatory
{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}
-
CanCreateBankLevelDynamicEndpoint
- Please login to request this Role
-
CanCreateDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09008: DynamicEndpoint already exists.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Create Dynamic Endpoint
Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
If the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
Authentication is Mandatory
{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}
-
CanCreateDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09008: DynamicEndpoint already exists.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete My Dynamic Endpoint
Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
- OBP-50000: Unknown Error.
Get Bank Level Dynamic Endpoints
Get Bank Level Dynamic Endpoints.
Authentication is Mandatory
{
"dynamic_endpoints":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}]
}
-
CanGetBankLevelDynamicEndpoints
- Please login to request this Role
-
CanGetDynamicEndpoints
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get Dynamic Endpoint
Get a Dynamic Endpoint.
Get one DynamicEndpoint,
Authentication is Mandatory
{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}
-
CanGetDynamicEndpoint
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get My Dynamic Endpoints
Get My Dynamic Endpoints.
Authentication is Mandatory
{
"dynamic_endpoints":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"dynamic_endpoint_id":"dynamic-endpoint-id",
"swagger_string":{
"swagger":"2.0",
"info":{
"title":"Bank Accounts (Dynamic Endpoint)",
"version":"1.0.0"
},
"definitions":{
"AccountName":{
"type":"object",
"properties":{
"name":{
"type":"string",
"example":"family account"
},
"balance":{
"type":"integer",
"format":"int64",
"example":1000.123
}
}
}
},
"paths":{
"/accounts":{
"post":{
"operationId":"POST_account",
"produces":["application/json"],
"responses":{
"201":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"POST Accounts",
"summary":"POST Accounts"
}
},
"/accounts/{account_id}":{
"get":{
"operationId":"GET_account",
"produces":["application/json"],
"responses":{
"200":{
"description":"Success Response",
"schema":{
"$ref":"#/definitions/AccountName"
}
}
},
"consumes":["application/json"],
"description":"Get Bank Account",
"summary":"Get Bank Account by Id"
}
}
},
"host":"obp_mock",
"schemes":["http","https"]
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.