Swift Case Management

Submit a Swift Case Manager request

Creates, updates, or queries a Swift Case Manager investigation case. Supported case types: CCNR (Claim Non-Receipt, also covers CONR), UTAP (Unable to Apply), GSRP (GPI Stop and Recall), RQFI UTEX (Request for Information), and INV_ACTION (Request Action).

post/webapi/case-manager-requests

Request

Base URL
https://your-environment.appiancloud.com/suite
Auth
API key in header appian-api-key
TypeScript
https://skmtc.dev/appian/apis/appian-adapter-for-swift-api/docs/webapi/case-manager-requests/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

sourcestring required

The source system initiating the case request.

caseType'CCNR' | 'UTAP' | 'GSRP' | 'RQFI' | 'INV_ACTION'

The type of Swift Case Manager investigation. Required when using flat mode. Omit when using mxContent.

The action to perform on the case. Required when using flat mode. Omit when using mxContent.

contentobject nullable

The case-type-specific content payload. Structure varies by case type and action. See the companion file scm-content-schemas.yaml for the full field definitions of each caseType/caseAction combination. Required when using flat mode. Set to null when using mxContent.

validateBicboolean

Example request

{
  "source": "EPI",
  "caseType": "CCNR",
  "caseAction": "CREATE",
  "mxContent": {
    "messageType": "camt.110.001.01"
  }
}

Response

Case Manager request processed successfully.

messageIdstring uuid

The unique identifier assigned to the request.

statusstring

Status of the case operation.

errorstring nullable

Error message, or null on success.

contentobject nullable

Dictionary of results from the service, varies by caseType and caseAction.

Example response

{
  "status": "SUCCESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.