Get the download url for an application summary.

POST http://api.kompliant.com/workflow.applicationSummary.getDownload (OpenAPI specification)

Usage Info

Retrieve a the download url of a specific application summary of the specified workflow.

This method is only supported for Workflows of type BUSINESS_APPLICATIONand requires Workflow to have status :ENDED

Request

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The identifier for the Workflow

Example

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
application_summary	object	The application_summary parameter is described below.

Application Summary Parameters

Parameter	Type	Description
download_url	string	The presigned url of the application summary.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "application_summary": {
      "download_url": "https://mockurl.com/url",
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below
SYSTEM_EXCEPTION	400	System exceptions are described below

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	WORKFLOW_IN_PROGRESS	`applicationSummary.getDownload` action is not allowed when the workflow is in `STARTED` state
Workflow	WORKFLOW_CREATED	`applicationSummary.getDownload` action is not allowed when the workflow is in `CREATED` state
Workflow	INVALID_WORKFLOW_TYPE	Workflow must be type `BUSINESS_APPLICATION`

System Exceptions

When a SYSTEM_EXCEPTION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
ApplicationSummary	APPLICATION_SUMMARY_FAILED	The generation for the application summary failed and is not possible to generate an url for download.
ApplicationSummary	APPLICATION_SUMMARY_IN_PROGRESS	The application summary is not ready for download yet.
ApplicationSummary	APPLICATION_SUMMARY_NOT_FOUND	Application summary for specified `workflow_id`not found.