Reference 360

Back Next

Generate aliases for reference data assets

Generates aliases for all the existing predefined assets that don't have internal IDs by running an alias generation job.

POST request

To generate aliases for existing predefined assets, submit a POST request with the following URI:

/rdm-service/external/v1/assets/generateAliases?overwriteExisting=false

The following table describes the parameter in the request:

Parameter	Type	Description
overwriteExisting	Boolean	Optional. Indicates whether the job overwrites existing alias values. Set to false to skip overwriting the existing alias values and to generate alias only for predefined assets with no internal ID. Set to true to overwrite the existing alias values and to generate alias only for predefined assets with no internal ID. Default is false .

POST response

The response is in the JSON format.

The following table describes the attributes in the response body:

Field	Type	Description
jobId	String	ID of the alias generation job.
type	String	Type of the job. The supported value is ALIAS_GENERATION .
status	String	Status of the alias generation job. Value can be RUNNING , SUCCESS , FAILED , or CANCELLED .
createdBy	String	User name of the user who ran the alias generation job.
createdDate	String	Date when the user ran the alias generation job.

POST example

To generate aliases for existing predefined assets, you might use the following request:

{
   POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/assets/generateAliases?overwriteExisting=false",
   HTTP/1.1
   Accept: application/json
   IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the details of an alias generation job:

{
  "jobId": "663a68d9ec6cff7ea71edcba",
  "type": "ALIAS_GENERATION",
  "status": "RUNNING",
  "createdBy": "cLuE2VONraVl6EjvWO9Hw5",
  "createdDate": "2024-10-23T13:00:44.702+00:00"
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Generate aliases for reference data assets

Generate aliases for reference data assets

POST request

POST response

POST example