Upload Claim Document API Module

Prepare for setup

After installing the Upload Claim Document API add-on module, you can use it to upload documents to existing claims in the Connected Claims Base application. This page provides definitions for the Upload Claim Document API, which is available after you install this add-on module in the same environment as your Connected Claims Base application.

All documentation on this page is pertinent to Upload Claim Document APIs version 1.1.

System prerequisites

This section details the minimum requirements your system must meet to run the Upload Claim Document API add-on module:

• Appian platform running version 26.6 or greater.
• An Appian Cloud environment with the advanced or premium platform tiers.
• A supported version of MariaDB as a business data source.
  • Note: Instructions below are for MariaDB databases. For use with other databases, the SQL script will need to be modified.
• A supported web browser.
• Imported Connected Claims Management Base Application application version 2.0 and higher, which includes the following application containers:
  • Connected Claims Management Base (CCM)
  • CCM Studio Generated Objects
• Imported Upload Claim Document API add-on module application containers, including:
  • CCM Add-On: Claim Upload Document API (CCM_API_CUD)

Set up access to the API

The following steps are the minimum steps required to use the Upload Claim Document API. Implementers are free to customize the security, display names, and other aspects of the application to best suit their needs.

Add the service account user to the API access group

To add the service account to the API access group:

1. In Designer, go to the CCM Add-On: Claim Upload Document API application.
2. Search for the CCM_API_CUD API Access Claim Upload Document group.
3. Add the service account that you created in Create a service account of the installation guide to the group.

Endpoint

This section describes the API endpoint configuration and versioning for the Upload Claim Document API.

The Upload Claim Document API has a default endpoint of ccm-claim-upload-document. You can append the API version to the end of the endpoint. For example, ccm-claim-upload-document/<CLAIM_ID>/<DOCUMENT_TYPE>/v1 calls version 1 of the Upload Claim Document API. If you do not provide a version path, the API uses v1.

Expected request structure

This section outlines the required format and structure for Upload Claim Document API requests to successfully upload documents to claims.

Headers

Clients must send a Content-Type header of "binary". This header ensures that the documents sent in the request keep their original file extension in Appian.

Clients can optionally specify the name of the document in Appian by providing an appian-document-name header with the name of the document. If you do not provide this header, Appian names the document "Untitled document from web API". This naming is platform-level behavior for Appian API objects that accept documents.

Query parameters

There are no expected query parameters that should be sent in a request to the Claim Upload Document API.

Path

In addition to the version of the API, pass the claimId of the claim to upload the document to and the documentType of the document in the path of the call to the API. The expected structure of the path for the API is:

<BASE_URL>/ccm-claim-upload-document/<CLAIM_ID>/<DOCUMENT_TYPE>/<VERSION>

The claimId parameter relates to the Claim ID of the claim as it displays on the front end in the solution. This parameter specifies which claim to attach the document to, and it is required in the path structure of requests.

The documentType parameter specifies the type of the document. The value you provide for this part of the path corresponds to a value from a predefined list of document types, which is the list of reference data in the corresponding Document Type table. The value must correspond to a value in the API_CODE column of the Document Type table.

If you do not provide a valid value for both claimId and documentType in the path, the API returns a 400 error response.

Body

The document, provided as binary, should be the sole thing provided in the body of the request. Bodies are required in all requests.

Possible responses

This section details the various response codes and error messages that the Upload Claim Document API may return based on different request scenarios.

The following response codes can be sent back to the caller of the Claim Upload Document API:

Response code 200

This response code indicates a successful request and attachment of a Document to a Claim in Appian. The provided response body will specify that the document was successfully attached to the Claim.

Response code 400

This response code indicates a bad request was sent by the caller. Documents will not be attached given a 400 error response. In the response body, additional information will be provided as to why the request was bad. Possible errorCodes contained in the response body include:

• MISSING_REQUIRED_FIELD: A field that was required in the request body was not present. The field that was missing will be provided.
• INVALID_CODE: A field that expects a code datatype did not have a valid value. The field that had an invalid value will be provided.
• DATA_INTEGRITY_VIOLATION: Additional validations that take place on the request were violated. Specifically in the case of the Upload Document API, this error code will be provided if an invalid Claim ID was provided in the path of the request.

Response code 404

This response code is an Appian default and indicates there was a problem authenticating.

Response code 500

This response code is an Appian default and indicates there was a backend expression or process error.

Use the API after setup

After you set up the Upload Claim Document via API module, you can programmatically upload documents to existing claims in Connected Claims through REST API calls, enabling automated document attachment from external systems.

Feedback