API Explorer

v4.0.0 (407 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Delete Bank Level Dynamic Endpoint

Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteBankLevelDynamicEndpoint - Please login to request this Role
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-deleteBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Delete Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Bank Level Dynamic Endpoint

Get a Bank Level Dynamic Endpoint.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }
Required Roles:
  • CanGetBankLevelDynamicEndpoint - Please login to request this Role
  • CanGetDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Dynamic Endpoint

Get a Dynamic Endpoint.

Get one DynamicEndpoint,

Authentication is Mandatory

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }
Required Roles:
  • CanGetDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoint, operation_id: OBPv4.0.0-getDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Dynamic Endpoints

Get Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }] }
Required Roles:
  • CanGetDynamicEndpoints - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicEndpoints, operation_id: OBPv4.0.0-getDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,

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

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateBankLevelDynamicEndpoint - Please login to request this Role
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEndpointHost, operation_id: OBPv4.0.0-updateBankLevelDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API, New-Style,

Update Dynamic Endpoint Host

Update dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEndpointHost, operation_id: OBPv4.0.0-updateDynamicEndpointHost Tags: Dynamic-Endpoint-Manage, API, New-Style,

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

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }
Required Roles:
  • CanCreateBankLevelDynamicEndpoint - Please login to request this Role
  • CanCreateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEndpoint, operation_id: OBPv4.0.0-createBankLevelDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

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

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }
Required Roles:
  • CanCreateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEndpoint, operation_id: OBPv4.0.0-createDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Delete My Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get Bank Level Dynamic Endpoints

Get Bank Level Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }] }
Required Roles:
  • CanGetBankLevelDynamicEndpoints - Please login to request this Role
  • CanGetDynamicEndpoints - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEndpoints, operation_id: OBPv4.0.0-getBankLevelDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,

Get My Dynamic Endpoints

Get My Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_endpoints":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "dynamic_endpoint_id":"dynamic-endpoint-id", "swagger_string":{ "swagger":"2.0", "info":{ "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "version":"1.0.5", "title":"Swagger Petstore", "termsOfService":"http://swagger.io/terms/", "contact":{ "email":"apiteam@swagger.io" }, "license":{ "name":"Apache 2.0", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host":"petstore.swagger.io", "basePath":"/v2", "tags":[{ "name":"pet", "description":"Everything about your Pets", "externalDocs":{ "description":"Find out more", "url":"http://swagger.io" } },{ "name":"store", "description":"Access to Petstore orders" },{ "name":"user", "description":"Operations about user", "externalDocs":{ "description":"Find out more about our store", "url":"http://swagger.io" } }], "schemes":["https","http"], "paths":{ "/pet/{petId}/uploadImage":{ "post":{ "tags":["pet"], "summary":"uploads an image", "description":"", "operationId":"uploadFile", "consumes":["multipart/form-data"], "produces":["application/json"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to update", "required":true, "type":"integer", "format":"int64" },{ "name":"additionalMetadata", "in":"formData", "description":"Additional data to pass to server", "required":false, "type":"string" },{ "name":"file", "in":"formData", "description":"file to upload", "required":false, "type":"file" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApiResponse" } } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet":{ "post":{ "tags":["pet"], "summary":"Add a new pet to the store", "description":"", "operationId":"addPet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "put":{ "tags":["pet"], "summary":"Update an existing pet", "description":"", "operationId":"updatePet", "consumes":["application/json","application/xml"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Pet object that needs to be added to the store", "required":true, "schema":{ "$ref":"#/definitions/Pet" } }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" }, "405":{ "description":"Validation exception" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByStatus":{ "get":{ "tags":["pet"], "summary":"Finds Pets by status", "description":"Multiple status values can be provided with comma separated strings", "operationId":"findPetsByStatus", "produces":["application/json","application/xml"], "parameters":[{ "name":"status", "in":"query", "description":"Status values that need to be considered for filter", "required":true, "type":"array", "items":{ "type":"string", "enum":["available","pending","sold"], "default":"available" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid status value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/pet/findByTags":{ "get":{ "tags":["pet"], "summary":"Finds Pets by tags", "description":"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId":"findPetsByTags", "produces":["application/json","application/xml"], "parameters":[{ "name":"tags", "in":"query", "description":"Tags to filter by", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } }, "400":{ "description":"Invalid tag value" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }], "deprecated":true } }, "/pet/{petId}":{ "get":{ "tags":["pet"], "summary":"Find pet by ID", "description":"Returns a single pet", "operationId":"getPetById", "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet to return", "required":true, "type":"integer", "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Pet" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "api_key":[] }] }, "post":{ "tags":["pet"], "summary":"Updates a pet in the store with form data", "description":"", "operationId":"updatePetWithForm", "consumes":["application/x-www-form-urlencoded"], "produces":["application/json","application/xml"], "parameters":[{ "name":"petId", "in":"path", "description":"ID of pet that needs to be updated", "required":true, "type":"integer", "format":"int64" },{ "name":"name", "in":"formData", "description":"Updated name of the pet", "required":false, "type":"string" },{ "name":"status", "in":"formData", "description":"Updated status of the pet", "required":false, "type":"string" }], "responses":{ "405":{ "description":"Invalid input" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] }, "delete":{ "tags":["pet"], "summary":"Deletes a pet", "description":"", "operationId":"deletePet", "produces":["application/json","application/xml"], "parameters":[{ "name":"api_key", "in":"header", "required":false, "type":"string" },{ "name":"petId", "in":"path", "description":"Pet id to delete", "required":true, "type":"integer", "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Pet not found" } }, "security":[{ "petstore_auth":["write:pets","read:pets"] }] } }, "/store/order":{ "post":{ "tags":["store"], "summary":"Place an order for a pet", "description":"", "operationId":"placeOrder", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"order placed for purchasing the pet", "required":true, "schema":{ "$ref":"#/definitions/Order" } }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid Order" } } } }, "/store/order/{orderId}":{ "get":{ "tags":["store"], "summary":"Find purchase order by ID", "description":"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId":"getOrderById", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of pet that needs to be fetched", "required":true, "type":"integer", "maximum":10, "minimum":1, "format":"int64" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Order" } }, "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } }, "delete":{ "tags":["store"], "summary":"Delete purchase order by ID", "description":"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId":"deleteOrder", "produces":["application/json","application/xml"], "parameters":[{ "name":"orderId", "in":"path", "description":"ID of the order that needs to be deleted", "required":true, "type":"integer", "minimum":1, "format":"int64" }], "responses":{ "400":{ "description":"Invalid ID supplied" }, "404":{ "description":"Order not found" } } } }, "/store/inventory":{ "get":{ "tags":["store"], "summary":"Returns pet inventories by status", "description":"Returns a map of status codes to quantities", "operationId":"getInventory", "produces":["application/json"], "parameters":[], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "security":[{ "api_key":[] }] } }, "/user/createWithArray":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithArrayInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/createWithList":{ "post":{ "tags":["user"], "summary":"Creates list of users with given input array", "description":"", "operationId":"createUsersWithListInput", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"List of user object", "required":true, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/User" } } }], "responses":{ "default":{ "description":"successful operation" } } } }, "/user/{username}":{ "get":{ "tags":["user"], "summary":"Get user by user name", "description":"", "operationId":"getUserByName", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be fetched. Use user1 for testing. ", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/User" } }, "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } }, "put":{ "tags":["user"], "summary":"Updated user", "description":"This can only be done by the logged in user.", "operationId":"updateUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"name that need to be updated", "required":true, "type":"string" },{ "in":"body", "name":"body", "description":"Updated user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "400":{ "description":"Invalid user supplied" }, "404":{ "description":"User not found" } } }, "delete":{ "tags":["user"], "summary":"Delete user", "description":"This can only be done by the logged in user.", "operationId":"deleteUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"path", "description":"The name that needs to be deleted", "required":true, "type":"string" }], "responses":{ "400":{ "description":"Invalid username supplied" }, "404":{ "description":"User not found" } } } }, "/user/login":{ "get":{ "tags":["user"], "summary":"Logs user into the system", "description":"", "operationId":"loginUser", "produces":["application/json","application/xml"], "parameters":[{ "name":"username", "in":"query", "description":"The user name for login", "required":true, "type":"string" },{ "name":"password", "in":"query", "description":"The password for login in clear text", "required":true, "type":"string" }], "responses":{ "200":{ "description":"successful operation", "headers":{ "X-Expires-After":{ "type":"string", "format":"date-time", "description":"date in UTC when token expires" }, "X-Rate-Limit":{ "type":"integer", "format":"int32", "description":"calls per hour allowed by the user" } }, "schema":{ "type":"string" } }, "400":{ "description":"Invalid username/password supplied" } } } }, "/user/logout":{ "get":{ "tags":["user"], "summary":"Logs out current logged in user session", "description":"", "operationId":"logoutUser", "produces":["application/json","application/xml"], "parameters":[], "responses":{ "default":{ "description":"successful operation" } } } }, "/user":{ "post":{ "tags":["user"], "summary":"Create user", "description":"This can only be done by the logged in user.", "operationId":"createUser", "consumes":["application/json"], "produces":["application/json","application/xml"], "parameters":[{ "in":"body", "name":"body", "description":"Created user object", "required":true, "schema":{ "$ref":"#/definitions/User" } }], "responses":{ "default":{ "description":"successful operation" } } } } }, "securityDefinitions":{ "api_key":{ "type":"apiKey", "name":"api_key", "in":"header" }, "petstore_auth":{ "type":"oauth2", "authorizationUrl":"https://petstore.swagger.io/oauth/authorize", "flow":"implicit", "scopes":{ "read:pets":"read your pets", "write:pets":"modify pets in your account" } } }, "definitions":{ "ApiResponse":{ "type":"object", "properties":{ "code":{ "type":"integer", "format":"int32" }, "type":{ "type":"string" }, "message":{ "type":"string" } } }, "Category":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Category" } }, "Pet":{ "type":"object", "required":["name","photoUrls"], "properties":{ "id":{ "type":"integer", "format":"int64" }, "category":{ "$ref":"#/definitions/Category" }, "name":{ "type":"string", "example":"doggie" }, "photoUrls":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "type":"string", "xml":{ "name":"photoUrl" } } }, "tags":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "xml":{ "name":"tag" }, "$ref":"#/definitions/Tag" } }, "status":{ "type":"string", "description":"pet status in the store", "enum":["available","pending","sold"] } }, "xml":{ "name":"Pet" } }, "Tag":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" } }, "xml":{ "name":"Tag" } }, "Order":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "petId":{ "type":"integer", "format":"int64" }, "quantity":{ "type":"integer", "format":"int32" }, "shipDate":{ "type":"string", "format":"date-time" }, "status":{ "type":"string", "description":"Order Status", "enum":["placed","approved","delivered"] }, "complete":{ "type":"boolean" } }, "xml":{ "name":"Order" } }, "User":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "email":{ "type":"string" }, "password":{ "type":"string" }, "phone":{ "type":"string" }, "userStatus":{ "type":"integer", "format":"int32", "description":"User Status" } }, "xml":{ "name":"User" } } }, "externalDocs":{ "description":"Find out more about Swagger", "url":"http://swagger.io" } } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyDynamicEndpoints, operation_id: OBPv4.0.0-getMyDynamicEndpoints Tags: Dynamic-Endpoint-Manage, API, New-Style,