# Catalogs

Catalog is a mechanism for organizing reference data used in workspace documents. Catalog records can be created directly by the user or indirectly by the system when it creates documents in the workspace. Catalog records can contain an external reference to corresponding items in one of the integrating systems (xref field).

Bridge API supports following catalogs: products, locations, transports, uom, tests, testMethods, eventTypes, vcfTable.

For catalog mapping API see See catalog synonyms.

# Data Model

Field Type Description
name string User-friendly textual representation of the catalog item.
xref string An external ID associated with this item in the party's internal system integrated with Bridge APIs.

# Example

hide code
{
    "name": "Example Barge 1",
    "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
    "xref": "1234567890"
}

# API

# List all records for a catalog

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

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
catalog Catalog name 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
name The name to search for string
ownerParty Bridge organization ID for the integrating party that has created the catalog item string
xref Integrating party's catalog item id to search for string

# Create a catalog item

POST /workspaces/{workspace_id}/catalogs/{catalog}

# URL parameters

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

# Request body:

See data model

# Request example:

hide code
{
    "name": "Example Barge 1",
    "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
    "xref": "1234567890"
}

# Response example:

hide code
{
    "id": "f4071b86-e537-436e-a080-65f09206046c",
    "body": {
        "name": "Example Barge 1",
        "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
        "xref": "1234567890"
    }
}

# Get a single catalog record

GET /workspaces/{workspace_id}/catalogs/{catalog}/{id}

# URL parameters

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

# Response example:

hide code
{
    "name": "Example Barge 1",
    "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
    "xref": "1234567890"
}

# Update a catalog record

PATCH /workspaces/{workspace_id}/catalogs/{catalog}/{id}

# URL parameters

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

# Request example:

hide code
{
    "name": "Example Barge 2",
    "ownerParty: "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
    "xref": "123"
}

# Response example:

hide code
{
    "name": "Example Barge 2",
    "xref": "123"
}

# Delete a catalog mapping record

DELETE /workspaces/{workspace_id}/catalogs/{catalog}/{id}

# URL parameters

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

# Response example:

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