API Explorer

v4.0.0 (400 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Add A New Pet To The Store

Add a new pet to the store

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanCreateDynamicEndpoint_Pet151 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_pet, operation_id: OBPv4.0.0-dynamicEndpoint_POST_pet

Create User

This can only be done by the logged in user.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
"successful operation"
Required Roles:
  • CanCreateDynamicEndpoint_User470 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_user, operation_id: OBPv4.0.0-dynamicEndpoint_POST_user

Creates List Of Users With Given Input Array

Creates list of users with given input array

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/createWithList"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
"successful operation"
Required Roles:
  • CanCreateDynamicEndpoint_UsersWithListInput175 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_user_createWithList, operation_id: OBPv4.0.0-dynamicEndpoint_POST_user_createWithList

Creates List Of Users With Given Input Array

Creates list of users with given input array

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/createWithArray"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
"successful operation"
Required Roles:
  • CanCreateDynamicEndpoint_UsersWithArrayInput135 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_user_createWithArray, operation_id: OBPv4.0.0-dynamicEndpoint_POST_user_createWithArray

Delete Purchase Order By Id

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/store/order/{orderId}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint_Order133 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_DELETE_store_order_ORDER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_store_order_ORDER_ID

Delete User

This can only be done by the logged in user.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/{username}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint_User112 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_DELETE_user_USERNAME, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_user_USERNAME

Deletes A Pet

Deletes a pet

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/{petId}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint_Pet160 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_DELETE_pet_PET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_pet_PET_ID

Find Pet By Id

Returns a single pet

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/{petId}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "id":1, "category":{ "id":1, "name":"string" }, "name":"doggie", "photoUrls":["string"], "tags":[{ "id":1, "name":"string" }], "status":"available" }
Required Roles:
  • CanGetDynamicEndpoint_PetById160 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_pet_PET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID

Find Purchase Order By Id

For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/store/order/{orderId}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "id":1, "petId":1, "quantity":1, "shipDate":"2021-01-26T06:26:23Z", "status":"placed", "complete":true }
Required Roles:
  • CanGetDynamicEndpoint_OrderById133 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_store_order_ORDER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_store_order_ORDER_ID

Finds Pets By Status

Multiple status values can be provided with comma separated strings

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/findByStatus"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
[{ "id":1, "category":{ "id":1, "name":"string" }, "name":"doggie", "photoUrls":["string"], "tags":[{ "id":1, "name":"string" }], "status":"available" }]
Required Roles:
  • CanGetDynamicEndpoint_PetsByStatus199 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_pet_findByStatus, operation_id: OBPv4.0.0-dynamicEndpoint_GET_pet_findByStatus

Finds Pets By Tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/findByTags"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
[{ "id":1, "category":{ "id":1, "name":"string" }, "name":"doggie", "photoUrls":["string"], "tags":[{ "id":1, "name":"string" }], "status":"available" }]
Required Roles:
  • CanGetDynamicEndpoint_PetsByTags636 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_pet_findByTags, operation_id: OBPv4.0.0-dynamicEndpoint_GET_pet_findByTags

Get User By User Name

Get user by user name

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/{username}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "id":1, "username":"string", "firstName":"string", "lastName":"string", "email":"string", "password":"string", "phone":"string", "userStatus":1 }
Required Roles:
  • CanGetDynamicEndpoint_UserByName112 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_user_USERNAME, operation_id: OBPv4.0.0-dynamicEndpoint_GET_user_USERNAME

Logs Out Current Logged In User Session

Logs out current logged in user session

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/logout"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
"successful operation"
Required Roles:
  • CanGetDynamicEndpoint_LogoutUser176 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_user_logout, operation_id: OBPv4.0.0-dynamicEndpoint_GET_user_logout

Logs User Into The System

Logs user into the system

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/login"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
"string"
Required Roles:
  • CanGetDynamicEndpoint_LoginUser199 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_user_login, operation_id: OBPv4.0.0-dynamicEndpoint_GET_user_login

Place An Order For A Pet

Place an order for a pet

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/store/order"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "id":1, "petId":1, "quantity":1, "shipDate":"2021-01-26T06:26:23Z", "status":"placed", "complete":true }
Required Roles:
  • CanCreateDynamicEndpoint_PlaceOrder109 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_store_order, operation_id: OBPv4.0.0-dynamicEndpoint_POST_store_order

Returns Pet Inventories By Status

Returns a map of status codes to quantities

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/store/inventory"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "name":"John", "age":12 }
Required Roles:
  • CanGetDynamicEndpoint_Inventory386 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_GET_store_inventory, operation_id: OBPv4.0.0-dynamicEndpoint_GET_store_inventory

Update An Existing Pet

Update an existing pet

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanUpdateDynamicEndpoint_Pet151 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_PUT_pet, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_pet

Updated User

This can only be done by the logged in user.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/user/{username}"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanUpdateDynamicEndpoint_User112 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_PUT_user_USERNAME, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_user_USERNAME

Updates A Pet In The Store With Form Data

Updates a pet in the store with form data

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/{petId}"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanCreateDynamicEndpoint_PetWithForm160 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_pet_PET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_POST_pet_PET_ID

Uploads An Image

uploads an image

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://petstore.swagger.io/v2/pet/{petId}/uploadImage"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "code":1, "type":"string", "message":"string" }
Required Roles:
  • CanCreateDynamicEndpoint_UploadFile627 - 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-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEndpoint_POST_pet_PET_ID_uploadImage, operation_id: OBPv4.0.0-dynamicEndpoint_POST_pet_PET_ID_uploadImage