Skip to main content

Bulk domain object registration endpoint.

POST 
/v1/admin/mapping/customer/:arkId/load-data

Required User Role: ADMIN

This endpoint creates a collection of domain object instances for a nominated customer in the Ark platform and underlying connector databases. It accepts data values such as the following to establish the relevant Ark platform and connector data stores:

  • Ark customer identifier
  • Ark domain object type
  • Whether to generate a platform UUID for each entity

The domain object types supported by this endpoint are:

  • Card - This element is to be populated when the domain object is a card.

Based on the specified input parameters, the associated connector will be invoked to retrieve registered domain object instances. These items will be registered in the Ark platform (if required) and the associated connector database. A boolean flag will used to nominate if an external system identifier is to be generated for each entity. This is used to link the domain object instance to the connector system identifier (not always a possible solution for legacy implementations).

An optional request attribute of createUUID is used to specify if a UUID is to be generated for each entity. By default this is true but for solutions where generated UUID values are not a viable solution, the underlying core system identifier can be used. This is not a recommended solution and should only be used in legacy implementations where the UUID generation is not possible.

Request​

Responses​

The requested customer domain objects mapping were created successfully.

Last updated on