Reference 360

Back Next

Get alias generation job status

Retrieves the status of an alias generation job and the list of assets that the job processed with their status.

GET request

To retrieve the details of an alias generation job, submit a GET request with the following URI:

/rdm-service/external/v1/assets/generateAliases/job/{jobId}

The following table describes the query parameter:

Field	Type	Description
jobId	String	ID of the alias generation job.

GET response

The response contains the details of an alias generation job, such as status of the job, created date, and array of assets for which aliases were generated.

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. Values can be RUNNING , SUCCESS , FAILED , or CANCELLED .
createdBy	String	User name of the user who triggered the alias generation job.
createdDate	String	Date when the user ran the alias generation job.
detail	-	Details of the alias generation job at a specific time.
referenceDataSets	-	Includes alias generation details for reference data sets.
SUCCESS	Array	An array that lists the reference data sets for which aliases were generated.
FAILED	Array	An array that lists the reference data sets for which aliases weren't generated.
SKIPPED	Array	An array that lists the reference data sets for which aliases exist and the input overwriteExisting parameter was false .
codelists	-	Includes alias generation details for code lists.
SUCCESS	Array	An array that lists the code lists for which aliases were generated.
FAILED	Array	An array that lists the code lists for which aliases weren't generated.
SKIPPED	Array	An array that lists the code lists for which aliases exist and the input overwriteExisting parameter was false .
errors	-	Details of the error that the REST API request returns.
errorCode	String	Error code for the error type.
errorSummary	String	Message that explains why aliases weren't generated for the assets.
errorParameter	String	Parameter that provides details of an error.
errorCauses	String	Causes of the error to explain why aliases weren't generated for the assets.

GET example

To retrieve the status of an alias generation job, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/assets/generateAliases/job/663a68d9ec6cff7ea71edcba
HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

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

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 20
{
  "jobId": "663a68d9ec6cff7ea71edcba",
  "type": "ALIAS_GENERATION",
  "status": "SUCCESS",
  "createdBy": "cLuE2VONraVl6EjvWO9Hw5",
  "createdDate": "2024-10-23T13:00:44.702+00:00",
  "detail": {
    "referenceDataSets": {
      "SUCCESS": [
        "ZIT_17031562157755360_9505_ModelDeltaImportTest_IntTestRDS2"
      ],
      "FAILED": [
        "CaseTest1",
        "ABC RDA",
        "CaseTest",
        "aaaa",
        "RdsCheckCorruption"
      ],
      "SKIPPED": [
        "PaymentMethodType",
        "SupplierType",
        "Color",
        "EmploymentStatus",
        "AccountType",
        "PurchaseOrgCodeType",
        "QualificationType",
        "PersonStatus",
        "MeasuringUnit",
        "18355088358"
      ]
    },
    "codelists": {
      "FAILED": [
        "Enterprise ZIT_17183546558623610_4072_ReferenceHierarchyTest_IntTestRDS4",
        "Enterprise ZIT_17183546558623610_4072_ReferenceHierarchyTest_IntTestRDS3",
        "Enterprise ZIT_17183546558623610_4072_ReferenceHierarchyTest_IntTestRDS2",
        "Enterprise ZIT_17183546558623610_4072_ReferenceHierarchyTest_IntTestRDS1",
        "Enterprise AAAA",
        "Enterprise CaseTest1",
        "Dep2",
        "Enterprise Rds_master_dep_del",
        "Enterprise Country",
        "Alt Codelist - Unused",
        "Alt Codelist - With SrcSystem",
        "Enterprise CaseTest",
        "Enterprise Color"
      ],
      "SKIPPED": [
        "Enterprise PaymentMethodType",
        "Enterprise SupplierType",
        "Enterprise AddressUsageType",
        "Enterprise PhoneUsageType",
        "Enterprise EmploymentStatus",
        "Enterprise SocialHandleType",
        "Enterprise AccountType",
        "Enterprise Activités RH"
      ]
    },
    "crosswalks": {
      "SKIPPED": [
        "Enterprise Language to Enterprise Country",
        "Enterprise Test-Rds to Enterprise Test-Rds2",
        "Enterprise AccountType to Enterprise AddressEnrichedIndicator",
        "Enterprise AddressEnrichedIndicator to Enterprise AccountType",
        "Enterprise State to Enterprise Country",
        "Enterprise AccountType to Enterprise AddressStatus",
        "Enterprise Dep Area to Enterprise AddressUsageType",
        "Enterprise TestRDA to SAP RDA",
        "Enterprise A RDA Test to A RDA ORC",
        "Enterprise A RDA Test to A RDA SAP",
        "Enterprise PermTest to PermTest2",
        "Enterprise RDA-XYZ to XYZ",
        "Enterprise FakeChangelistTest to Codelist21",
        "Enterprise ABC  to ABC Alt",
        "Enterprise ABC  to Alt Unused",
        "DataEZ Country to Enterprise Country",
        "IQVIA Country to Enterprise Country",
        "Salesforce Country to Enterprise Country",
        "Country_ORA_AP to Enterprise Country",
        "Enterprise Country to VeevaCRM Country",
        "Enterprise Country to DataEZ Country",
        "Enterprise AddressType to VeevaCRM AddressType",
        "Enterprise Country to IQVIA Country",
        "Enterprise AddressType to IQVIA Addresstype",
        "Enterprise Beta to ISO Beta",
        "Enterprise Beta to SAP Beta",
        "SAP Beta to Enterprise Beta",
        "Enterprise Country to ISO Country Codes",
        "PeopleSoft AddressType to Enterprise AddressType"
      ]
    },
    "hierarchies": {
      "SKIPPED": [
        "CountryLanguage",
        "LanguageCountry",
        "New hier",
        "CountryStatus",
        "LanguageStatus",
        "ColorHier",
        "ColorHier1",
        "Kite13"
      ]
    }
  }
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get alias generation job status

Get alias generation job status

GET request

GET response

GET example