Connectors Reference
AgilePoint is a platform that opens up two-way communication to provide native support for flows within larger, more scalable cross-organizational automations. Now you can include important daily tasks performed within Microsoft ecosystem in the big picture processes housed in AgilePoint.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Delete Webhook |
|
|
Complete System Task |
|
|
Start Process Instance |
|
|
SetCustomAttrs (string CUSTOMID, [Optional]SetCustomAttrsParameterBody body) |
Save Data |
|
GetCustomAttr (string CUSTOMID, [Optional]GetCustomAttrParameterBody body) |
Get Data |
|
Get Process Definitions |
|
|
Generate New Guid |
|
|
Get Process Instance |
|
|
GetRegisteredUserbyName ([Optional]GetRegisteredUserbyNameParameterBody body) |
Get User |
|
CompleteManualWorkItem (string workItemID, [Optional]CompleteManualWorkItemParameterBody body) |
Complete Human Task |
|
Get Process Models |
|
Name |
Summary |
|
When a process instance is started |
|
|
TriggeryByAgilePointActivity (TriggeryByAgilePointActivityParameterBody body) |
When a trigger flow process activity is executed |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Delete Webhook
Description: Deletes selected webhook from the AgilePoint Portal.
Syntax:
AgilePointNX.DeleteTrigger (string WebhookId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WebhookId |
string (Webhook ID) |
Enter webhook ID. |
True |
Returns:
Type:string
Summary: Complete System Task
Description: Completes the specified system activity (automatic work item).
Syntax:
AgilePointNX.CompleteAutoWorkItem (string WORKITEMID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
WORKITEMID |
string (Task ID) |
Enter work item ID. |
True |
Returns:
Type:CompleteAutoWorkItemResponse
Summary: Start Process Instance
Description: Creates a process instance for a specified process instance ID and parameters.
Syntax:
AgilePointNX.CreateProcInst ([Optional]CreateProcInstParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary: Save Data
Description: Sets a list of process attribute (custom attributes) to the specified values for a specified custom attribute ID.
Syntax:
AgilePointNX.SetCustomAttrs (string CUSTOMID, [Optional]SetCustomAttrsParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CUSTOMID |
string (ID) |
Enter custom ID. |
True |
|
|
body |
|
|
False |
Returns:
Summary: Get Data
Description: Retrieves a process attribute (custom attribute) with the specified process attribute ID and process attribute name.
Syntax:
AgilePointNX.GetCustomAttr (string CUSTOMID, [Optional]GetCustomAttrParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CUSTOMID |
string (ID) |
Enter custom ID. |
True |
|
|
body |
|
|
False |
Returns:
Summary: Get Process Definitions
Description: Retrieves the names and IDs of all released process models.
Syntax:
AgilePointNX.GetReleasedProcDefs ()
Returns:
Type:GetReleasedProcDefsResponse
Summary: Generate New Guid
Description: Retrieves the UUID generated by AgilePoint Server.
Syntax:
AgilePointNX.GetUUID ()
Returns:
Type:GetUUIDResponse
Summary: Get Process Instance
Description: Retrieves information about a specified process instance.
Syntax:
AgilePointNX.GetProcessInstance (string processInstanceID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
processInstanceID |
string (Process Instance ID) |
Enter process instance ID. |
True |
Returns:
Type:GetProcessInstanceResponse
Summary: Get User
Description: Retrieves the profile information for the specified registered user.
Syntax:
AgilePointNX.GetRegisteredUserbyName ([Optional]GetRegisteredUserbyNameParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
GetRegisteredUserbyNameParameterBody
|
|
False |
Returns:
Type:GetRegisteredUserbyNameResponse
Summary: Complete Human Task
Description: Completes the specified human task (manual work item), and changes its status to Completed in the database.
Syntax:
AgilePointNX.CompleteManualWorkItem (string workItemID, [Optional]CompleteManualWorkItemParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
workItemID |
string (Task ID) |
Enter work item ID. |
True |
|
|
body |
CompleteManualWorkItemParameterBody
|
|
False |
Returns:
Type:CompleteManualWorkItemResponse
Summary: Get Process Models
Description: Retrieves all versions of all process models (process definitions).
Syntax:
AgilePointNX.ProcessDefinition ()
Returns:
Type:ProcessDefinitionResponse
Summary: When a process instance is started
Description: Trigger When AgilePoint Process Instance Started.
Syntax:
AgilePointNX.TriggerByAgilePointProcessInstanceCreation (TriggerByAgilePointProcessInstanceCreationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
TriggerByAgilePointProcessInstanceCreationParameterBody
|
|
True |
Returns:
Type:TriggerByAgilePointProcessInstanceCreationResponse
Summary: When a trigger flow process activity is executed
Description: Trigger By AgilePoint Activity.
Syntax:
AgilePointNX.TriggeryByAgilePointActivity (TriggeryByAgilePointActivityParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
TriggeryByAgilePointActivityParameterBody
|
|
True |
Returns:
Type:TriggeryByAgilePointActivityResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ActivityInstID |
string
|
The unique ID for an activity instance. |
|
AutoStart |
boolean
|
Specifies whether the process starts immediately after it is created. |
|
CustomAttributes |
array of (CustomAttributesItem)
|
Variables in XML format. |
|
Diagnostic |
boolean
|
Specifies if the process data will be deleted from the database after the process completes. |
|
EndDate |
string
|
The completion date of the delegation. |
|
Entries |
integer(int32)
|
Retrieves the relay time of the event. |
|
Error |
string
|
Retrieves and sets the error message of the event. |
|
EventID |
string
|
A unique ID for an event. |
|
EventName |
string
|
The name of the event. |
|
HighPriority |
boolean
|
Specifies that a task is marked as high priority. |
|
ParamsXml |
string
|
Retrieves and sets the parameters as XML. |
|
ParentProcInstID |
string
|
A process instance ID that acts as a parent process instance of the process instance that is intended to create. |
|
ProcDefID |
string
|
The unique ID of the process model. |
|
ProcInstID |
string
|
The unique ID of a process instance. |
|
ProcInstName |
string
|
A unique name that is associated with the process instance. |
|
Sender |
string
|
The sender of the event. |
|
SentDate |
string
|
The sent date of the event. |
|
SourceWorkItemID |
string
|
An ID that represents the original, or source, task. |
|
Status |
string
|
The status of the event. |
|
TenantID |
string
|
The unique ID of the AgilePoint NX tenant. |
|
UserID |
string
|
The unique ID for a user. |
|
WorkItemID |
string
|
An unique ID that represents a task. |
|
WorkObjectID |
string
|
An ID for an object, such as a document, that is associated with the process instance. |
|
WorkObjectInfo |
string
|
Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance. |
Summary:
Description: Response of Complete System Task Action
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Name |
|
Value |
|
Value |
Summary:
Description: Value
Properties:
|
Name |
Type |
Summary |
|
NameValue |
|
NameValue |
Summary:
Description: NameValue
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
The name of an item, such as a property or attribute in a name/value pair. |
|
Value |
|
Value |
Summary:
Description: Value
Properties:
|
Name |
Type |
Summary |
|
NameValue |
string
|
The value for an item, such as the value for an attribute in a name-value pair. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
clientData |
string
|
Enter client data. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ActivityInstID |
string
|
The unique ID for an activity instance. |
|
AutoStart |
boolean
|
Specifies whether the process starts immediately after it is created. |
|
CustomAttributes |
string
|
Variables in XML format. |
|
Diagnostic |
boolean
|
Specifies if the process data will be deleted from the database after the process completes. |
|
EndDate |
string
|
The completion date of the delegation. |
|
Entries |
integer(int32)
|
Retrieves the relay time of the event. |
|
Error |
string
|
Retrieves and sets the error message of the event. |
|
EventID |
string
|
A unique ID for an event. |
|
EventName |
string
|
The name of the event. |
|
HighPriority |
boolean
|
Specifies that a task is marked as high priority. |
|
ParamsXml |
string
|
Retrieves and sets the parameters as XML. |
|
ParentProcInstID |
string
|
A process instance ID that acts as a parent process instance of the process instance that is intended to create. |
|
ProcDefID |
string
|
The unique ID of the process model. |
|
ProcInstID |
string
|
The unique ID of a process instance. |
|
ProcInstName |
string
|
A unique name that is associated with the process instance. |
|
Sender |
string
|
The sender of the event. |
|
SentDate |
string
|
The sent date of the event. |
|
SourceWorkItemID |
string
|
An ID that represents the original, or source, task. |
|
Status |
string
|
The status of the event. |
|
TenantID |
string
|
The unique ID of the AgilePoint NX tenant. |
|
UserID |
string
|
The unique ID for a user. |
|
WorkItemID |
string
|
An unique ID that represents a task. |
|
WorkObjectID |
string
|
An ID for an object, such as a document, that is associated with the process instance. |
|
WorkObjectInfo |
string
|
Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ProcessID |
string
|
Select process definition name. |
|
ProcessInstID |
string
|
Enter process instance ID. |
|
ProcInstName |
string
|
Enter process instance name. |
|
WorkObjID |
string
|
Enter work object ID. |
|
WorkObjInfo |
string
|
Enter object information. |
|
SuperProcInstID |
string
|
Enter parent process instance ID. |
|
Initiator |
string
|
Enter process initiator name. |
|
CustomID |
string
|
Enter custom ID. |
|
blnStartImmediately |
boolean
|
Select value. Values: [, ] |
|
Attributes |
array of (AttributesItem)
|
Attributes NameValue Pair. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Enter attribute name. |
|
Value |
string
|
Enter attribute value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ActivityInstID |
string
|
The unique ID for an activity instance. |
|
AutoStart |
boolean
|
Specifies whether the process starts immediately after it is created. |
|
CustomAttributes |
array of (CustomAttributesItem)
|
Variables in XML format. |
|
Diagnostic |
boolean
|
Specifies if the process data will be deleted from the database after the process completes. |
|
EndDate |
string
|
The completion date of the delegation. |
|
Entries |
integer(int32)
|
Retrieves the relay time of the event. |
|
Error |
string
|
Retrieves and sets the error message of the event. |
|
EventID |
string
|
A unique ID for an event. |
|
EventName |
string
|
The name of the event. |
|
HighPriority |
boolean
|
Specifies that a task is marked as high priority. |
|
ParamsXml |
string
|
Retrieves and sets the parameters as XML. |
|
ParentProcInstID |
string
|
A process instance ID that acts as a parent process instance of the process instance that is intended to create. |
|
ProcDefID |
string
|
The unique ID of the process model. |
|
ProcInstID |
string
|
The unique ID of a process instance. |
|
ProcInstName |
string
|
A unique name that is associated with the process instance. |
|
Sender |
string
|
The sender of the event. |
|
SentDate |
string
|
The sent date of the event. |
|
SourceWorkItemID |
string
|
An ID that represents the original, or source, task. |
|
Status |
string
|
The status of the event. |
|
TenantID |
string
|
The unique ID of the AgilePoint NX tenant. |
|
UserID |
string
|
The unique ID for a user. |
|
WorkItemID |
string
|
An unique ID that represents a task. |
|
WorkObjectID |
string
|
An ID for an object, such as a document, that is associated with the process instance. |
|
WorkObjectInfo |
string
|
Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Name. |
|
Value |
|
Values in name-value pair. |
Summary:
Description: Values in name-value pair.
Properties:
|
Name |
Type |
Summary |
|
NameValue |
|
NameValue. |
Summary:
Description: NameValue.
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
The name of an item, such as a property or attribute in a name/value pair. |
|
Value |
|
Value. |
Summary:
Description: Value.
Properties:
|
Name |
Type |
Summary |
|
NameValue |
string
|
The value for an item, such as the value for an attribute in a name-value pair. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
attrName |
string
|
Enter attribute name. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetProcInstResult |
|
Result of information about a specified process instance. |
Summary:
Description: Result of information about a specified process instance.
Properties:
|
Name |
Type |
Summary |
|
ApplName |
string
|
The unique name of the app. |
|
ApplicationDisplayName |
string
|
The display name for an AgilePoint NX app. |
|
CompletedDate |
string
|
The date and time when the process instance was completed. |
|
DefID |
string
|
The unique ID of the process model. |
|
DefName |
string
|
The display name of the process model. |
|
DueDate |
string
|
The date that the process instance is expected to be complete. |
|
LastModifiedBy |
string
|
The user who last updated, or modified, the item. |
|
LastModifiedDate |
string
|
The date and time that the last modification was made to the process instance. |
|
LastRunningEndTime |
string
|
The date the process instance last stopped running. |
|
LastRunningStartTime |
string
|
The date the process instance last started or resumed. |
|
LastSwapDate |
string
|
The last time the process instance was swapped out to free up resources. |
|
ProcInitiator |
string
|
The user who starts (kicks off) a process. |
|
ProcInitiatorLoc |
string
|
The IP address of the user who initiated the process instance. |
|
ProcInstID |
string
|
The unique ID of a process instance. |
|
ProcInstName |
string
|
A unique name that is associated with the process instance. |
|
ProcessDefinitionDisplayName |
string
|
The name of the process model. |
|
ProcessInitiator |
string
|
The user who starts (kicks off) a process. |
|
ProcessInitiatorLocation |
string
|
The IP address of the user who initiated the process instance. |
|
SourceProcInstID |
string
|
The ID of the original, or source, process instance. |
|
StartedDate |
string
|
The date and time when the process instance was started(kicked off). |
|
Status |
string
|
The status of the process instance. |
|
SuperProcInstID |
string
|
A process instance ID that acts as a parent process instance of the process instance that is intended to create. |
|
TargetProcInstID |
string
|
The ID of the target, or destination, process instance. |
|
ToplevelProcInstID |
string
|
The ID of the process instance that is the top of the process hierarchy for a process-based app. |
|
Version |
string
|
The version number of the process model. |
|
WorkObjectID |
string
|
An ID for an object, such as a document, that is associated with the process instance. |
|
WorkObjectInfo |
string
|
Usually this parameter is used to hold supplemental information about the work object, such as a URL for a document, within the process instance. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userName |
string
|
Enter username in (Domain\Username) format. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Department |
string
|
The user's department name. |
|
Disabled |
boolean
|
Specifies whether the user is disabled. |
|
EMailAddress |
string
|
The user's email address. |
|
FullName |
string
|
The user's full name. |
|
Level |
string
|
Level. |
|
Locale |
string
|
The locale of the client device. |
|
Manager |
string
|
The full name of the user's manager. |
|
OnlineContact |
string
|
Retrieves the online contact of the user. |
|
RefID |
string
|
The reference ID for the user. |
|
RegisteredDate |
string
|
Retrieves the date the user was registered in AgilePoint NX. |
|
SupportedLanguage |
string
|
Retrieves a list of the languages that are supported. |
|
TimeZone |
string
|
The user's time zone. |
|
Title |
string
|
The user's job title. |
|
UALExpirationDate |
string
|
The date and time the user session expires. |
|
UALNeverExpires |
boolean
|
Specifies whether user's session never expires (i.e., the user has a named license seat). |
|
UserName |
string
|
A qualified user name of the instance. |
|
UserOrgInfo |
string
|
Retrieves information about the user's organization, such as a description. |
|
WorkCalendarID |
string
|
The unique ID of the work calendar for the organization. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetReleasedProcDefsResult |
array of (GetReleasedProcDefsResultItem)
|
GetReleasedProcDefsResult |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Key |
string
|
Key |
|
Value |
string
|
Value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetUUIDResult |
string
|
A UUID generated by Agilepoint Server. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetProcDefsResult |
array of (GetProcDefsResultItem)
|
Result of all versions of all process models (process definitions). |
Summary:
Description: Response of Get Process Models Action
Properties:
|
Name |
Type |
Summary |
|
ApplName |
string
|
The display name for an AgilePoint NX app. |
|
AssemblyName |
string
|
Gets and sets the full name of the assembly. |
|
AuditLevel |
integer(int32)
|
Specifies the amount of process related data that is logged for a process. This property can be set at either the process level or at the individual activity level. This property allows you to control the level of granularity in terms of the amount of process related data that is recorded in the log. |
|
BaseDefID |
string
|
The base process model ID with the specified process model name. |
|
CheckedOutBy |
string
|
The user who last checked out the app. |
|
CheckedOutDate |
string
|
The date the app was last checked out. |
|
ClassName |
string
|
Gets and sets the class name, including the namespace. |
|
CreatedBy |
string
|
The user's name who created the process model. |
|
CreatedDate |
string
|
The date when the process model was created. |
|
DefID |
string
|
The unique ID of the process model. |
|
DefName |
string
|
The display name of the process model. |
|
Description |
string
|
A description of the app. |
|
Diagnostic |
boolean
|
Specifies if the process data will be deleted from the database after the process is completes. |
|
DocRef |
string
|
Specifies the URL of a document. This is typically used for internal documentation for a process designer. |
|
ExpectedTime |
|
Expected time frame for a process instance to be completed. |
|
InitiateConstraint |
integer(int32)
|
Specifies whether the process instance was initiated by an eForm, Event Services, or another process instance. |
|
MaximumSessionAllowed |
integer(int32)
|
Configures the maximum number of sessions for an activity in a process instance. If an activity runs more times than the maximum sessions, the process is suspended. |
|
OnComplete |
integer(int32)
|
The action to execute when a process instance completes. |
|
Owner |
string
|
The user name of the app owner. |
|
PreVersion |
string
|
The previous version number of the app. |
|
ReleaseDate |
string
|
Retrieves the date when the app was released. |
|
Rule |
string
|
Rule. |
|
Status |
string
|
The status of the process model. |
|
SupplementInfo |
string
|
Supplemental information for the process model. |
|
Version |
string
|
The version number of the app. |
Summary:
Description: Expected time frame for a process instance to be completed.
Properties:
|
Name |
Type |
Summary |
|
BusinessTime |
boolean
|
Specifies whether the system calculates the duration using your business time calendar. |
|
Length |
string
|
Specifies the length of time duration. |
|
Unit |
|
Specifies the unit of time. |
Summary:
Description: Specifies the unit of time.
Properties:
|
Name |
Type |
Summary |
|
Value |
integer(int32)
|
Value of the unit. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
attributes |
array of (AttributesItem)
|
Attributes NameValue Pair. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Enter attribute name. |
|
Value |
string
|
Enter attribute value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Enter webhook name. |
|
NotificationAddressUrl |
string
|
Notification Address URL. |
|
Triggers |
array of (string)
|
Triggers. |
|
TargetApplications |
array of (string)
|
TargetApplications. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Enter webhook name. |
|
NotificationAddressUrl |
string
|
Notification Address URL. |
|
Triggers |
array of (string)
|
Triggers. |
|
TargetApplications |
array of (string)
|
TargetApplications. |
|
Headers |
array of (HeadersItem)
|
Headers. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
Enter parameter name. |
|
Value |
string
|
Select parameter type. Values: [Text, Number, Decimal, Date, Time, DateTime, Byte, Boolean] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |