API Docs for: 2.0.20133.2
Show:

api.caseManagement Class

Defined in: src\internal\api\caseManagement\CaseManagementApi.ts:16
Module: API Case Management
Parent Module: API

Case Management API

Item Index

Methods

Methods

getCase

(
  • config
)
Promise | object static

Defined in src\internal\api\caseManagement\CaseManagementApi.ts:22

Gets a case

Parameters:

  • config Object

    A config object to get a case.

    • locale. String

      Locale to render the workflow in, such as en-us, fr-fr

    • preview. String

      Use compass unpublished data in workflow

    • environment. String

      A value from ui.caseManagement.Environment (default is ui.caseManagement.Environment.PRODUCTION)

Returns:

Promise | object:

.