# Catalog Synonyms

Very often integrating parties refer to the same catalog item by different names, for example a product might be called "Gas" by one party and "Gasoline" by another. When both parties independently submit documents to the integration workspace, they are likely to create multiple catalog records describing the same thing. Since integration process is essentially a process of reaching data consistency between all parties involved, it becomes very important to be able to combine duplicate catalog records. Catalog synonyms API provides users with the tool to do so.

Catalog synonyms are links between two catalog records, allowing the user to associate their version of a catalog item to the version of their integration counterparty.

# API

# List all synonyms for a catalog record

Returns the list of synonym catalog records IDs

GET /workspaces/{workspace_id}/catalogs/{catalog}/{recordId}/synonyms

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
catalog Catalog name string
recordId Catalog item id string

# Query parameters

​ Parameter Description Format Default
limit Maximum number of records to return integer
offset The number of records to skip integer 0
sort List of comma-separated ordering criteria field:asc|desc

POST /workspaces/{workspace_id}/catalogs/{catalog}/{recordId}/synonyms/{synonymRecordId}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
catalog Catalog name string
recordId Catalog item id string
synonymRecordId Synonym catalog item id string

# Request body:

Empty

# Response example:

hide code
{
    "id": "f4071b86-e537-436e-a080-65f09206046c",
    "body": {
        "workspace": "62685100-fe47-4da2-b774-1c37754529f1",
        "baseItem": "115d612d-f79c-4510-8a08-b036b523284f",
        "linkedItem": "90f01f3c-d825-4273-a9e3-bcde6d3208d4"
    }
}

# Verify that two catalog items are synonyms

GET /workspaces/{workspace_id}/catalogs/{catalog}/{recordId}/synonyms/{synonymRecordId}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
catalog Catalog name string
recordId Catalog item id string
synonymRecordId Synonym catalog item id string

# Response

Returns the catalog synonym record object or 404 if none found.

hide code
{
    "id": "f4071b86-e537-436e-a080-65f09206046c",
    "body": {
        "workspace": "62685100-fe47-4da2-b774-1c37754529f1",
        "baseItem": "115d612d-f79c-4510-8a08-b036b523284f",
        "linkedItem": "90f01f3c-d825-4273-a9e3-bcde6d3208d4"
    }
}

DELETE /workspaces/{workspace_id}/catalogs/{catalog}/{recordId}/synonyms/{synonymRecordId}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
catalog Catalog name string
recordId Catalog item id string
synonymRecordId Synonym catalog item id string

# Response example:

hide code
{
    "name": "Example Barge 2",
    "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
    "xref": "123"
}
Last Updated: 7/20/2021, 9:58:21 PM