Get Custom API Result activity

An activity that retrieves information about the result of a custom API from Mindee.

Configure the Get Custom API Result 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 Get Custom API Result activity onto your process.

General Configuration

Specifies the basic settings for the Get Custom API Result 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

Get Custom API Result Configuration

Specifies the information about a custom API whose result to retrieve from Mindee.

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 whose result to retrieve from Mindee. 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?
Job ID	Description: Specifies the ID of the job for which to retrieve the result of the custom API. The job ID comes from Mindee. Allowed Values: A job ID 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?
Enter Response Payload / Store Response In This Variable	Description: Specifies where to store the response from Mindee. Allowed Values: Enter Response Payload – Specifies a payload to use to map the response to the AgilePoint process schema. Click Map Response to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Store Response In This Variable – Select this option if you want to store the information from Mindee to a variable in the AgilePoint NX app. In the text field, specify a variable that accepts an alphanumeric string in JSON format. Default Value: Enter Response Payload 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?