Agilite (Preview)

Agilit-e enables you to centralize your business logic and processes and expose them as microservices to new or existing applications. With the Agilit-e connector, you gain access to many services including Business Process Management (BPM), Roles, Keywords, Templates and more.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Specify Agilit-e API Server URL. (Use 'https://api.agilite.io' for Agilit-e Cloud) string

Specify Agilit-e API Server URL. (Use 'https://api.agilite.io' for Agilit-e Cloud)

API Key (Generated in 'https://portal.agilite.io' under Administration) securestring

API Key (Generated in 'https://portal.agilite.io' under Administration)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Assign Role (Roles)

Assign user specified role that is applicable to a specific record. An example of this would be a document reviewer or a leave approver

Execute (BPM)

Submits an option in its current workflow step. Depending on the business rules, the record wil be progressed to the next step in the process and return information about the next step to the calling api

Execute (Templates)

Processes and returns a Template from Agilit-e based on the 'profile-key' provided

Generate Number (Numbering)

Generates a unique number based on 'profile-key' provided

Get Assigned Roles (Roles)

Get responsible person(s) for previously assigned role for a specific record

Get By Profile Key (BPM)

Get the full BPM Profile with configuration and options for the process.

Get By Profile Key (Keywords)

Returns Key/Value pairs of a specific Keyword profile based on the 'profile-key' provided

Get Label By Value (Keywords)

Returns a Keyword Label based on the 'profile-key' and 'value-key' provided

Get Profile Keys By Group (Keywords)

Returns all Keyword profile keys based on the 'group-name' provided

Get Record State (BPM)

Get BPM Record State for one or more records to include the current status, who is responsible for the record, the workflow history and other information to describe the current state and rules for the record

Get Role (Roles)

Get responsible person(s) that are assigned to roles in the Agilit-e admin portal. These roles are not only relevant to specific records or business processes and are more typically used for company wide roles in the organization

Get Value By Label (Keywords)

Returns a Keyword Value based on the 'profile-key' and 'label-key' provided

Register BPM Record (BPM)

Register new BPM Record. The record is assigned with a recordID that is used for the record life cycle to identify the record, it's progress, history and status at all time

Assign Role (Roles)

Assign user specified role that is applicable to a specific record. An example of this would be a document reviewer or a leave approver

Parameters

Name Key Required Type Description
Process Key
process-key True string

Unique Key for the targeted profile

BPM Record Id
bpm-record-id True string

Identifies the record that the role is being set for. The id is registered by the registerBPMRecord api for new records and can be found in the recordID property of the BPM api responses

Current User
current-user True string

The email address of the user that is setting the role. This will typically be the user that is logged in at the time of calling the api

Role Name
role-name True string

The name of the role that is being assigned. E.g Approver or Reviewer

Responsible Users
responsible-users True string

The email addresses of the users who is assigned to this role - (separate using commas)

Execute (BPM)

Submits an option in its current workflow step. Depending on the business rules, the record wil be progressed to the next step in the process and return information about the next step to the calling api

Parameters

Name Key Required Type Description
Process Key
process-key True string

Unique Key for the targeted profile

BPM Record Id
bpm-record-id True string

Identifies the record that is being submitted. The id is registered by the registerBPMRecord api for new records and can be found in the recordID property of the BPM api responses

Option Selected
option-selected True string

Identifies the option that is selected by the user to be executed as part of the submission process. This value has to correspond with a valid step option in the workflow profile

Current User
current-user True string

The email address of the user that is submitting the BPM step. This will typically be the user that is logged in at the time of calling the api

Workflow Step Comments
comments string

Passes comments to the execution process which will be stamped into the workflow history. This would typically be used if the user is rejecting a step, or requesting more information

Returns

Execute (Templates)

Processes and returns a Template from Agilit-e based on the 'profile-key' provided

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Returns

Generate Number (Numbering)

Generates a unique number based on 'profile-key' provided

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Returns

Get Assigned Roles (Roles)

Get responsible person(s) for previously assigned role for a specific record

Parameters

Name Key Required Type Description
Process Key
process-key True string

Unique Key for the targeted profile

BPM Record Id
bpm-record-id True string

Identifies the record that the role is being set for. The id is registered by the registerBPMRecord api for new records and can be found in the recordID property of the BPM api responses

Role Name
role-names True string

The Role(s) to be queried (separate using commas)

Returns

Name Path Type Description
array of object
Name
name string
Users
users array of object
Email
users.email string

Get By Profile Key (BPM)

Get the full BPM Profile with configuration and options for the process.

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Returns

Get By Profile Key (Keywords)

Returns Key/Value pairs of a specific Keyword profile based on the 'profile-key' provided

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Sort
sort string

An optional parameter to sort the returned Key/Value result

Returns

Get Label By Value (Keywords)

Returns a Keyword Label based on the 'profile-key' and 'value-key' provided

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Value Key
value-key True string

The Value key in the Label/Value listing for the targeted profile

Returns

Get Profile Keys By Group (Keywords)

Returns all Keyword profile keys based on the 'group-name' provided

Parameters

Name Key Required Type Description
Group Name
group-name True string

The Group name used to group Keyword profiles

Sort
sort string

An optional parameter to sort the returned Key/Value result

Returns

Name Path Type Description
array of string

Get Record State (BPM)

Get BPM Record State for one or more records to include the current status, who is responsible for the record, the workflow history and other information to describe the current state and rules for the record

Parameters

Name Key Required Type Description
Process Keys
process-keys string

Filter to identify the business process(es) that records will be returned for. This key can be found on the BPM profile in the Agilit-e Admin Portal - (separate using commas)

BPM Record Ids
bpm-record-ids string

filter to only return records with specific recordIds. The recordId is registered by the registerBPMRecord api for new records and can be found in the recordID property of the BPM api responses - (separate using commas)

Step Names
step-names string

Filter to only return records that are currently to the specified workflow step(s) - (separate using commas)

Responsible Users
responsible-users string

Filter to only return records that are currently assigned to the specified email address(es) - (separate using commas)

Relevant Users
relevant-users string

Filter to only return records that are relevant to the specified email address(es) - (separate using commas)

Include History
include-history boolean

Specify if the history object should be returned with the record state information

Include Step Options
include-step-options boolean

Specify if the step options object should be returned with the record state information

Include Visible Objects
include-visible-objects boolean

Specify if the visible objects object should be returned with the record state information

Returns

Get Role (Roles)

Get responsible person(s) that are assigned to roles in the Agilit-e admin portal. These roles are not only relevant to specific records or business processes and are more typically used for company wide roles in the organization

Parameters

Name Key Required Type Description
Role Names
role-names True string

Specify the role name(s) that you want to retrieve the responsible users for - (separate using commas)

Conditional Levels
conditional-levels string

Specify additional levels that can be used to determine the correct person for the role. An example of a level might be a department name (if you want to retrieve the Department Manager), or a product name (if you want to retrieve the Product Manager) - (separate using commas)

Returns

Name Path Type Description
responsibleUsers
responsibleUsers array of string

responsibleUsers

Get Value By Label (Keywords)

Returns a Keyword Value based on the 'profile-key' and 'label-key' provided

Parameters

Name Key Required Type Description
Profile Key
profile-key True string

Unique Key for the targeted profile

Label Key
label-key True string

The Label key in the Label/Value listing for the targeted profile

Returns

Register BPM Record (BPM)

Register new BPM Record. The record is assigned with a recordID that is used for the record life cycle to identify the record, it's progress, history and status at all time

Parameters

Name Key Required Type Description
Process Key
process-key True string

Unique Key for the targeted profile

Current User
current-user True string

The email address of the user that is registering the record. This will typically be the user that is logged in at the time of calling the api

Returns

Definitions

ExecuteBPMResult

Name Path Type Description
Process Step Description
description string

A short description explaining the Process Step

SLA Duration (Hrs)
duration string

The SLA Duration in hours. Provide a value of 0 if not applicable

Process Step Event Stamp
eventStamp string

An Event Stamp for the current Process Step

Step Instructions
instructions string

Instructions to Responsible User during Step

Process Step Key
key string

A unique key to identify the Process Step

Process Step Name
name string

A short name for the Process Step

BPM Profile Key
processKey string

A unique key to identify the BPM Profile

Process Stage
processStage string

A key that defines the Process Stage of the current Step

Responsibility Type
responsibility string

User/Role Based Responsibility

Process Step Responsible Role
responsibleRole string

The role responsible for the current Process Step

Process Step Responsible Users
responsibleUsers array of string

The users responsible for the current Process Step

stepOptions
stepOptions array of object
Step Option Description
stepOptions.description string

A short description explaining the Step Option

Step Option Event Stamp
stepOptions.eventStamp array of string

An Event Stamp for the current Step Option

Step Option Name
stepOptions.name string

A short name for the Step Option

Next Step
stepOptions.nextStep string

The next step the business process will be routed to. Leave empty if no further steps

Step Option Notes
stepOptions.notes string

Optional Notes for Step Option

visibleObjects
stepOptions.visibleObjects array of object
Step Option Object Id
stepOptions.visibleObjects.id string

The id of the component that gets referenced in the UI

choices
stepOptions.visibleObjects.inputOptions.choices array of object
Choices Type Label
stepOptions.visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
stepOptions.visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
stepOptions.visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
stepOptions.visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
stepOptions.visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Step Option Object Editable
stepOptions.visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Step Option Object Mandatory
stepOptions.visibleObjects.isMandatory boolean

Does the component referenced require user input

visibleObjects
visibleObjects array of object
Process Step Object Id
visibleObjects.id string

The id of the component that gets referenced in the UI

choices
visibleObjects.inputOptions.choices array of object
Choices Type Label
visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Process Step Object Editable
visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Process Step Object Mandatory
visibleObjects.isMandatory boolean

Does the component referenced require user input

GetBPMProfile

Name Path Type Description
appAdmin
appAdmin array of object
App Admin Email
appAdmin.email string

An email address for the Admin of the current BPM profile

BPM App URL
appUrl string

An optional url for the app that makes use of the current BPM profile

BPM Profile Description
description string

A short description explaining the BPM profile

BPM Profile Group Name
groupName string

An optional grouping for the BPM profile

BPM Profile Key
key string

A unique key to identify the BPM Profile

BPM Profile Name
name string

A short name for the BPM profile

BPM Profile Notes
notes string

Optional Notes for BPM Profile

processSteps
processSteps array of object
Process Step Description
processSteps.description string

A short description explaining the Process Step

SLA Duration (Hrs)
processSteps.duration string

The SLA Duration in hours. Provide a value of 0 if not applicable

Is First Step
processSteps.firstStep boolean

Specify if the Process Step record is the first step in the Business Process

Step Instructions
processSteps.instructions string

Instructions to Responsible User during Step

Process Step Key
processSteps.key string

A unique key to identify the Process Step

Process Step Name
processSteps.name string

A short name for the Process Step

Process Stage
processSteps.processStage string

A key that defines the Process Stage of the current Step

Process Step Reference URL
processSteps.referenceUrl string

A reference URL for the Process Step

Responsibility Type
processSteps.responsibility string

User/Role Based Responsibility

Process Step Responsible Role
processSteps.responsibleRole string

The role responsible for the current Step

roleLevels
processSteps.roleLevels array of string

Conditional Role Levels

stepOptions
processSteps.stepOptions array of object
Step Option Description
processSteps.stepOptions.description string

A short description explaining the Step Option

Step Option Name
processSteps.stepOptions.name string

A short name for the Step Option

Next Step
processSteps.stepOptions.nextStep string

The next step the business process will be routed to. Leave empty if no further steps

Step Option Notes
processSteps.stepOptions.notes string

Optional Notes for Step Option

visibleObjects
processSteps.stepOptions.visibleObjects array of object
Step Option Object Id
processSteps.stepOptions.visibleObjects.id string

The id of the component that gets referenced in the UI

choices
processSteps.stepOptions.visibleObjects.inputOptions.choices array of object
Choices Type Label
processSteps.stepOptions.visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
processSteps.stepOptions.visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
processSteps.stepOptions.visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
processSteps.stepOptions.visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
processSteps.stepOptions.visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Step Option Object Editable
processSteps.stepOptions.visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Step Option Object Mandatory
processSteps.stepOptions.visibleObjects.isMandatory boolean

Does the component referenced require user input

visibleObjects
processSteps.visibleObjects array of object
Process Step Object Id
processSteps.visibleObjects.id string

The id of the component that gets referenced in the UI

choices
processSteps.visibleObjects.inputOptions.choices array of object
Choices Type Label
processSteps.visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
processSteps.visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
processSteps.visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
processSteps.visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
processSteps.visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Process Step Object Editable
processSteps.visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Process Step Object Mandatory
processSteps.visibleObjects.isMandatory boolean

Does the component referenced require user input

BPM Profile Reference URL
referenceUrl string

An optional url that can be referenced for the current BPM profile

GetBPMRecordState

Name Path Type Description
Process Step Description
description string

A short description explaining the Process Step

SLA Duration (Hrs)
duration string

The SLA Duration in hours. Provide a value of 0 if not applicable

eventStampHistory
eventStampHistory array of object
Event Stamp History Name
eventStampHistory.eventName string

Name of the Event Stamp

Event Stamp History Timestamp
eventStampHistory.timeStamp date-time

The timestamp of when the Event Stamp occurred

history
history array of object
History Comments
history.comments string

Optional comments added at the time the History entry was created

History Current Role
history.currentRole string

The current Role at the time of the History entry

History Current User
history.currentUser string

The current User at the time of the History entry

Step Duration
history.duration string

The time (in minutes) the record existed in the current Process Step before being actioned

History Event Stamp
history.eventStamp array of string

Event Stamp(s) that occurred at the time of the History entry

From Step
history.fromStep string

The Key of the Process Step the BPM record came from at the time of the History entry

From Step Name
history.fromStepName string

The Name of the Process Step the BPM record came from at the time of the History entry

History Option Selected
history.optionSelected string

The option selected when actioning the BPM record

History BPM Process Key
history.processKey string

The unique BPM Process Key for the History entry

History Process Stage
history.processStage string

The Process stage at the time of the History entry

History BPM Record Id
history.recordId string

The record id for the BPM related record generated during the Register BPM Record process

History Responsible Role
history.responsibleRole string

The responsible Role of the BPM Record at the time of the History entry

History Responsible Users
history.responsibleUsers array of string

Responsible User(s) at the time of the History entry

History Submission Date
history.submissionDate date-time

The date/time the BPM record was actioned

To Process Stage
history.toProcessStage string

The Process stage for the BPM record at the time of the History entry

To Step
history.toStep string

The Key of the Process Step for the BPM record at the time of the History entry

To Step Name
history.toStepName string

The Name of the Process Step for the BPM record at the time of the History entry

Step Instructions
instructions string

Instructions to Responsible User during Step

Process Step Key
key string

A unique key to identify the Process Step

Process Step Name
name string

A short name for the Process Step

BPM Profile Key
processKey string

A unique key to identify the BPM Profile

Process Stage
processStage string

A key that defines the Process Stage of the current Step

BPM Record Id
recordId string

The record id generated by the BPM module when registering a BPM Record

BPM Record Reference
recordRef string

A readable number generated by the BPM module using the Numbering module when registering a BPM Record

Process Step Reference URL
referenceUrl string

A reference URL for the Process Step

Process Step Responsible Role
responsibleRole string

The role responsible for the current Step

Process Step Responsible Users
responsibleUsers array of string

Responsible user(s) for the current Process Step

roles
roles array of object
Role Name
roles.name string

Name of the Role

users
roles.users array of object
Role Email
roles.users.email string

Email address(es) linked to the Role name

stepOptions
stepOptions array of object
Step Option Description
stepOptions.description string

A short description explaining the Step Option

Step Option Event Stamp
stepOptions.eventStamp array of string

An Event Stamp for the current Step Option

Step Option Name
stepOptions.name string

A short name for the Step Option

Next Step
stepOptions.nextStep string

The next step the business process will be routed to. Leave empty if no further steps

Step Option Notes
stepOptions.notes string

Optional Notes for Step Option

visibleObjects
stepOptions.visibleObjects array of object
Step Option Object Id
stepOptions.visibleObjects.id string

The id of the component that gets referenced in the UI

choices
stepOptions.visibleObjects.inputOptions.choices array of object
Choices Type Label
stepOptions.visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
stepOptions.visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
stepOptions.visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
stepOptions.visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
stepOptions.visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Step Option Object Editable
stepOptions.visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Step Option Object Mandatory
stepOptions.visibleObjects.isMandatory boolean

Does the component referenced require user input

Submitted Into Step
submittedIntoStep date-time

The date/time the BPM record was submitted into the current Process Step

Target Time Duration
targetTimeDuration date-time

The date/time the BPM record needs to be actioned by based on the SLA Duration

visibleObjects
visibleObjects array of object
Process Step Object Id
visibleObjects.id string

The id of the component that gets referenced in the UI

choices
visibleObjects.inputOptions.choices array of object
Choices Type Label
visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Process Step Object Editable
visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Process Step Object Mandatory
visibleObjects.isMandatory boolean

Does the component referenced require user input

KeywordValues

Name Path Type Description
Label
label string
Value
value string

RegisterBPMRecord

Name Path Type Description
Process Step Description
description string

A short description explaining the Process Step

SLA Duration (Hrs)
duration string

The SLA Duration in hours. Provide a value of 0 if not applicable

eventStampHistory
eventStampHistory array of object
Event Stamp History Name
eventStampHistory.eventName string

Name of the Event Stamp

Event Stamp History Timestamp
eventStampHistory.timeStamp date-time

The timestamp of when the Event Stamp occurred

history
history array of object
History Comments
history.comments string

Optional comments added at the time the History entry was created

History Current Role
history.currentRole string

The current Role at the time of the History entry

History Current User
history.currentUser string

The current User at the time of the History entry

Step Duration
history.duration string

The time (in minutes) the record existed in the current Process Step before being actioned

History Event Stamp
history.eventStamp array of string

Event Stamp(s) that occurred at the time of the History entry

From Step
history.fromStep string

The Key of the Process Step the BPM record came from at the time of the History entry

From Step Name
history.fromStepName string

The Name of the Process Step the BPM record came from at the time of the History entry

History Option Selected
history.optionSelected string

The option selected when actioning the BPM record

History BPM Process Key
history.processKey string

The unique BPM Process Key for the History entry

History Process Stage
history.processStage string

The Process stage at the time of the History entry

History BPM Record Id
history.recordId string

The record id for the BPM related record generated during the Register BPM Record process

History Responsible Role
history.responsibleRole string

The responsible Role of the BPM Record at the time of the History entry

History Responsible Users
history.responsibleUsers array of string

Responsible User(s) at the time of the History entry

History Submission Date
history.submissionDate date-time

The date/time the BPM record was actioned

To Process Stage
history.toProcessStage string

The Process stage for the BPM record at the time of the History entry

To Step
history.toStep string

The Key of the Process Step for the BPM record at the time of the History entry

To Step Name
history.toStepName string

The Name of the Process Step for the BPM record at the time of the History entry

Step Instructions
instructions string

Instructions to Responsible User during Step

Process Step Key
key string

A unique key to identify the Process Step

Process Step Name
name string

A short name for the Process Step

BPM Profile Key
processKey string

A unique key to identify the BPM Profile

Process Stage
processStage string

A key that defines the Process Stage of the current Step

BPM Record Id
recordId string

The record id generated by the BPM module when registering a BPM Record

BPM Record Reference
recordRef string

A readable number generated by the BPM module using the Numbering module when registering a BPM Record

Process Step Reference URL
referenceUrl string

A reference URL for the Process Step

Process Step Responsible Role
responsibleRole string

The role responsible for the current Process Step

Process Step Responsible Users
responsibleUsers array of string

The users responsible for the current Process Step

roles
roles array of object
Role Name
roles.name string

Name of the Role

users
roles.users array of object
Role Email
roles.users.email string

Email address(es) linked to the Role name

stepOptions
stepOptions array of object
Step Option Description
stepOptions.description string

A short description explaining the Step Option

Step Option Event Stamp
stepOptions.eventStamp array of string

An Event Stamp for the current Step Option

Step Option Name
stepOptions.name string

A short name for the Step Option

Next Step
stepOptions.nextStep string

The next step the business process will be routed to. Leave empty if no further steps

Step Option Notes
stepOptions.notes string

Optional notes for the Step Option

visibleObjects
stepOptions.visibleObjects array of object
Step Option Object Id
stepOptions.visibleObjects.id string

The id of the component that gets referenced in the UI

choices
stepOptions.visibleObjects.inputOptions.choices array of object
Choices Type Label
stepOptions.visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
stepOptions.visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
stepOptions.visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
stepOptions.visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
stepOptions.visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Step Option Object Editable
stepOptions.visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Step Option Object Mandatory
stepOptions.visibleObjects.isMandatory boolean

Does the component referenced require user input

visibleObjects
visibleObjects array of object
Process Step Object Id
visibleObjects.id string

The id of the component that gets referenced in the UI

choices
visibleObjects.inputOptions.choices array of object
Choices Type Label
visibleObjects.inputOptions.choices.label string

A label for selected choice

Choices Type Value
visibleObjects.inputOptions.choices.value string

A value for selected choice

Input Options Label
visibleObjects.inputOptions.label string

A label defining the input field or editable component

Input Options Messages
visibleObjects.inputOptions.messages array of string

Messages to be used when Input Options validation fails

Input Options Type
visibleObjects.inputOptions.type string

Defines the type of input field or editable component to be used

Is Process Step Object Editable
visibleObjects.isEditable boolean

Is the component referenced editable for user input

Is Process Step Object Mandatory
visibleObjects.isMandatory boolean

Does the component referenced require user input

StdJSONResponse

Name Path Type Description
Result
result string

Result