Sign in

v1

latestOpenAPI 3.0.02026-08-041353104.2 KB
sharing tasks executions

Get sharing task execution

Retrieves a specific sharing task execution.

get/api/v1/sharing-tasks/{taskId}/executions/{executionId}

Path parameters

executionIdstring required

The execution identifier. If value is "latest", the latest execution will be returned

taskIdstring required

The sharing task identifier.

Query parameters

status'successful' | 'failed' | 'cancelled'

Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution.

Response

The execution has been successfully returned.

idstring

Gets the execution identifier.

appIdstring

appId associated to sharing task execution

status'initialized' | 'in-progress' | 'successful' | 'failed' | 'cancelled' | 'invalid' | 'presuccessful' | 'cancelling'

Status of the task execution

endTimestring

Timestamp of execution successful stop

eventIDstring

eventID of the trigger NATS event

ownerIdstring

Owner of the execution

reloadIdstring

If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.

tenantIdstring

The tenant that this execution belongs to

eventTimestring

eventTime of the trigger NATS event

startTimestring

Timestamp of execution start

bookmarkIdstring

The ID of a filter in a reporting request

failedTimestring

Timestamp of execution stop

reloadTimestring

If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.

totalCountinteger

Total count of reports in this execution

workflowIDstring

Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.

bookmarkIdsstring[]
failedCountinteger

Total count of failed reports in this execution

successCountinteger

Total count of successfully generated reports in this execution

cancelledTimestring

Timestamp of execution cancel

sharingTaskIDstring

ID for the sharing task that this execution references

cancelledCountinteger

Total count of cancelled reports in this execution

totalUploadCountinteger

Total count of reports to be uploaded in this execution

failedUploadCountinteger

Total count of failed uploaded reports in this execution

successUploadCountinteger

Total count of successfully uploaded reports in this execution

fileLocationsstring[]

Example response

{
  "files": [
    {
      "fileID": "za1b2c3d4z",
      "fileAlias": "small-image"
    }
  ],
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  }
}