Service IDP - Execution Result - Retrieve

Get an execution of a published action by a given action Id, action version and execution Id

Equivalent to getDocumentActionExecution'

Usage:

• Retrieve the Results of any Execution

• After a document action successfully processes a document, or after a reviewer verifies and submits a document queued for review, the results are available for consumption.

Execution Results Reference

When you query the results of an execution, the IDP API returns any of the following statuses:

• ACKNOWLEDGED: The document action execution request was received.

• IN_PROGRESS: The execution started.

• RESULTS_PENDING: The execution finished and IDP is processing the results.

• MANUAL_VALIDATION_REQUIRED: The execution finished but the results need manual validation.

• FAILED: The execution request finished unsuccessfully.

• PARTIAL_SUCCESS: The execution request finished but some sub-tasks failed.

• SUCCEEDED: The execution request finished successfully.

---

Configuration:

Anypoint Code Builder

Anypoint Studio

---

Underlying API:

Get an execution of a published action by a given action Id and action version

get

Retrieves the State & Result Data of a specific document action execution. See getDocumentActionExecutionResult https://docs.mulesoft.com/idp/automate-document-processing-with-the-idp-api#retrieve-the-results-of-the-execution After a document action successfully processes a document, or after a reviewer verifies and submits a document queued for review, the results are available for consumption. When you use the IDP API to execute your document actions, retrieve the results by calling the /executions endpoint and providing an executionId, Example URL: https://idp-rt.us-east-1.anypoint.mulesoft.com/api/v1/organizations/01f79c97-9a83-4194-b922-15b64fd7305e/actions/c333413d-6593-4423-b3d4-f8ff4bf88917/versions/1.2.0/executions/ba9c0735-c95c-4d92-84f1-d72599900552

Authorizations

mulesoft-connectedApp-oauth

OAuth2clientCredentialsRequired

MuleSoft Connected App using OAuth 2.0 Client Credentials flow. Requires client_id and client_secret from a configured Connected App with appropriate IDP scopes/permissions. See: Configure Connected Apps

Token Request Example:

curl --location --request POST 'https://{mulesoftAnypointRegion}/accounts/api/v2/oauth2/token' \
--header 'Content-Type: application/json' \
--data-raw '{
  "grant_type": "client_credentials",
  "client_id": "<your-connected-app-client-id>",
  "client_secret": "<your-connected-app-client-secret>"
}'

Token URL:

Path parameters

organizationIdstring · uuidRequired

Your Anypoint Organisation ID (UUID). See: Find your Organization ID.

Example: 01f79c97-9a83-4194-b922-15b64fd7305e

actionIdstring · uuidRequired

The unique identifier (UUID) of the published Document Action.

Example: 90c3e286-72b5-42ca-92d0-22f86ea8d766

versionSemanticstringRequired

The semantic version of the Document Action (e.g., 1.0.0, 1.1.0).

Example: 1.1.0

executionIdstring · uuidRequired

The unique identifier (UUID) for a document processing execution, returned after successful submission.

Example: 022c61de-9bfc-4a94-8a9c-43c5f8ac153e

Query parameters

valueOnlybooleanOptional

Only keep the extracted value of the given field, remove confidenceScore and geometry from the response body

Default: true

Responses

200

Success

application/json

500

Internal Server Error

application/problem+json

get

/api/v1/organizations/{organizationId}/actions/{actionId}/versions/{versionSemantic}/executions/{executionId}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/actions/{actionId}/versions/{versionSemantic}/executions/{executionId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "documentName": "text",
  "id": "022c61de-9bfc-4a94-8a9c-43c5f8ac153e",
  "pages": [
    {
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "confidenceScore": 95.5,
          "geometry": {
            "height": 1,
            "left": 1,
            "top": 1,
            "width": 1
          },
          "value": null
        }
      },
      "page": 1,
      "prompts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "answer": {
            "confidenceScore": 95.5,
            "geometry": {
              "height": 1,
              "left": 1,
              "top": 1,
              "width": 1
            },
            "value": null
          },
          "prompt": "text",
          "source": "text"
        }
      },
      "tables": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "confidenceScore": 95.5,
              "geometry": {
                "height": 1,
                "left": 1,
                "top": 1,
                "width": 1
              },
              "value": null
            }
          }
        ]
      }
    }
  ],
  "prompts": {
    "ANY_ADDITIONAL_PROPERTY": {
      "answer": {
        "confidenceScore": 95.5,
        "geometry": {
          "height": 1,
          "left": 1,
          "top": 1,
          "width": 1
        },
        "value": null
      },
      "prompt": "text",
      "source": "text"
    }
  },
  "status": "SUCCEEDED"
}