v4.0.0 filtered by tags: API ... (38 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug", "remote_data_secret_matched":true }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }], "scopes":{ "require_scopes_for_all_roles":true, "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"] } }
Required Roles:
  • CanGetConfig - 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:
Version: OBPv3.1.0, function_name: by config, operation_id: OBPv3.1.0-config Tags: API, New-Style,

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Hosted at information
  • Energy source information
  • Git Commit

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" }, "hosted_at":{ "organisation":"Amazon", "organisation_website":"https://aws.amazon.com/" }, "energy_source":{ "organisation":"Stromio", "organisation_website":"https://www.stromio.de/" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Connector Methods:
Version: OBPv4.0.0, function_name: by root, operation_id: OBPv4.0.0-root Tags: API, New-Style,

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Version: OBPv3.1.0, function_name: by getAdapterInfo, operation_id: OBPv3.1.0-getAdapterInfo Tags: API, New-Style,

Get Adapter Info for a bank

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Optional

URL Parameters:

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Version: OBPv3.0.0, function_name: by getAdapterInfoForBank, operation_id: OBPv3.0.0-getAdapterInfoForBank Tags: API, New-Style,

Get Connector Status (Loopback)

This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.

Currently this is only implemented for Kafka based connectors.

For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.

In the future, this endpoint may also return information about database connections etc.

Authentication is Mandatory

JSON response body fields:

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
Typical Successful Response:

								
									
{ "connector_version":"kafka_vSept2018", "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0", "duration_time":"10 ms" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by getObpConnectorLoopback, operation_id: OBPv3.1.0-getObpConnectorLoopback Tags: API, New-Style,

Get JSON Web Key (JWK)

Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "kty":"RSA", "e":"AQAB", "use":"sig", "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s", "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getServerJWK, operation_id: OBPv3.1.0-getServerJWK Tags: API, Account Information Service (AIS), PSD2, New-Style,

Get JSON Web Key (JWK) URIs

Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "jwks_uris":[{ "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getOAuth2ServerJWKsURIs, operation_id: OBPv3.1.0-getOAuth2ServerJWKsURIs Tags: API, New-Style,

Get Mapper Database Info

Get basic information about the Mapper Database.

Authentication is Mandatory

JSON response body fields:

  • date: 2020-01-27

  • git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Required Roles:
  • CanGetDatabaseInfo - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getMapperDatabaseInfo, operation_id: OBPv4.0.0-getMapperDatabaseInfo Tags: API, New-Style,

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "enabled":true, "technology":"REDIS", "service_available":true, "is_active":true }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo Tags: API, New-Style,

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanGetCallContext - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCallContext, operation_id: OBPv4.0.0-getCallContext Tags: API, New-Style,

Verify Request and Sign Response of a current call

Verify Request and Sign Response of a current call.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by verifyRequestSignResponse, operation_id: OBPv4.0.0-verifyRequestSignResponse Tags: API, New-Style,

Get Message Docs

These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed.

CONNECTOR:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018, stored_procedure_vDec2019 ...

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "message_docs":[{ "process":"getAccounts", "message_format":"KafkaV2017", "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts", "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" }, "adapter_implementation":{ "group":"CORE", "suggested_order":3 }, "dependent_endpoints":[{ "name":"getAccounts", "version":"OBPv3.0.0" },{ "name":"getBalances", "version":"OBPv2.0.0" }], "requiredFieldInfo":{ "data.bankId":["v2.2.0","v3.1.0"] } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API, New-Style,

Get Message Docs Swagger

This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.

This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.

i.e.:

OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "message_docs":[{ "process":"getAccounts", "message_format":"KafkaV2017", "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts", "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" }, "adapter_implementation":{ "group":"CORE", "suggested_order":3 }, "dependent_endpoints":[{ "name":"getAccounts", "version":"OBPv3.0.0" },{ "name":"getBalances", "version":"OBPv2.0.0" }], "requiredFieldInfo":{ "data.bankId":["v2.2.0","v3.1.0"] } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMessageDocsSwagger, operation_id: OBPv3.1.0-getMessageDocsSwagger Tags: Documentation, API, New-Style,

Get Resource Docs

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support en and zh , e.g. ?language=zh

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Following are more examples:
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
  • specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsObp, operation_id: OBPv1.4.0-getResourceDocsObp Tags: Documentation, API,

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Following are more examples:
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.4.0, function_name: by getResourceDocsSwagger, operation_id: OBPv1.4.0-getResourceDocsSwagger Tags: Documentation, API,

Get scanned API Versions

Get all the scanned API Versions.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									
{ "scanned_api_versions":[{ "urlPrefix":"obp", "apiStandard":"obp", "apiShortVersion":"v3.1.0", "API_VERSION":"v3.1.0" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getScannedApiVersions, operation_id: OBPv4.0.0-getScannedApiVersions Tags: Documentation, API,

Create Dynamic Entity

Create a DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CRUD endpoints will be generated automatically

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField10": {
    "type": "reference:Bank",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField11": {
    "type": "reference:Consumer",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField12": {
    "type": "reference:Customer",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField13": {
    "type": "reference:MethodRouting",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField14": {
    "type": "reference:DynamicEntity",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField15": {
    "type": "reference:TransactionRequest",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField16": {
    "type": "reference:ProductAttribute",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField17": {
    "type": "reference:AccountAttribute",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField18": {
    "type": "reference:TransactionAttribute",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField19": {
    "type": "reference:CustomerAttribute",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField20": {
    "type": "reference:AccountApplication",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField21": {
    "type": "reference:CardAttribute",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField22": {
    "type": "reference:Counterparty",
    "example": "7285805f-bb47-49d5-a547-a0bd0f125fdf"
}

"someField23": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&branchId=63dabde5-bd1b-49dc-9408-540deb3836a1"
}

"someField24": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&atmId=63dabde5-bd1b-49dc-9408-540deb3836a1"
}

"someField25": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&accountId=63dabde5-bd1b-49dc-9408-540deb3836a1"
}

"someField26": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&productCode=63dabde5-bd1b-49dc-9408-540deb3836a1"
}

"someField27": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&cardId=63dabde5-bd1b-49dc-9408-540deb3836a1"
}

"someField28": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&accountId=63dabde5-bd1b-49dc-9408-540deb3836a1&transactionId=8e9a6f23-75e0-4fd4-8e2c-10f70617194f"
}

"someField29": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=7285805f-bb47-49d5-a547-a0bd0f125fdf&accountId=63dabde5-bd1b-49dc-9408-540deb3836a1&counterpartyId=8e9a6f23-75e0-4fd4-8e2c-10f70617194f"
}

Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanCreateDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createDynamicEntity, operation_id: OBPv4.0.0-createDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEntity - 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.
Version: OBPv4.0.0, function_name: by deleteDynamicEntity, operation_id: OBPv4.0.0-deleteDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Version: OBPv4.0.0, function_name: by deleteMyDynamicEntity, operation_id: OBPv4.0.0-deleteMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetBankLevelDynamicEntities - 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:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get Dynamic Entities

Get the all Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Required Roles:
  • CanGetDynamicEntities - 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:
Version: OBPv4.0.0, function_name: by getDynamicEntities, operation_id: OBPv4.0.0-getDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyDynamicEntities, operation_id: OBPv4.0.0-getMyDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Update Dynamic Entity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField10": {
    "type": "reference:Bank",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField11": {
    "type": "reference:Consumer",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField12": {
    "type": "reference:Customer",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField13": {
    "type": "reference:MethodRouting",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField14": {
    "type": "reference:DynamicEntity",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField15": {
    "type": "reference:TransactionRequest",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField16": {
    "type": "reference:ProductAttribute",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField17": {
    "type": "reference:AccountAttribute",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField18": {
    "type": "reference:TransactionAttribute",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField19": {
    "type": "reference:CustomerAttribute",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField20": {
    "type": "reference:AccountApplication",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField21": {
    "type": "reference:CardAttribute",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField22": {
    "type": "reference:Counterparty",
    "example": "4a23cfa9-8b96-4477-b898-6b7cc06ceb95"
}

"someField23": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&branchId=b173f396-427f-4b34-8efb-e91356b8e7b3"
}

"someField24": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&atmId=b173f396-427f-4b34-8efb-e91356b8e7b3"
}

"someField25": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&accountId=b173f396-427f-4b34-8efb-e91356b8e7b3"
}

"someField26": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&productCode=b173f396-427f-4b34-8efb-e91356b8e7b3"
}

"someField27": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&cardId=b173f396-427f-4b34-8efb-e91356b8e7b3"
}

"someField28": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&accountId=b173f396-427f-4b34-8efb-e91356b8e7b3&transactionId=e0a9f906-393e-41e3-a5a4-30c7db1c7177"
}

"someField29": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=4a23cfa9-8b96-4477-b898-6b7cc06ceb95&accountId=b173f396-427f-4b34-8efb-e91356b8e7b3&counterpartyId=e0a9f906-393e-41e3-a5a4-30c7db1c7177"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Required Roles:
  • CanUpdateDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEntity, operation_id: OBPv4.0.0-updateDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Update My Dynamic Entity

Update my DynamicEntity.

Authentication is Mandatory

Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support filed types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField10": {
    "type": "reference:Bank",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField11": {
    "type": "reference:Consumer",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField12": {
    "type": "reference:Customer",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField13": {
    "type": "reference:MethodRouting",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField14": {
    "type": "reference:DynamicEntity",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField15": {
    "type": "reference:TransactionRequest",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField16": {
    "type": "reference:ProductAttribute",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField17": {
    "type": "reference:AccountAttribute",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField18": {
    "type": "reference:TransactionAttribute",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField19": {
    "type": "reference:CustomerAttribute",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField20": {
    "type": "reference:AccountApplication",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField21": {
    "type": "reference:CardAttribute",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField22": {
    "type": "reference:Counterparty",
    "example": "972c3928-6078-4e87-be40-de76e3a61208"
}

"someField23": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&branchId=48a50d34-9285-4e0c-b34f-43712604d990"
}

"someField24": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&atmId=48a50d34-9285-4e0c-b34f-43712604d990"
}

"someField25": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&accountId=48a50d34-9285-4e0c-b34f-43712604d990"
}

"someField26": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&productCode=48a50d34-9285-4e0c-b34f-43712604d990"
}

"someField27": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&cardId=48a50d34-9285-4e0c-b34f-43712604d990"
}

"someField28": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&accountId=48a50d34-9285-4e0c-b34f-43712604d990&transactionId=a24d8cab-082d-44f4-8300-0fa234c1c6e0"
}

"someField29": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=972c3928-6078-4e87-be40-de76e3a61208&accountId=48a50d34-9285-4e0c-b34f-43712604d990&counterpartyId=a24d8cab-082d-44f4-8300-0fa234c1c6e0"
}

Typical Successful Response:

								
									
{ "bankId":"gh.29.uk", "FooBar":{ "description":"description of this entity, can be markdown text.", "required":["name"], "properties":{ "name":{ "type":"string", "minLength":3, "maxLength":20, "example":"James Brown", "description":"description of **name** field, can be markdown text." }, "number":{ "type":"integer", "example":698761728, "description":"description of **number** field, can be markdown text." } } }, "dynamicEntityId":"dynamic-entity-id", "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateMyDynamicEntity, operation_id: OBPv4.0.0-updateMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Create Dynamic Endpoint

Create dynamic endpoints.

Create dynamic endpoints with one json format swagger content.

If the host of swagger is dynamic_entity, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping endpoints.

If the host of swagger is obp_mock, every dynamic endpoint will return example response of swagger,

when create MethodRouting for given dynamic endpoint, it will be routed to given url.

Authentication is Mandatory

Typical Successful Response:

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

Delete Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteDynamicEndpoint, operation_id: OBPv4.0.0-deleteDynamicEndpoint Tags: Dynamic-Swagger-Doc-Manage, API, New-Style,

Get Dynamic Endpoint

Get a Dynamic Endpoint.

Get one DynamicEndpoint,

Authentication is Mandatory

Typical Successful Response:

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

Get Dynamic Endpoints

Get Dynamic Endpoints.

Authentication is Mandatory

Typical Successful Response:

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

Update Dynamic Endpoint Host

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "host":"dynamic_entity" }
Required Roles:
  • CanUpdateDynamicEndpoint - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateDynamicEndpointHost, operation_id: OBPv4.0.0-updateDynamicEndpointHost Tags: Dynamic-Swagger-Doc-Manage, API, New-Style,

Delete My Dynamic Endpoint

Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteMyDynamicEndpoint, operation_id: OBPv4.0.0-deleteMyDynamicEndpoint Tags: Dynamic-Swagger-Doc-Manage, API, New-Style,

Get My Dynamic Endpoints

Get My Dynamic Endpoints.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

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

Create MethodRouting

Create a MethodRouting.

Authentication is Mandatory

Explanation of Fields:

  • method_name is required String value, current supported value: [mapped]
  • connector_name is required String value
  • is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
  • bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
  • parameters is optional array of key value pairs. You can set some parameters for this method

note and CAVEAT!:

  • bank_id_pattern has to be empty for methods that do not take bank_id as a function parameter, otherwise might get empty result
  • methods that aggregate bank objects (e.g. getBankAccountsForUser) have to take any existing method routings for these objects into consideration
  • so if you create e.g. a bank specific method routing for getting an account, make sure that it is also served by endpoints getting ALL accounts for ALL banks
  • if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\d+"

If the connector name starts with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Snipaste_outBoundMapping
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root

inBoundMapping example, convert json from source to target:
inBoundMapping
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "is_bank_id_exact_match":false, "method_name":"getBank", "connector_name":"rest_vMar2019", "method_routing_id":"this-method-routing-Id", "bank_id_pattern":"some_bankId_.*", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }
Required Roles:
  • CanCreateMethodRouting - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-10021: Incorrect Connector name.
  • OBP-10022: Incorrect Connector method name.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createMethodRouting, operation_id: OBPv3.1.0-createMethodRouting Tags: Method-Routing, API, New-Style,

Delete MethodRouting

Delete a MethodRouting specified by METHOD_ROUTING_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteMethodRouting - 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:
Version: OBPv3.1.0, function_name: by deleteMethodRouting, operation_id: OBPv3.1.0-deleteMethodRouting Tags: Method-Routing, API, New-Style,

Get MethodRoutings

Get the all MethodRoutings.

Query url parameters:

  • method_name: filter with method_name
  • active: if active = true, it will show all the webui_ props. Even if they are set yet, we will return all the default webui_ props

eg:
https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?active=true
https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "method_routings":[{ "is_bank_id_exact_match":false, "method_name":"getBanks", "connector_name":"rest_vMar2019", "method_routing_id":"method-routing-id", "bank_id_pattern":"some_bank_.*", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }] }
Required Roles:
  • CanGetMethodRoutings - 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:
Version: OBPv3.1.0, function_name: by getMethodRoutings, operation_id: OBPv3.1.0-getMethodRoutings Tags: Method-Routing, API, New-Style,

Update MethodRouting

Update a MethodRouting.

Authentication is Mandatory

Explaination of Fields:

  • method_name is required String value, current supported value: [mapped]
  • connector_name is required String value
  • is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
  • bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
  • parameters is optional array of key value pairs. You can set some paremeters for this method
    note:
  • if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\d+"

If connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Snipaste_outBoundMapping
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root

inBoundMapping example, convert json from source to target:
inBoundMapping
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "is_bank_id_exact_match":true, "method_name":"getBank", "connector_name":"rest_vMar2019", "method_routing_id":"this-method-routing-Id", "bank_id_pattern":"some_bankId", "parameters":[{ "key":"url", "value":"http://mydomain.com/xxx" }] }
Required Roles:
  • CanUpdateMethodRouting - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-10021: Incorrect Connector name.
  • OBP-10022: Incorrect Connector method name.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateMethodRouting, operation_id: OBPv3.1.0-updateMethodRouting Tags: Method-Routing, API, New-Style,

Get Connector Metrics

Get the all metrics

require CanGetConnectorMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics

Should be able to filter on the following metrics fields

eg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z

2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z

3 limit (for pagination: defaults to 1000) eg:limit=2000

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

eg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=100&offset=300

Other filters:

5 connector_name (if null ignore)

6 function_name (if null ignore)

7 correlation_id (if null ignore)

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "metrics":[{ "connector_name":"mapper", "function_name":"getBanks", "correlation_id":"12345", "date":"2017-09-19T00:00:00Z", "duration":1000 }] }
Required Roles:
  • CanGetConnectorMetrics - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10005: Invalid Date Format. Could not convert value to a Date.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.2.0, function_name: by getConnectorMetrics, operation_id: OBPv2.2.0-getConnectorMetrics Tags: Metric, API, New-Style,

Get Metrics

Get the all metrics

require CanReadMetrics role

Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics

Should be able to filter on the following metrics fields

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z

2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z

3 limit (for pagination: defaults to 50) eg:limit=200

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"user_name",
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"

6 direction (defaults to date desc) eg: direction=desc

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78

Other filters:

7 consumer_id (if null ignore)

8 user_id (if null ignore)

9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)

10 url (if null ignore), note: can not contain '&'.

11 app_name (if null ignore)

12 implemented_by_partial_function (if null ignore),

13 implemented_in_version (if null ignore)

14 verb (if null ignore)

15 correlation_id (if null ignore)

16 duration (if null ignore) non digit chars will be silently omitted

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "metrics":[{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "url":"www.openbankproject.com", "date":"2017-09-19T00:00:00Z", "user_name":"OBP", "app_name":"SOFI", "developer_email":"felixsmith@example.com", "implemented_by_partial_function":"getBanks", "implemented_in_version":"v210", "consumer_id":"123", "verb":"get", "correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1", "duration":39 }] }
Required Roles:
  • CanReadMetrics - 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:
Version: OBPv2.1.0, function_name: by getMetrics, operation_id: OBPv2.1.0-getMetrics Tags: Metric, API, New-Style,

Search API Metrics via Elasticsearch

Search the API calls made to this API instance via Elastic Search.

Login is required.

CanSearchMetrics entitlement is required to search metrics data.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

example usage:

/search/metrics/q=findThis

or:

/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

  • For { use %7B
  • For } use %7D
  • For : use %3A
  • For " use %22

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanSearchMetrics - 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:
Version: OBPv2.0.0, function_name: by elasticSearchMetrics, operation_id: OBPv2.0.0-elasticSearchMetrics Tags: Metric, API,