Queries

Mar 30, 2021

getContact

Returns

Returns ContactType

Arguments

Argument Required? Description
contactCode (String) contact Code

Back to Top


getFilterableProcesses

Returns a collection of ProcessTypes that the user can filter on, not just owns

Returns

Returns [ProcessType]

Back to Top


getFollowers

Returns

Returns [ContactType]

Arguments

Argument Required? Description
processCode (String) process Code

Back to Top


getLiveWorkflow

Returns the ProcessType that's LIVE

Returns

Returns ProcessType

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


getProcess

Returns a ProcessType owned by the user

Returns

Returns ProcessType

Arguments

Argument Required? Description
processCode (String) Process Code
processId (Decimal) process Id

Back to Top


getProcessDefaultFollowers

Returns a collection of ContactTypes that are default followers

Returns

Returns [ContactType]

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


getProcesses

Returns a collection of ProcessTypes owned by the user

Returns

Returns [ProcessType]

Arguments

Argument Required? Description
sortBy (String) Sort requests by one of their attributes
sortDirection (String) Sort requests either by ascending or descending direction based on sortBy value
isIncludePublic (Boolean) Include all public workflows?

Back to Top


getProcessRules

Returns a collection of RuleTypes specific to this process

Returns

Returns [RuleType]

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


getProcessStep

Returns

Returns ProcessStepType

Arguments

Argument Required? Description
stepCode (String) Code of process step

Back to Top


getProject

Returns

Returns ProjectType

Arguments

Argument Required? Description
projectCode (String) Project Code

Back to Top


getProjects

Returns

Returns [ProjectType]

Arguments

Argument Required? Description
getOwnershipBundlesOnly (Boolean) Returns only bundles that the user is an owner of
excludeCanceled (Boolean) filters out Canceled Bundles
excludeDeactivated (Boolean) filters out Deactivated Bundles

Back to Top


getRequest

Returns

Returns RequestType

Arguments

Argument Required? Description
requestCode (String) request Code
contactCode (String) contact Code

Back to Top


getRequestIsNotFollower

Returns

Returns Int

Arguments

Argument Required? Description
processCode (String) process Code

Back to Top


getRequestRecurrence

Returns

Returns RequestRecurrenceType

Arguments

Argument Required? Description
requestRecurrenceCode (String) Request Recurrence Code

Back to Top


getRequests

Returns

Returns [RequestType]

Arguments

Argument Required? Description
requestCodes (String) List of Request codes
processCodes (String) List of Process codes
masterProcessCodes (String) List of Master Process codes
stepOwnerContactCodes (String) List of Step Owner Contact codes
stepOwnerContactPoolCodes (String) List of Step Owner Team codes
requesterContactCodes (String) List of Requester Contact codes
requestDateSubmittedFrom (String) Date from which requests were submitted
requestDateSubmittedTo (String) Date to which requests were submitted
requestStatusNames (String) List of Request Status Names
page (Int) page
pageSize (Int) page size (max 50)

Back to Top


getRequestsFacets

Returns

Returns FacetsType

Arguments

Argument Required? Description
preFilter (String) Baseline filter for each Request Grid tab

Back to Top


getRequestStep

Returns

Returns RequestStepType

Arguments

Argument Required? Description
stepCode (String) Step Code

Back to Top


getRequestStepForm

Returns

Returns FormType

Arguments

Argument Required? Description
stepCode (String) Step Code

Back to Top


getTeam

Returns

Returns ContactPoolType

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code

Back to Top


getTeams

Returns

Returns [ContactPoolType]

Arguments

Argument Required? Description
ownerContactCodes (String) List of Owner Contact codes
page (Int) page
pageSize (Int) page size (max 50)

Back to Top


getTemplates

Returns

Returns [ProcessType]

Arguments

Argument Required? Description
templateID (Decimal) template ID
templateCategory (Decimal) template Category

Back to Top


getThirdPartyUsers

Returns

Returns [ContactType]

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code
includeDeactive (Int) includeDeactive

Back to Top


isProjectOwner

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCode (String) Project Code

Back to Top


me

Returns

Returns ContactType

Back to Top