Case API Library Module Overview

What is the Case API Library module?

Case Management Studio ships with the Case API Library module, a pre-built, self-contained application that provides standardized Web API template endpoints for full case lifecycle management from external systems. The Case API Library module enables external applications to create, update, and retrieve case data in Case Management Studio without manual data entry.

The Case API Library module streamlines integrations between your external systems and Case Management Studio by providing a set of ready-to-use Web API templates.

What it does

The Case API Library provides a set of Web API templates that external systems can call to interact with case data programmatically. These templates follow the same process and logic as if a user performed the action through the standard Case Management Studio interface, including workflow instantiation, Case ID generation, and task and milestone creation.

The module ships as a separate application container with no incorporation points into the Case Management Studio Base application. The Web API templates are Designer-facing objects intended to be cloned and customized by implementation teams to meet specific integration requirements.

Use cases

The Case API Library addresses common integration scenarios across implementation teams and partners:

• External system integration: Interface with ERP systems (SAP, PeopleSoft), CRMs (Salesforce), and other enterprise tools to create and manage cases in Case Management Studio when events occur in those systems.
• Inbound case ingestion: Support inbound case creation from external web forms, electronic filing systems, or third-party portals.
• Real-time orchestration: Use Case Management Studio as a central orchestration engine that reacts to external events in real-time, rather than relying on manual data entry.
• System-to-system workflows: Build automated pipelines where cases are created, updated, and tracked across multiple systems without human intervention.

Available endpoints

The Case API Library includes the following Web API template endpoints:

Method	Endpoint	Description
POST	/cases	Create a new case for a specified case type, with supplied data fields.
PUT	/cases	Update a specific case record with supplied data.
GET	/case	Retrieve all details and related data for a single case.
GET	/cases	Retrieve a filtered list of cases based on criteria like status, case type, or assignee.
GET	/casecomments	Retrieve the comment history for a specific case.
GET	/casetasks	Retrieve all tasks attributed to a specific case.
GET	/caseType	Retrieve all case types configured in the Control Panel.
GET	/status	Retrieve all available case statuses or task statuses.
GET	/casePriority	Retrieve all case priority levels.
GET	/caseFields	Retrieve the custom fields configured for a specific case type.
POST	/uploadFile	Upload and attach a document to a specific case record.

Case creation and workflow automation

When a case is created through the API, the system follows the same process as a case created through the standard interface:

• A formatted Case ID is automatically generated (for example, CASE-EQ-2026-001).
• Configured tasks and milestones for the specified case type are automatically created.
• The case source is recorded as "API" for audit and reporting purposes.

Key capabilities

• Custom field support: The API enforces the same validation rules as the standard UI for custom fields defined in the Control Panel. Changes to custom field configuration are immediately reflected in API behavior.
• Structured error handling: Each endpoint returns clear error messages when requests contain invalid or missing data, making it straightforward to troubleshoot integrations.
• Flexible authentication: The module ships without a preconfigured authentication method, giving you full control over how external systems authenticate. Common options include API Key and OAuth 2.0 Client Credentials Grant.
• Template-based design: Web API templates are designed to be cloned and customized. Keep the originals intact to receive future upgrades, and tailor your clones to match your integration requirements.

Ready to get started?

See Installing the Case API Library to install the Case API Library module with your Case Management Studio application.

After installing, follow the setup steps to configure authentication, clone and customize templates, and begin using the API endpoints with your external systems.

Feedback