Master Data Export API

This is included in the Master Data REST API (PL-AO-006). The available endpoints for this add-on package are listed below:

Company	Type	Link V1	Link V2
Retrieve company details	GET	/rest/api/bam/company	/rest/api/v2/bam/company
Retrieve list of custom fields assigned to company	GET	/rest/api/bam/company/custom-fields	/rest/api/v2/bam/company/custom-fields
Retrieve list of user groups assigned to company	GET	/rest/api/bam/company/user-group-assignments	/rest/api/v2/bam/company/user-group-assignments

Regions	Type	Link V1	Link V2
Retrieve list of regions	GET	/rest/api/bam/regions	/rest/api/v2/bam/regions
Retrieve a region by its identifier	GET	/rest/api/bam/regions/{regionId}	/rest/api/v2/bam/regions/{regionId}
Retrieve list of custom fields assigned to region	GET	/rest/api/bam/regions/{regionId}/custom-fields	/rest/api/v2/bam/regions/{regionId}/custom-fields
Retrieve list of user groups assigned to region	GET	/rest/api/bam/regions/{regionId}/user-group-assignments	/rest/api/v2/bam/regions/{regionId}/user-group-assignments

Legal Entities	Type	Link V1	Link V2
Retrieve list of legal entities	GET	/rest/api/bam/legal-entities	/rest/api/v2/bam/legal-entities
Retrieve legal entities by its identifier	GET	/rest/api/bam/legal-entities/{legalEntityId}	/rest/api/v2/bam/legal-entities/{legalEntityId}
Retrieve list of custom fields assigned to legal entity	GET	/rest/api/bam/legal-entities/{legalEntityId}/custom-fields	/rest/api/v2/bam/legal-entities/{legalEntityId}/custom-fields
Retrieve list of user groups assigned to legal entity	GET	/rest/api/bam/legal-entities/{legalEntityId}/user-group-assignments	/rest/api/v2/bam/legal-entities/{legalEntityId}/user-group-assignments
Retrieve list of legal entity bank relation	GET	/rest/api/bam/legal-entity-bank-relations	/rest/api/v2/bam/legal-entity-bank-relations
Retrieve a legal entity bank relation by its identifier	GET	/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}	/rest/api/v2/bam/legal-entity-bank-relations/{legalEntityBankId}
Retrieve list of custom fields assigned to legal entity bank relation	GET	/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}/custom-fields	/rest/api/v2/bam/legal-entity-bank-relations/{legalEntityBankId}/custom-fields
Retrieve list of user groups assigned to legal entity bank relationship	GET	/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}/user-group-assignments	/rest/api/v2/bam/legal-entity-bank-relations/{legalEntityBankId}/user-group-assignments
Retrieve list of legal entity partner relation	GET	/rest/api/bam/legal-entity-partner-relations	/rest/api/v2/bam/legal-entity-partner-relations
Retrieve a legal entity partner relation by its identifier	GET	/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}	/rest/api/v2/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}
Retrieve list of custom fields assigned to legal entity partner relation	GET	/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/custom-fields	/rest/api/v2/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/custom-fields
Retrieve list of user groups assigned to legal entity partner relationship	GET	/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/user-group-assignments	/rest/api/v2/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/user-group-assignments

Banks	Type	Link V1	Link V2
Retrieve list of banks	GET	/rest/api/bam/banks	/rest/api/v2/bam/banks
Retrieve bank by identifier	GET	/rest/api/bam/banks/{bankId}	/rest/api/bam/v2/banks/{bankId}
Retrieve list of custom fields assigned to bank	GET	/rest/api/bam/banks/{bankId}/custom-fields	/rest/api/v2/bam/banks/{bankId}/custom-fields
Retrieve list of user groups assigned to bank	GET	/rest/api/bam/banks/{bankId}/user-group-assignments	/rest/api/v2/bam/banks/{bankId}/user-group-assignments

Bank Account	Type	Link V1	Link V2
Retrieve list of bank accounts	GET	/rest/api/bam/bank-accounts	/rest/api/v2/bam/bank-accounts
Retrieve a bank account by its identifier	GET	/rest/api/bam/bank-accounts/{bankAccountId}	/rest/api/v2/bam/bank-accounts/{bankAccountId}
Retrieve a confirmation of a bank account closure	GET	/rest/api/bam/bank-accounts/{bankAccountId}/close	/rest/api/v2/bam/bank-accounts/{bankAccountId}/close
Retrieve list of custom fields assigned to bank account	GET	/rest/api/bam/bank-accounts/{bankAccountId}/custom-fields	/rest/api/v2/bam/bank-accounts/{bankAccountId}/custom-fields
Retrieve list of user groups assigned to bank account	GET	/rest/api/bam/bank-accounts/{bankAccountId}/user-group-assignments	/rest/api/v2/bam/bank-accounts/{bankAccountId}/user-group-assignments

Bank Group	Type	Link V1	Link V2
Retrieve list of bank groups	GET	/rest/api/bam/bank-groups	/rest/api/v2/bam/bank-groups
Retrieve a bank group by its identifier	GET	/rest/api/bam/bank-groups/{bankGroupId}	/rest/api/v2/bam/bank-groups/{bankGroupId}
Retrieve list of custom fields assigned to bank group	GET	/rest/api/bam/bank-groups/{bankGroupId}/custom-fields	/rest/api/v2/bam/bank-groups/{bankGroupId}/custom-fields

Global Partner	Type	Link V1	Link V2
Retrieve list of global partners	GET	/rest/api/bam/partners	/rest/api/v2/bam/partners
Retrieve a global partner by the identifier	GET	/rest/api/bam/partners/{partnerId}	/rest/api/v2/bam/partners/{partnerId}
Retrieve list of custom fields assigned to global partner	GET	/rest/api/bam/partners/{partnerId}/custom-fields	/rest/api/v2/bam/partners/{partnerId}/custom-fields
Retrieve a list of user groups assigned to global partner	GET	/rest/api/bam/partners/{partnerId}/user-group-assignments	/rest/api/v2/bam/partners/{partnerId}/user-group-assignments

Local Partner	Type	Link V1	Link V2
Retrieve list of local partners	GET	/rest/api/bam/local-partners	/rest/api/v2/bam/local-partners
Retrieve a local partner by its identifier	GET	/rest/api/bam/local-partners/{localPartnerId}	/rest/api/v2/bam/local-partners/{localPartnerId}
Retrieve list of custom fields assigned to local partner	GET	/rest/api/bam/local-partners/{localPartnerId}/custom-fields	/rest/api/v2/bam/local-partners/{localPartnerId}/custom-fields
Retrieve list of user groups assigned to local partner	GET	/rest/api/bam/local-partners/{localPartnerId}/user-group-assignments	/rest/api/v2/bam/local-partners/{localPartnerId}/user-group-assignments

Persons	Type	Link V1	Link V2
Retrieve list of persons	GET	/rest/api/bam/persons	/rest/api/v2/bam/persons
Retrieve a person by its identifier	GET	/rest/api/bam/persons/{personId}	/rest/api/v2/bam/persons/{personId}
Retrieve list of custom fields assigned to a person	GET	/rest/api/bam/persons/{personId}/custom-fields	/rest/api/v2/bam/persons/{personId}/custom-fields
Retrieve list of user groups assigned to person	GET	/rest/api/bam/persons/{personId}/user-group-assignments	/rest/api/v2/bam/persons/{personId}/user-group-assignments

Custom Fields	Type	Link V1	Link V2
Retrieve list of custom fields configuration	GET	/rest/api/bam/custom-fields-configs/{configEntity}	/rest/api/v2/bam/custom-fields-configs/{configEntity}

Updated 5 days ago

Did this page help you?