Agilite

Status: Preview

Tier: Premium

Version: 6.1

Name

Summary

executeBPM (string process-key, string bpm-record-id, string option-selected, string current-user, [advanced][Optional]string comments, [Optional]executeBPMParameterProperties properties)

Execute (BPM)

getBPMByProfileKey (string profile-key)

Get By Profile Key (BPM)

getBPMRecordState ([Optional]string process-keys, [advanced][Optional]string bpm-record-ids, [advanced][Optional]string step-names, [advanced][Optional]string responsible-users, [advanced][Optional]string relevant-users, [advanced][Optional]boolean include-history, [advanced][Optional]boolean include-step-options, [advanced][Optional]boolean include-visible-objects)

Get Record State (BPM)

registerBPMRecord (string process-key, string current-user)

Register BPM Record (BPM)

getKeywordsByProfileKey (string profile-key, [advanced][Optional]string sort, [internal]string output-format)

Get By Profile Key (Keywords)

getKeywordsLabelByValue (string profile-key, string value-key, [internal]string output-format)

Get Label By Value (Keywords)

getKeywordProfileKeysByGroup (string group-name, [advanced][Optional]string sort)

Get Profile Keys By Group (Keywords)

getKeywordsValueByLabel (string profile-key, string label-key, [internal]string output-format)

Get Value By Label (Keywords)

generateNumber (string profile-key, [internal]string output-format, [Optional]generateNumberParameterProperties properties)

Generate Number (Numbering)

assignRole (string process-key, string bpm-record-id, string current-user, string role-name, string responsible-users)

Assign Role (Roles)

getAssignedRoles (string process-key, string bpm-record-id, string role-names)

Get Assigned Roles (Roles)

getRole (string role-names, [advanced][Optional]string conditional-levels)

Get Role (Roles)

executeTemplates (string profile-key, [internal]string output-format, [Optional]executeTemplatesParameterProperties properties)

Execute (Templates)

Name

Summary

Name

Summary

assignRoleResponse

data

executeBPMParameterProperties

ExecuteBPMResult

executeTemplatesParameterProperties

generateNumberParameterProperties

getAssignedRolesResponseItem

GetBPMProfile

getBPMRecordStateResponseItem

getKeywordsByProfileKeyResponseItem

getRoleResponse

RegisterBPMRecord

StdJSONResponse

Name

Type

Summary

Required

Related Action

process-key

string

(Process Key)

Unique Key for the targeted profile

True

bpm-record-id

string

(BPM Record Id)

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

True

option-selected

string

(Option Selected)

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

True

current-user

string

(Current User)

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

True

comments

string

(Workflow Step Comments)

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

False

properties

executeBPMParameterProperties

False

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

Name

Type

Summary

Required

Related Action

process-keys

string

(Process Keys)

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)

False

bpm-record-ids

string

(BPM Record Ids)

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)

False

step-names

string

(Step Names)

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

False

responsible-users

string

(Responsible Users)

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

False

relevant-users

string

(Relevant Users)

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

False

include-history

boolean

(Include History)

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

False

include-step-options

boolean

(Include Step Options)

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

False

include-visible-objects

boolean

(Include Visible Objects)

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

False

Name

Type

Summary

Required

Related Action

process-key

string

(Process Key)

Unique Key for the targeted profile

True

current-user

string

(Current User)

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

True

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

sort

string

(Sort)Values: [asc, desc, asc_value, desc_value]

An optional parameter to sort the returned Key/Value result

False

output-format

string

(Output Format)Values: [array, json]

Format the output of the returned result

True

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

value-key

string

(Value Key)

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

True

output-format

string

(Output Format)Values: [string, json]

Format the output of the returned result

True

Name

Type

Summary

Required

Related Action

group-name

string

(Group Name)

The Group name used to group Keyword profiles

True

sort

string

(Sort)Values: [asc, desc, asc_value, desc_value]

An optional parameter to sort the returned Key/Value result

False

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

label-key

string

(Label Key)

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

True

output-format

string

(Output Format)Values: [string, json]

Format the output of the returned result

True

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

output-format

string

(Output Format)Values: [string, json]

Format the output of the returned result

True

properties

generateNumberParameterProperties

False

Name

Type

Summary

Required

Related Action

process-key

string

(Process Key)

Unique Key for the targeted profile

True

bpm-record-id

string

(BPM Record Id)

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

True

current-user

string

(Current User)

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

True

role-name

string

(Role Name)

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

True

responsible-users

string

(Responsible Users)

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

True

Name

Type

Summary

Required

Related Action

process-key

string

(Process Key)

Unique Key for the targeted profile

True

bpm-record-id

string

(BPM Record Id)

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

True

role-names

string

(Role Name)

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

True

Name

Type

Summary

Required

Related Action

role-names

string

(Role Names)

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

True

conditional-levels

string

(Conditional Levels)

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)

False

Name

Type

Summary

Required

Related Action

profile-key

string

(Profile Key)

Unique Key for the targeted profile

True

output-format

string

(Output Format)Values: [string, json]

Format the output of the returned result

True

properties

executeTemplatesParameterProperties

False

Name

Type

Summary

Name

Type

Summary

Name

Type

Summary

description

string

Process Step Description

A short description explaining the Process Step

duration

string

SLA Duration (Hrs)

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

eventStamp

string

Process Step Event Stamp

An Event Stamp for the current Process Step

instructions

string

Step Instructions

Instructions to Responsible User during Step

key

string

Process Step Key

A unique key to identify the Process Step

name

string

Process Step Name

A short name for the Process Step

processKey

string

BPM Profile Key

A unique key to identify the BPM Profile

processStage

string

Process Stage

A key that defines the Process Stage of the current Step

responsibility

string

Responsibility Type

User/Role Based Responsibility

responsibleRole

string

Process Step Responsible Role

The role responsible for the current Process Step

responsibleUsers

array of (string)

Process Step Responsible Users

The users responsible for the current Process Step

stepOptions

array of (StepOptionsItem)

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

description

string

Step Option Description

A short description explaining the Step Option

eventStamp

array of (string)

Step Option Event Stamp

An Event Stamp for the current Step Option

name

string

Step Option Name

A short name for the Step Option

nextStep

string

Next Step

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

notes

string

Step Option Notes

Optional Notes for Step Option

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

id

string

Step Option Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Step Option Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Step Option Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

id

string

Process Step Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Process Step Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Process Step Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

Name

Type

Summary

Name

Type

Summary

name

string

Name

users

array of (UsersItem)

Users

Name

Type

Summary

email

string

Email

Name

Type

Summary

appAdmin

array of (AppAdminItem)

appUrl

string

BPM App URL

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

description

string

BPM Profile Description

A short description explaining the BPM profile

groupName

string

BPM Profile Group Name

An optional grouping for the BPM profile

key

string

BPM Profile Key

A unique key to identify the BPM Profile

name

string

BPM Profile Name

A short name for the BPM profile

notes

string

BPM Profile Notes

Optional Notes for BPM Profile

processSteps

array of (ProcessStepsItem)

referenceUrl

string

BPM Profile Reference URL

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

Name

Type

Summary

email

string

App Admin Email

An email address for the Admin of the current BPM profile

Name

Type

Summary

description

string

Process Step Description

A short description explaining the Process Step

duration

string

SLA Duration (Hrs)

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

firstStep

boolean

Is First Step

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

instructions

string

Step Instructions

Instructions to Responsible User during Step

key

string

Process Step Key

A unique key to identify the Process Step

name

string

Process Step Name

A short name for the Process Step

processStage

string

Process Stage

A key that defines the Process Stage of the current Step

referenceUrl

string

Process Step Reference URL

A reference URL for the Process Step

responsibility

string

Responsibility Type

User/Role Based Responsibility

responsibleRole

string

Process Step Responsible Role

The role responsible for the current Step

roleLevels

array of (string)

Conditional Role Levels

stepOptions

array of (StepOptionsItem)

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

description

string

Step Option Description

A short description explaining the Step Option

name

string

Step Option Name

A short name for the Step Option

nextStep

string

Next Step

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

notes

string

Step Option Notes

Optional Notes for Step Option

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

id

string

Step Option Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Step Option Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Step Option Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

id

string

Process Step Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Process Step Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Process Step Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

description

string

Process Step Description

A short description explaining the Process Step

duration

string

SLA Duration (Hrs)

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

eventStampHistory

array of (EventStampHistoryItem)

history

array of (HistoryItem)

instructions

string

Step Instructions

Instructions to Responsible User during Step

key

string

Process Step Key

A unique key to identify the Process Step

name

string

Process Step Name

A short name for the Process Step

processKey

string

BPM Profile Key

A unique key to identify the BPM Profile

processStage

string

Process Stage

A key that defines the Process Stage of the current Step

recordId

string

BPM Record Id

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

recordRef

string

BPM Record Reference

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

referenceUrl

string

Process Step Reference URL

A reference URL for the Process Step

responsibleRole

string

Process Step Responsible Role

The role responsible for the current Step

responsibleUsers

array of (string)

Process Step Responsible Users

Responsible user(s) for the current Process Step

roles

array of (RolesItem)

stepOptions

array of (StepOptionsItem)

submittedIntoStep

string(date-time)

Submitted Into Step

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

targetTimeDuration

string(date-time)

Target Time Duration

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

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

eventName

string

Event Stamp History Name

Name of the Event Stamp

timeStamp

string(date-time)

Event Stamp History Timestamp

The timestamp of when the Event Stamp occurred

Name

Type

Summary

comments

string

History Comments

Optional comments added at the time the History entry was created

currentRole

string

History Current Role

The current Role at the time of the History entry

currentUser

string

History Current User

The current User at the time of the History entry

duration

string

Step Duration

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

eventStamp

array of (string)

History Event Stamp

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

fromStep

string

From Step

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

fromStepName

string

From Step Name

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

optionSelected

string

History Option Selected

The option selected when actioning the BPM record

processKey

string

History BPM Process Key

The unique BPM Process Key for the History entry

processStage

string

History Process Stage

The Process stage at the time of the History entry

recordId

string

History BPM Record Id

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

responsibleRole

string

History Responsible Role

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

responsibleUsers

array of (string)

History Responsible Users

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

submissionDate

string(date-time)

History Submission Date

The date/time the BPM record was actioned

toProcessStage

string

To Process Stage

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

toStep

string

To Step

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

toStepName

string

To Step Name

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

Name

Type

Summary

name

string

Role Name

Name of the Role

users

array of (UsersItem)

Name

Type

Summary

email

string

Role Email

Email address(es) linked to the Role name

Name

Type

Summary

description

string

Step Option Description

A short description explaining the Step Option

eventStamp

array of (string)

Step Option Event Stamp

An Event Stamp for the current Step Option

name

string

Step Option Name

A short name for the Step Option

nextStep

string

Next Step

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

notes

string

Step Option Notes

Optional Notes for Step Option

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

id

string

Step Option Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Step Option Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Step Option Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

id

string

Process Step Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Process Step Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Process Step Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

label

string

Label

value

string

Value

Name

Type

Summary

responsibleUsers

array of (string)

responsibleUsers

responsibleUsers

Name

Type

Summary

description

string

Process Step Description

A short description explaining the Process Step

duration

string

SLA Duration (Hrs)

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

eventStampHistory

array of (EventStampHistoryItem)

history

array of (HistoryItem)

instructions

string

Step Instructions

Instructions to Responsible User during Step

key

string

Process Step Key

A unique key to identify the Process Step

name

string

Process Step Name

A short name for the Process Step

processKey

string

BPM Profile Key

A unique key to identify the BPM Profile

processStage

string

Process Stage

A key that defines the Process Stage of the current Step

recordId

string

BPM Record Id

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

recordRef

string

BPM Record Reference

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

referenceUrl

string

Process Step Reference URL

A reference URL for the Process Step

responsibleRole

string

Process Step Responsible Role

The role responsible for the current Process Step

responsibleUsers

array of (string)

Process Step Responsible Users

The users responsible for the current Process Step

roles

array of (RolesItem)

stepOptions

array of (StepOptionsItem)

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

eventName

string

Event Stamp History Name

Name of the Event Stamp

timeStamp

string(date-time)

Event Stamp History Timestamp

The timestamp of when the Event Stamp occurred

Name

Type

Summary

comments

string

History Comments

Optional comments added at the time the History entry was created

currentRole

string

History Current Role

The current Role at the time of the History entry

currentUser

string

History Current User

The current User at the time of the History entry

duration

string

Step Duration

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

eventStamp

array of (string)

History Event Stamp

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

fromStep

string

From Step

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

fromStepName

string

From Step Name

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

optionSelected

string

History Option Selected

The option selected when actioning the BPM record

processKey

string

History BPM Process Key

The unique BPM Process Key for the History entry

processStage

string

History Process Stage

The Process stage at the time of the History entry

recordId

string

History BPM Record Id

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

responsibleRole

string

History Responsible Role

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

responsibleUsers

array of (string)

History Responsible Users

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

submissionDate

string(date-time)

History Submission Date

The date/time the BPM record was actioned

toProcessStage

string

To Process Stage

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

toStep

string

To Step

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

toStepName

string

To Step Name

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

Name

Type

Summary

name

string

Role Name

Name of the Role

users

array of (UsersItem)

Name

Type

Summary

email

string

Role Email

Email address(es) linked to the Role name

Name

Type

Summary

description

string

Step Option Description

A short description explaining the Step Option

eventStamp

array of (string)

Step Option Event Stamp

An Event Stamp for the current Step Option

name

string

Step Option Name

A short name for the Step Option

nextStep

string

Next Step

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

notes

string

Step Option Notes

Optional notes for the Step Option

visibleObjects

array of (VisibleObjectsItem)

Name

Type

Summary

id

string

Step Option Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Step Option Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Step Option Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

id

string

Process Step Object Id

The id of the component that gets referenced in the UI

inputOptions

InputOptions

isEditable

boolean

Is Process Step Object Editable

Is the component referenced editable for user input

isMandatory

boolean

Is Process Step Object Mandatory

Does the component referenced require user input

Name

Type

Summary

choices

array of (ChoicesItem)

label

string

Input Options Label

A label defining the input field or editable component

messages

array of (string)

Input Options Messages

Messages to be used when Input Options validation fails

type

string

Input Options Type

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

Name

Type

Summary

label

string

Choices Type Label

A label for selected choice

value

string

Choices Type Value

A value for selected choice

Name

Type

Summary

result

string

Result

Result