Invoke Custom API activity

An activity that invokes a custom API in Mindee to extract data from an image or a PDF file uploaded from an AgilePoint NX app.

Configure the Invoke Custom API activity

Examples

(External) AgilePoint NX Connector For Mindee
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Mindee tab.
On the Mindee tab, drag the Invoke Custom API activity onto your process.

General Configuration

Specifies the basic settings for the Invoke Custom API activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Source Repository

Specifies the original, or source, location type of your file.

Fields

Field Name	Definition
Source Repository	Opens this Screen: The configuration screen for your document repository. The specific screen that shows depends on your document repository type. For more information, refer to Document Repositories. Function of this Screen: Configures your document repository.

Invoke Custom API Configuration

Configures the information to invoke a custom API in Mindee to extract data from the uploaded file.

Fields

Field Name	Definition
Mindee	Description: Specifies the access token that connects to Mindee. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (External) AgilePoint NX Connector For Mindee
Create	Opens this Screen: Access Token for Mindee Function of this Screen: Configure an access token to connect to Mindee Example: Refer to: (External) AgilePoint NX Connector For Mindee
User Name	Description: Specifies the user name for the Mindee account. You must specify the user account in which the custom API is created. Allowed Values: The user name for your Mindee account. Default Value: None Accepts Variables: Yes Example: Refer to: (External) AgilePoint NX Connector For Mindee Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
API Name	Description: Specifies the name of the custom API to invoke in Mindee. You must create a custom API in Mindee to use in AgilePoint NX. Allowed Values: An API name from Mindee. Default Value: None Accepts Variables: Yes Example: Refer to: (External) AgilePoint NX Connector For Mindee Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Store Response Job ID In This Variable (String)	Description: Specifies a variable to store the ID of the data extraction job of the custom API. The job ID comes from Mindee. Allowed Values: A variable. Format: String Accepted: Letters Numbers Special characters Not Accepted: Spaces Default Value: None Accepts Variables: Yes Example: Refer to: (External) AgilePoint NX Connector For Mindee Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?