Creating an API Collection

An API collection groups the endpoints of one or more deployed workflows into a single named, versioned API. Create a collection when you want to expose a related set of workflow endpoints to consumers as one managed interface rather than as separate endpoints.

Before you begin

• The workflows whose endpoints you want to expose must be deployed. Only deployed workflows offer paths to add.
• You need permission to manage API collections in the workspace.

Create the collection

1. Open API Manager > API Collections.
2. Select Create. The Create a new API collection form opens.
3. Enter a name in the Collection Name field. The name must be unique in the workspace.
4. Enter a Version for the collection, and a description if you want one.
5. Under Choose Paths, select the Workflow whose endpoints you want to include, then select the paths to add.
6. Select Add to move each selected path into Added Endpoints.
7. Select Create.

How you know it worked

Studio confirms with Collection Created Successfully, and the collection appears on the API Collections page with the status NOT PUBLISHED.

A new collection is never published automatically. Creating it makes it available to edit and review; consumers cannot reach it until you publish.

When it does not work

Symptom	Cause	What to do
Collection name already exists!	Another collection in the workspace uses that name	Choose a different name
Please enter collection name!	The name field is empty	Enter a name before selecting Create
No workflows or paths to select	No workflows are deployed in this workspace	Deploy a workflow first, then create the collection
Error fetching the Deployed Workflows	Studio could not load the deployed workflow list	Reload the page; if it persists, confirm the workspace has deployed workflows

Next steps

• Publish the collection to make it available to consumers.
• Create client profiles to control who can call it.