GitHub

Service IDP - Execution - Submit

Submits a document to IDP for processing

Equivalent to postDocumentActionExecution

Usage:

  • Compatible with any Document Action Version.

  • No more multipart which in itself highlights the confusion as it need only be Ouptut Java.

Configuration:

1

Input - Mule Message - Payload

2

Configuration Panel

General Region

  • Action id: If Basic Authentication configured you can expect dynamic loading of your org's actions. Action Id is the UUID found in the published exchange asset for your Document Action Version

https://idp-rt.us-east-1.anypoint.mulesoft.com/api/v1/organizations/01f79c97-9a83-4194-b922-15b64fd7305e/actions/4f744f12-0700-4a0c-bf16-084aa3c6f7a8/versions/1.0.0/executions

  • Version semantic: If Basic Authentication configured you can expect dynamic loading of your org's action's versions. Version semantic is the version found in the published exchange asset for your Document Action Version

https://idp-rt.us-east-1.anypoint.mulesoft.com/api/v1/organizations/01f79c97-9a83-4194-b922-15b64fd7305e/actions/4f744f12-0700-4a0c-bf16-084aa3c6f7a8/versions/1.0.0/executions

Submission Options

  • Filename: Name and Extension of your doc top be submitted

  • Callback URL: You can define a callback URL when you call IDP to execute your document actions. If defined, IDP calls the callback URL when the document action execution finishes with state SUCCEEDED, FAILED, or MANUAL_VALIDATION_REQUIRED.

  • Override Salesforce Org ID: If you have multiple Salesforce Orgs connected with your Anypoint Platform organization, you can specify the Org to use when executing your document actions.

3

Output - Mule Message - Payload

The response from this operation contains the execution ID that you can use to retrieve the execution results.

{
   "id":"7e14f72d-2abc-461f-8c23-3ba92be92a10",
   "documentName":"IDP-PO-CD656092-BurlingtonTextiles.pdf"
}

Underlying API:

postDocumentActionExecution Execute a versioned Action with a File or Base64 payload

post

Submits a file for IDP processing using a specific document action and version. 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

Authorizations
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
Header parameters
x-sfdc-core-tenant-idstringOptional

Use a Different Salesforce Org to Execute Your Document Actions https://docs.mulesoft.com/idp/automate-document-processing-with-the-idp-api#use-a-different-salesforce-org-to-execute-your-document-actions

Body

Request object for executing an action with a Base64-encoded file

callbackstringOptional

Callback Url

Example: {"noAuthUrl":"callbackURL"}
filestringRequired

File content in base64 string format

Example: JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cm5lcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzE+PgpzdHJlYW0KeJwzUvDiMtAzNVco53IKUdB3M1Sw0DMwUAhJU3ANAYkYG+oZWihYGJjoGZgphKQoaBQn5qQWp+UXJadqKoRkgVQBAO5BEAMKZW5kc3RyZWFtCmVuZG9iagoxIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUiBdCi9Db3VudCAxCi9NZWRpYUJveCBbMCAwIDU5NS4yOCA4NDEuODldCj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9IZWx2ZXRpY2EKL1N1YnR5cGUgL1R5cGUxCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgNSAwIFIKPj4KL1hPYmplY3QgPDwKPj4KPj4KZW5kb2JqCjYgMCBvYmoKPDwKL1Byb2R1Y2VyIChQeUZQREYgMS43LjIgaHR0cDovL3B5ZnBkZi5nb29nbGVjb2RlLmNvbS8pCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNTAxMDgwNDU4MzgpCj4+CmVuZG9iago3IDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovT3BlbkFjdGlvbiBbMyAwIFIgL0ZpdEggbnVsbF0KL1BhZ2VMYXlvdXQgL09uZUNvbHVtbgo+PgplbmRvYmoKeHJlZgowIDgKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMjI3IDAwMDAwIG4gCjAwMDAwMDA0MTAgMDAwMDAgbiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDg3IDAwMDAwIG4gCjAwMDAwMDAzMTQgMDAwMDAgbiAKMDAwMDAwMDUxNCAwMDAwMCBuIAowMDAwMDAwNjIzIDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgOAovUm9vdCA3IDAgUgovSW5mbyA2IDAgUgo+PgpzdGFydHhyZWYKNzI2CiUlRU9GCg==
fileNamestringOptional

File name provided by user

Example: testFile.pdf
Responses
201
Created
application/json
post
POST /api/v1/organizations/{organizationId}/actions/{actionId}/versions/{versionSemantic}/executions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1366

{
  "callback": "{\"noAuthUrl\":\"callbackURL\"}",
  "file": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cm5lcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzE+PgpzdHJlYW0KeJwzUvDiMtAzNVco53IKUdB3M1Sw0DMwUAhJU3ANAYkYG+oZWihYGJjoGZgphKQoaBQn5qQWp+UXJadqKoRkgVQBAO5BEAMKZW5kc3RyZWFtCmVuZG9iagoxIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUiBdCi9Db3VudCAxCi9NZWRpYUJveCBbMCAwIDU5NS4yOCA4NDEuODldCj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9IZWx2ZXRpY2EKL1N1YnR5cGUgL1R5cGUxCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgNSAwIFIKPj4KL1hPYmplY3QgPDwKPj4KPj4KZW5kb2JqCjYgMCBvYmoKPDwKL1Byb2R1Y2VyIChQeUZQREYgMS43LjIgaHR0cDovL3B5ZnBkZi5nb29nbGVjb2RlLmNvbS8pCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNTAxMDgwNDU4MzgpCj4+CmVuZG9iago3IDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovT3BlbkFjdGlvbiBbMyAwIFIgL0ZpdEggbnVsbF0KL1BhZ2VMYXlvdXQgL09uZUNvbHVtbgo+PgplbmRvYmoKeHJlZgowIDgKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMjI3IDAwMDAwIG4gCjAwMDAwMDA0MTAgMDAwMDAgbiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDg3IDAwMDAwIG4gCjAwMDAwMDAzMTQgMDAwMDAgbiAKMDAwMDAwMDUxNCAwMDAwMCBuIAowMDAwMDAwNjIzIDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgOAovUm9vdCA3IDAgUgovSW5mbyA2IDAgUgo+PgpzdGFydHhyZWYKNzI2CiUlRU9GCg==",
  "fileName": "testFile.pdf"
}
{
  "documentName": "text",
  "id": "text",
  "status": "text"
}
PreviousOperationsNextService IDP - Execution Result - Retrieve

Last updated