API Explorer
- API
- ATM
-
Account
- Check Available Funds
- Create Account (POST)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Attribute Definition
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN number
- Account Access
- Account Application
- Account Metadata
- Account Public
- Authentication Type Validation
- Bank
- Branch
- Card
- Consent
- Consumer
- Counterparty
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
- Add Social Media Handle
- Create Address
- Create Credit Limit Order Request
- Create Customer
- Create Customer Attribute
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Credit Limit Order Request By Request Id
- Get Credit Limit Order Requests
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers by ATTRIBUTES
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Firehose Customers
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Direct Debit
- Documentation
- Dynamic Endpoint (Manage)
- Dynamic Entity (Manage)
- Example Title
- FX
- JSON Schema Validation
- KYC
- Method Routing
- Metric
- Product
- Product Collection
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements for One Bank
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
- Sandbox
- Scope
- Standing Order
- Swagger Call getBanks
-
Transaction
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
- Transaction Metadata
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete User Auth Context
- Delete User's Auth Contexts
- Get Logout Link
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- View (Custom)
- View (System)
- WebUi Props
- Webhook
- _CreditApplicationForm
- _TESTING
-
API
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Mapper Database Info
-
Get Rate Limiting Info
-
Get the Call Context of a current call
-
Get API Configuration
-
ATM
-
Account
-
Check Available Funds
-
Create Account (POST)
-
Create Account Attribute
-
Create or Update Account Attribute Definition
-
Delete Account Attribute Definition
-
Delete Account Cascade
-
Get Account Attribute Definition
-
Get Account by Account Routing
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts Balances
-
Get Accounts Held
-
Get Accounts at Bank
-
Get Accounts at Bank (IDs only)
-
Get Accounts at Bank (Minimal)
-
Get Accounts at all Banks (private)
-
Get Checkbook orders
-
Get Firehose Accounts at Bank
-
Update Account
-
Update Account Attribute
-
Update Account Label
-
Validate and check IBAN number
-
Check Available Funds
-
Account Access
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Metadata
-
Account Public
-
Authentication Type Validation
-
Create a Authentication Type Validation
-
Delete a Authentication Type Validation
-
Get a Authentication Type Validation
-
Get all Authentication Type Validations
-
Update a Authentication Type Validation
-
Create a Authentication Type Validation
-
Bank
-
Create Bank
-
Create Settlement Account
-
Create Transaction Type at bank
-
Get Bank
-
Get Banks
-
Get Settlement accounts at Bank
-
Get Transaction Types at Bank
-
Create Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Create or Update Card Attribute Definition
-
Delete Card
-
Delete Card Attribute Definition
-
Get Card Attribute Definition
-
Get Card By Id
-
Get Cards for the specified bank
-
Get cards for the current user
-
Get status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
-
Consent
-
Add User to a Consent
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (SMS)
-
Get Consents
-
Revoke Consent
-
Update Consent Status
-
Add User to a Consent
-
Consumer
-
Enable or Disable Consumers
-
Get Call Limits for a Consumer
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Post a Consumer
-
Set Calls Limit for a Consumer
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Create Counterparty for any account (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (Explicit)
-
Get Counterparty by name for any account (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
Counterparty Metadata
-
Add Corporate Location to Counterparty
-
Add Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url to other bank account
-
Add physical location to other bank account
-
Add public alias to other bank account
-
Add url to other bank account
-
Create Other Account Private Alias
-
Delete Counterparty Corporate Location
-
Delete Counterparty Image URL
-
Delete Counterparty Open Corporates URL
-
Delete Counterparty Physical Location
-
Delete Counterparty Private Alias
-
Delete Counterparty Public Alias
-
Delete more info of other bank account
-
Delete url of other bank account
-
Get Other Account Metadata
-
Get Other Account Private Alias
-
Get public alias of other bank account
-
Update Counterparty Corporate Location
-
Update Counterparty Image Url
-
Update Counterparty More Info
-
Update Counterparty Physical Location
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Address
-
Create Credit Limit Order Request
-
Create Customer
-
Create Customer Attribute
-
Create Tax Residence
-
Create User Customer Link
-
Create or Update Customer Attribute Definition
-
Delete Customer Address
-
Delete Customer Attribute
-
Delete Customer Attribute Definition
-
Delete Tax Residence
-
Delete User Customer Link
-
Get CRM Events
-
Get Credit Limit Order Request By Request Id
-
Get Credit Limit Order Requests
-
Get Customer Addresses
-
Get Customer Attribute By Id
-
Get Customer Attribute Definition
-
Get Customer Attributes
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers by ATTRIBUTES
-
Get Customers by MOBILE_PHONE_NUMBER
-
Get Customers for Current User
-
Get Firehose Customers
-
Get Tax Residences of Customer
-
Get User Customer Links by Customer
-
Get User Customer Links by User
-
Update Customer Attribute
-
Update the Address of a Customer
-
Update the Branch of a Customer
-
Update the credit limit of a Customer
-
Update the credit rating and source of a Customer
-
Update the email of a Customer
-
Update the identity data of a Customer
-
Update the mobile number of a Customer
-
Update the number of a Customer
-
Update the other data of a Customer
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Direct Debit
-
Documentation
-
Get API Glossary
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Swagger documentation
-
Get scanned API Versions
-
Get API Glossary
-
Dynamic Endpoint (Manage)
-
Create Dynamic Endpoint
-
Delete Dynamic Endpoint
-
Get Dynamic Endpoint
-
Get Dynamic Endpoints
-
Delete My Dynamic Endpoint
-
Get My Dynamic Endpoints
-
Create Dynamic Endpoint
-
Dynamic Entity (Manage)
-
Create Dynamic Entity
-
Delete Dynamic Entity
-
Delete My Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get Dynamic Entities
-
Get My Dynamic Entities
-
Update Dynamic Entity
-
Update My Dynamic Entity
-
Create Dynamic Entity
-
Example Title
-
FX
-
JSON Schema Validation
-
Create a JSON Schema Validation
-
Delete a JSON Schema Validation
-
Get a JSON Schema Validation
-
Get all JSON Schema Validations
-
Update a JSON Schema Validation
-
Create a JSON Schema Validation
-
KYC
-
Add KYC Check
-
Add KYC Document
-
Add KYC Media
-
Add KYC Status
-
Get Customer KYC Checks
-
Get Customer KYC Documents
-
Get Customer KYC statuses
-
Get KYC Media for a customer
-
Add KYC Check
-
Method Routing
-
Metric
-
Get Aggregate Metrics
-
Get Connector Metrics
-
Get Metrics
-
Get Top APIs
-
Get Top Consumers
-
Search API Metrics via Elasticsearch
-
Get Aggregate Metrics
-
Product
-
Create Product
-
Create Product Attribute
-
Create or Update Product Attribute Definition
-
Delete Product Attribute
-
Delete Product Attribute Definition
-
Delete Product Cascade
-
Get Bank Product
-
Get Product Attribute
-
Get Product Attribute Definition
-
Get Product Tree
-
Get Products
-
Update Product Attribute
-
Create Product
-
Product Collection
-
Role
-
Add Entitlement for a User
-
Create Entitlement Request for current User
-
Delete Entitlement
-
Delete Entitlement Request
-
Get Entitlement Requests for a User
-
Get Entitlement Requests for the current User
-
Get Entitlements for One Bank
-
Get Entitlements for User
-
Get Entitlements for User at Bank
-
Get Entitlements for the current User
-
Get Roles
-
Get all Entitlement Requests
-
Get all Entitlements
-
Add Entitlement for a User
-
Sandbox
-
Scope
-
Standing Order
-
Swagger Call getBanks
-
Transaction
-
Create Transaction Attribute
-
Create or Update Transaction Attribute Definition
-
Delete Transaction Attribute Definition
-
Delete Transaction Cascade
-
Get Double Entry Transaction
-
Get Firehose Transactions for Account
-
Get Other Account of Transaction
-
Get Transaction Attribute By Id
-
Get Transaction Attribute Definition
-
Get Transaction Attributes
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Update Transaction Attribute
-
Create Transaction Attribute
-
Transaction Metadata
-
Add a tag
-
Add an image
-
Add comment
-
Add narrative
-
Add where tag
-
Delete a tag
-
Delete an image
-
Delete comment
-
Delete narrative
-
Delete where tag
-
Get comments
-
Get images
-
Get narrative
-
Get tags
-
Get where tag
-
Update narrative
-
Update where tag
-
Add a tag
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Transaction Request (ACCOUNT)
-
Create Transaction Request (ACCOUNT_OTP)
-
Create Transaction Request (COUNTERPARTY)
-
Create Transaction Request (FREE_FORM)
-
Create Transaction Request (REFUND)
-
Create Transaction Request (SANDBOX_TAN)
-
Create Transaction Request (SEPA)
-
Create Transaction Request Attribute
-
Create or Update Transaction Request Attribute Definition
-
Delete Transaction Request Attribute Definition
-
Get Transaction Request
-
Get Transaction Request Attribute By Id
-
Get Transaction Request Attribute Definition
-
Get Transaction Request Attributes
-
Get Transaction Request Types at Bank
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Save Historical Transactions
-
Update Transaction Request Attribute
-
Answer Transaction Request Challenge
-
User
-
Answer Auth Context Update Challenge
-
Create User
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Create password reset url
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Get Logout Link
-
Get User (Current)
-
Get User Auth Contexts
-
Get User Lock Status
-
Get User by USERNAME
-
Get User by USER_ID
-
Get Users by Email Address
-
Get all Users
-
Lock the user
-
Refresh User
-
Unlock the user
-
Answer Auth Context Update Challenge
-
View (Custom)
-
View (System)
-
WebUi Props
-
Webhook
-
_CreditApplicationForm
-
Create new Credit Application Form
-
Delete Credit Application Form by id
-
Get Credit Application Form List
-
Get Credit Application Form by id
-
Update Credit Application Form
-
Create new Credit Application Form
-
_TESTING
v4.0.0 (353 APIs)
API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions
Create Dynamic Endpoint
Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
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
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:
Implemented in OBPv4.0.0 by createDynamicEndpoint, operation_id: OBPv4.0.0-createDynamicEndpoint
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
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:
Implemented in OBPv4.0.0 by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint
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
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:
Implemented in OBPv4.0.0 by getDynamicEndpoint, operation_id: OBPv4.0.0-getDynamicEndpoint
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
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:
Implemented in OBPv4.0.0 by getDynamicEndpoints, operation_id: OBPv4.0.0-getDynamicEndpoints
Delete My Dynamic Endpoint
Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
Typical Successful Response:
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:
Implemented in OBPv4.0.0 by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint
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"
}
}
}]
}
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getMyDynamicEndpoints, operation_id: OBPv4.0.0-getMyDynamicEndpoints