obp_python.DynamicEntityManageApi

All URIs are relative to http://test.openbankproject.com

Method	HTTP request	Description
o_bpv4_0_0_create_bank_level_dynamic_entity	POST /obp/v5.0.0/management/banks/{BANK_ID}/dynamic-entities	Create Bank Level Dynamic Entity
o_bpv4_0_0_create_system_dynamic_entity	POST /obp/v5.0.0/management/system-dynamic-entities	Create System Level Dynamic Entity
o_bpv4_0_0_delete_bank_level_dynamic_entity	DELETE /obp/v5.0.0/management/banks/{BANK_ID}/dynamic-entities/{DYNAMIC_ENTITY_ID}	Delete Bank Level Dynamic Entity
o_bpv4_0_0_delete_my_dynamic_entity	DELETE /obp/v5.0.0/my/dynamic-entities/{DYNAMIC_ENTITY_ID}	Delete My Dynamic Entity
o_bpv4_0_0_delete_system_dynamic_entity	DELETE /obp/v5.0.0/management/system-dynamic-entities/{DYNAMIC_ENTITY_ID}	Delete System Level Dynamic Entity
o_bpv4_0_0_get_bank_level_dynamic_entities	GET /obp/v5.0.0/management/banks/{BANK_ID}/dynamic-entities	Get Bank Level Dynamic Entities
o_bpv4_0_0_get_my_dynamic_entities	GET /obp/v5.0.0/my/dynamic-entities	Get My Dynamic Entities
o_bpv4_0_0_get_system_dynamic_entities	GET /obp/v5.0.0/management/system-dynamic-entities	Get System Dynamic Entities
o_bpv4_0_0_update_bank_level_dynamic_entity	PUT /obp/v5.0.0/management/banks/{BANK_ID}/dynamic-entities/{DYNAMIC_ENTITY_ID}	Update Bank Level Dynamic Entity
o_bpv4_0_0_update_my_dynamic_entity	PUT /obp/v5.0.0/my/dynamic-entities/{DYNAMIC_ENTITY_ID}	Update My Dynamic Entity
o_bpv4_0_0_update_system_dynamic_entity	PUT /obp/v5.0.0/management/system-dynamic-entities/{DYNAMIC_ENTITY_ID}	Update System Level Dynamic Entity

o_bpv4_0_0_create_bank_level_dynamic_entity

DynamicEntityFooBar o_bpv4_0_0_create_bank_level_dynamic_entity(body, bank_id)

Create Bank Level Dynamic Entity

Create a Bank Level DynamicEntity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {    "type": "reference:Bank",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField1": {    "type": "reference:Consumer",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField2": {    "type": "reference:Customer",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField3": {    "type": "reference:MethodRouting",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField4": {    "type": "reference:DynamicEntity",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField5": {    "type": "reference:TransactionRequest",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField6": {    "type": "reference:ProductAttribute",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField7": {    "type": "reference:AccountAttribute",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField8": {    "type": "reference:TransactionAttribute",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField9": {    "type": "reference:CustomerAttribute",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField10": {    "type": "reference:AccountApplication",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField11": {    "type": "reference:CardAttribute",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField12": {    "type": "reference:Counterparty",    "example": "260e3831-4bdf-49a2-a807-1d7781fde395"}"someField13": {    "type": "reference:Branch:bankId&branchId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&branchId=8735b3b6-9b7f-425d-9041-f5932a9df7d8"}"someField14": {    "type": "reference:Atm:bankId&atmId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&atmId=8735b3b6-9b7f-425d-9041-f5932a9df7d8"}"someField15": {    "type": "reference:BankAccount:bankId&accountId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&accountId=8735b3b6-9b7f-425d-9041-f5932a9df7d8"}"someField16": {    "type": "reference:Product:bankId&productCode",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&productCode=8735b3b6-9b7f-425d-9041-f5932a9df7d8"}"someField17": {    "type": "reference:PhysicalCard:bankId&cardId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&cardId=8735b3b6-9b7f-425d-9041-f5932a9df7d8"}"someField18": {    "type": "reference:Transaction:bankId&accountId&transactionId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&accountId=8735b3b6-9b7f-425d-9041-f5932a9df7d8&transactionId=19f67d44-5abb-464d-a8a4-86892a7d24ae"}"someField19": {    "type": "reference:Counterparty:bankId&accountId&counterpartyId",    "example": "bankId=260e3831-4bdf-49a2-a807-1d7781fde395&accountId=8735b3b6-9b7f-425d-9041-f5932a9df7d8&counterpartyId=19f67d44-5abb-464d-a8a4-86892a7d24ae"}

Note: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
body = obp_python.DynamicEntityFooBar() # DynamicEntityFooBar | DynamicEntityFooBar object that needs to be added.
bank_id = 'bank_id_example' # str | The bank id

try:
    # Create Bank Level Dynamic Entity
    api_response = api_instance.o_bpv4_0_0_create_bank_level_dynamic_entity(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_create_bank_level_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	DynamicEntityFooBar	DynamicEntityFooBar object that needs to be added.
bank_id	str	The bank id

Return type

DynamicEntityFooBar

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_create_system_dynamic_entity

DynamicEntityFooBar o_bpv4_0_0_create_system_dynamic_entity(body)

Create System Level Dynamic Entity

Create a system level Dynamic Entity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
See the following list of currently available reference types and examples of how to construct key values correctly. Note: As more Dynamic Entities are created on this instance, this list will grow:

"someField0": {    "type": "reference:Bank",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField1": {    "type": "reference:Consumer",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField2": {    "type": "reference:Customer",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField3": {    "type": "reference:MethodRouting",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField4": {    "type": "reference:DynamicEntity",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField5": {    "type": "reference:TransactionRequest",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField6": {    "type": "reference:ProductAttribute",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField7": {    "type": "reference:AccountAttribute",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField8": {    "type": "reference:TransactionAttribute",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField9": {    "type": "reference:CustomerAttribute",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField10": {    "type": "reference:AccountApplication",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField11": {    "type": "reference:CardAttribute",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField12": {    "type": "reference:Counterparty",    "example": "2494121b-1bcc-4793-8d9e-6eb5f49f1b2c"}"someField13": {    "type": "reference:Branch:bankId&branchId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&branchId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78"}"someField14": {    "type": "reference:Atm:bankId&atmId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&atmId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78"}"someField15": {    "type": "reference:BankAccount:bankId&accountId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&accountId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78"}"someField16": {    "type": "reference:Product:bankId&productCode",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&productCode=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78"}"someField17": {    "type": "reference:PhysicalCard:bankId&cardId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&cardId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78"}"someField18": {    "type": "reference:Transaction:bankId&accountId&transactionId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&accountId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78&transactionId=45a74569-c3a2-4b82-8111-3f68a32e5d95"}"someField19": {    "type": "reference:Counterparty:bankId&accountId&counterpartyId",    "example": "bankId=2494121b-1bcc-4793-8d9e-6eb5f49f1b2c&accountId=8ab76ee8-0303-4fd3-a71c-c5c6f467cb78&counterpartyId=45a74569-c3a2-4b82-8111-3f68a32e5d95"}

Note: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
body = obp_python.DynamicEntityFooBar() # DynamicEntityFooBar | DynamicEntityFooBar object that needs to be added.

try:
    # Create System Level Dynamic Entity
    api_response = api_instance.o_bpv4_0_0_create_system_dynamic_entity(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_create_system_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	DynamicEntityFooBar	DynamicEntityFooBar object that needs to be added.

Return type

DynamicEntityFooBar

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_delete_bank_level_dynamic_entity

o_bpv4_0_0_delete_bank_level_dynamic_entity(dynamic_entity_id, bank_id)

Delete Bank Level Dynamic Entity

Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 
bank_id = 'bank_id_example' # str | The bank id

try:
    # Delete Bank Level Dynamic Entity
    api_instance.o_bpv4_0_0_delete_bank_level_dynamic_entity(dynamic_entity_id, bank_id)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_delete_bank_level_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
dynamic_entity_id	str	the dynamic entity id
bank_id	str	The bank id

Return type

void (empty response body)

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_delete_my_dynamic_entity

o_bpv4_0_0_delete_my_dynamic_entity(dynamic_entity_id)

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 

try:
    # Delete My Dynamic Entity
    api_instance.o_bpv4_0_0_delete_my_dynamic_entity(dynamic_entity_id)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_delete_my_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
dynamic_entity_id	str	the dynamic entity id

Return type

void (empty response body)

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_delete_system_dynamic_entity

o_bpv4_0_0_delete_system_dynamic_entity(dynamic_entity_id)

Delete System Level Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 

try:
    # Delete System Level Dynamic Entity
    api_instance.o_bpv4_0_0_delete_system_dynamic_entity(dynamic_entity_id)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_delete_system_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
dynamic_entity_id	str	the dynamic entity id

Return type

void (empty response body)

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_get_bank_level_dynamic_entities

InlineResponse2004 o_bpv4_0_0_get_bank_level_dynamic_entities(bank_id)

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities for one bank.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Bank Level Dynamic Entities
    api_response = api_instance.o_bpv4_0_0_get_bank_level_dynamic_entities(bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_get_bank_level_dynamic_entities: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

Return type

InlineResponse2004

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_get_my_dynamic_entities

InlineResponse2004 o_bpv4_0_0_get_my_dynamic_entities()

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))

try:
    # Get My Dynamic Entities
    api_response = api_instance.o_bpv4_0_0_get_my_dynamic_entities()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_get_my_dynamic_entities: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2004

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_get_system_dynamic_entities

InlineResponse2004 o_bpv4_0_0_get_system_dynamic_entities()

Get System Dynamic Entities

Get all System Dynamic Entities

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))

try:
    # Get System Dynamic Entities
    api_response = api_instance.o_bpv4_0_0_get_system_dynamic_entities()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_get_system_dynamic_entities: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2004

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_update_bank_level_dynamic_entity

DynamicEntityFooBar o_bpv4_0_0_update_bank_level_dynamic_entity(body, dynamic_entity_id, bank_id)

Update Bank Level Dynamic Entity

Update a Bank Level DynamicEntity.

Authentication is Mandatory

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

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {    "type": "reference:Bank",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField1": {    "type": "reference:Consumer",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField2": {    "type": "reference:Customer",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField3": {    "type": "reference:MethodRouting",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField4": {    "type": "reference:DynamicEntity",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField5": {    "type": "reference:TransactionRequest",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField6": {    "type": "reference:ProductAttribute",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField7": {    "type": "reference:AccountAttribute",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField8": {    "type": "reference:TransactionAttribute",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField9": {    "type": "reference:CustomerAttribute",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField10": {    "type": "reference:AccountApplication",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField11": {    "type": "reference:CardAttribute",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField12": {    "type": "reference:Counterparty",    "example": "56ea676b-9e92-4b47-b3cb-9ec259372581"}"someField13": {    "type": "reference:Branch:bankId&branchId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&branchId=6b433d26-692d-47d9-8433-bf8c8b249a4b"}"someField14": {    "type": "reference:Atm:bankId&atmId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&atmId=6b433d26-692d-47d9-8433-bf8c8b249a4b"}"someField15": {    "type": "reference:BankAccount:bankId&accountId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&accountId=6b433d26-692d-47d9-8433-bf8c8b249a4b"}"someField16": {    "type": "reference:Product:bankId&productCode",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&productCode=6b433d26-692d-47d9-8433-bf8c8b249a4b"}"someField17": {    "type": "reference:PhysicalCard:bankId&cardId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&cardId=6b433d26-692d-47d9-8433-bf8c8b249a4b"}"someField18": {    "type": "reference:Transaction:bankId&accountId&transactionId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&accountId=6b433d26-692d-47d9-8433-bf8c8b249a4b&transactionId=d69c95e9-6d71-4219-9d8a-d0dbe4014817"}"someField19": {    "type": "reference:Counterparty:bankId&accountId&counterpartyId",    "example": "bankId=56ea676b-9e92-4b47-b3cb-9ec259372581&accountId=6b433d26-692d-47d9-8433-bf8c8b249a4b&counterpartyId=d69c95e9-6d71-4219-9d8a-d0dbe4014817"}

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
body = obp_python.DynamicEntityFooBar() # DynamicEntityFooBar | DynamicEntityFooBar object that needs to be added.
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 
bank_id = 'bank_id_example' # str | The bank id

try:
    # Update Bank Level Dynamic Entity
    api_response = api_instance.o_bpv4_0_0_update_bank_level_dynamic_entity(body, dynamic_entity_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_update_bank_level_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description
body	DynamicEntityFooBar	DynamicEntityFooBar object that needs to be added.
dynamic_entity_id	str	the dynamic entity id
bank_id	str	The bank id

Return type

DynamicEntityFooBar

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_update_my_dynamic_entity

DynamicEntityFooBar o_bpv4_0_0_update_my_dynamic_entity(body, dynamic_entity_id)

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

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {    "type": "reference:Bank",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField1": {    "type": "reference:Consumer",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField2": {    "type": "reference:Customer",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField3": {    "type": "reference:MethodRouting",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField4": {    "type": "reference:DynamicEntity",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField5": {    "type": "reference:TransactionRequest",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField6": {    "type": "reference:ProductAttribute",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField7": {    "type": "reference:AccountAttribute",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField8": {    "type": "reference:TransactionAttribute",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField9": {    "type": "reference:CustomerAttribute",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField10": {    "type": "reference:AccountApplication",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField11": {    "type": "reference:CardAttribute",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField12": {    "type": "reference:Counterparty",    "example": "eebb4aa3-8b94-4c5c-aeee-e7849443f93f"}"someField13": {    "type": "reference:Branch:bankId&branchId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&branchId=26617f71-1ba3-4ecb-94d1-e784071c7e24"}"someField14": {    "type": "reference:Atm:bankId&atmId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&atmId=26617f71-1ba3-4ecb-94d1-e784071c7e24"}"someField15": {    "type": "reference:BankAccount:bankId&accountId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&accountId=26617f71-1ba3-4ecb-94d1-e784071c7e24"}"someField16": {    "type": "reference:Product:bankId&productCode",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&productCode=26617f71-1ba3-4ecb-94d1-e784071c7e24"}"someField17": {    "type": "reference:PhysicalCard:bankId&cardId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&cardId=26617f71-1ba3-4ecb-94d1-e784071c7e24"}"someField18": {    "type": "reference:Transaction:bankId&accountId&transactionId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&accountId=26617f71-1ba3-4ecb-94d1-e784071c7e24&transactionId=e0c520f5-8a29-4554-9a8b-8321b15bf478"}"someField19": {    "type": "reference:Counterparty:bankId&accountId&counterpartyId",    "example": "bankId=eebb4aa3-8b94-4c5c-aeee-e7849443f93f&accountId=26617f71-1ba3-4ecb-94d1-e784071c7e24&counterpartyId=e0c520f5-8a29-4554-9a8b-8321b15bf478"}

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
body = obp_python.DynamicEntityFooBar() # DynamicEntityFooBar | DynamicEntityFooBar object that needs to be added.
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 

try:
    # Update My Dynamic Entity
    api_response = api_instance.o_bpv4_0_0_update_my_dynamic_entity(body, dynamic_entity_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_update_my_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	DynamicEntityFooBar	DynamicEntityFooBar object that needs to be added.
dynamic_entity_id	str	the dynamic entity id

Return type

DynamicEntityFooBar

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

o_bpv4_0_0_update_system_dynamic_entity

DynamicEntityFooBar o_bpv4_0_0_update_system_dynamic_entity(body, dynamic_entity_id)

Update System Level Dynamic Entity

Update a System Level Dynamic Entity.

Authentication is Mandatory

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

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {    "type": "reference:Bank",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField1": {    "type": "reference:Consumer",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField2": {    "type": "reference:Customer",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField3": {    "type": "reference:MethodRouting",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField4": {    "type": "reference:DynamicEntity",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField5": {    "type": "reference:TransactionRequest",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField6": {    "type": "reference:ProductAttribute",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField7": {    "type": "reference:AccountAttribute",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField8": {    "type": "reference:TransactionAttribute",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField9": {    "type": "reference:CustomerAttribute",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField10": {    "type": "reference:AccountApplication",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField11": {    "type": "reference:CardAttribute",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField12": {    "type": "reference:Counterparty",    "example": "3c2723b2-a420-4c92-ad85-64e94bfe0168"}"someField13": {    "type": "reference:Branch:bankId&branchId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&branchId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458"}"someField14": {    "type": "reference:Atm:bankId&atmId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&atmId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458"}"someField15": {    "type": "reference:BankAccount:bankId&accountId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&accountId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458"}"someField16": {    "type": "reference:Product:bankId&productCode",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&productCode=4c8fbdd6-5397-4ab8-a7b2-9f127589a458"}"someField17": {    "type": "reference:PhysicalCard:bankId&cardId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&cardId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458"}"someField18": {    "type": "reference:Transaction:bankId&accountId&transactionId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&accountId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458&transactionId=cad30b93-7ba0-4287-9942-6e9c81925f8d"}"someField19": {    "type": "reference:Counterparty:bankId&accountId&counterpartyId",    "example": "bankId=3c2723b2-a420-4c92-ad85-64e94bfe0168&accountId=4c8fbdd6-5397-4ab8-a7b2-9f127589a458&counterpartyId=cad30b93-7ba0-4287-9942-6e9c81925f8d"}

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.DynamicEntityManageApi(obp_python.ApiClient(configuration))
body = obp_python.DynamicEntityFooBar() # DynamicEntityFooBar | DynamicEntityFooBar object that needs to be added.
dynamic_entity_id = 'dynamic_entity_id_example' # str | the dynamic entity id 

try:
    # Update System Level Dynamic Entity
    api_response = api_instance.o_bpv4_0_0_update_system_dynamic_entity(body, dynamic_entity_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DynamicEntityManageApi->o_bpv4_0_0_update_system_dynamic_entity: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	DynamicEntityFooBar	DynamicEntityFooBar object that needs to be added.
dynamic_entity_id	str	the dynamic entity id

Return type

DynamicEntityFooBar

Authorization

directLogin, gatewayLogin

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DynamicEntityManageApi.md

Latest commit

History

DynamicEntityManageApi.md

File metadata and controls

obp_python.DynamicEntityManageApi

o_bpv4_0_0_create_bank_level_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_create_system_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_delete_bank_level_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_delete_my_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_delete_system_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_get_bank_level_dynamic_entities

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_get_my_dynamic_entities

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_get_system_dynamic_entities

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_update_bank_level_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_update_my_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers

o_bpv4_0_0_update_system_dynamic_entity

Example

Parameters

Return type

Authorization

HTTP request headers