getContact
Returns
Returns ContactType
Arguments
| Argument | Required? | Description |
|---|---|---|
| contactCode (String) | contact Code |
getExternalWorkflow
Returns
Returns ProcessType
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code |
getFilterableProcesses
Returns a collection of ProcessTypes that the user can filter on, not just owns
Returns
Returns [ProcessType]
getFollowers
Returns
Returns [ContactType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | process Code |
getLiveWorkflow
Returns the ProcessType that's LIVE
Returns
Returns ProcessType
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code |
getProcess
Returns a ProcessType owned by the user
Returns
Returns ProcessType
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code | |
| processId (Decimal) | process Id |
getProcessDefaultFollowers
Returns a collection of ContactTypes that are default followers
Returns
Returns [ContactType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code |
getProcessDefaultFollowerTeams
Returns a collection of ContactTypes that are default follower teams
Returns
Returns [ContactPoolType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code |
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? |
getProcessesSearch
Returns
Returns SearchPageResultType
Arguments
| Argument | Required? | Description |
|---|---|---|
| ownerContactCodes (String) | List of Owner Contact codes | |
| ownerContactPoolCodes (String) | List of Owner Contact Pool codes | |
| searchTerm (String) | searchTerm | |
| sortBy (String) | Sort By | |
| sortDir (String) | Sort Direction | |
| isIncludeArchive (Int) | Is Include Archive? | |
| page (Int) | page | |
| pageSize (Int) | page size (max 20) |
getProcessRules
Returns a collection of RuleTypes specific to this process
Returns
Returns [RuleType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | Process Code |
getProcessStep
Returns
Returns ProcessStepType
Arguments
| Argument | Required? | Description |
|---|---|---|
| stepCode (String) | step Code |
getProject
Returns
Returns ProjectType
Arguments
| Argument | Required? | Description |
|---|---|---|
| projectCode (String) | Project Code |
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 | |
| searchTerm (String) | searchTerm | |
| page (Int) | page | |
| pageSize (Int) | page size (max 50) |
getRequest
Returns
Returns RequestType
Arguments
| Argument | Required? | Description |
|---|---|---|
| requestCode (String) | request Code | |
| contactCode (String) | contact Code |
getRequestIsNotFollower
Returns
Returns Int
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCode (String) | process Code |
getRequestRecurrence
Returns
Returns RequestRecurrenceType
Arguments
| Argument | Required? | Description |
|---|---|---|
| requestRecurrenceCode (String) | Request Recurrence Code |
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 | |
| requestDateClosedFrom (String) | Date from which requests were closed | |
| requestDateClosedTo (String) | Date to which requests were closed | |
| requestStatusNames (String) | List of Request Status Names | |
| page (Int) | page | |
| pageSize (Int) | page size (max 50) |
getRequestsFacets
Returns
Returns FacetsType
Arguments
| Argument | Required? | Description |
|---|---|---|
| preFilter (String) | Baseline filter for each Request Grid tab |
getRequestsSearch
Returns
Returns SearchPageResultType
Arguments
| Argument | Required? | Description |
|---|---|---|
| processCodes (String) | List of Process codes | |
| masterProcessCodes (String) | List of Master Process codes | |
| processStepOwnerContactPoolCodes (String) | List of Process Step Owner Contact Team codes | |
| processStepCodes (String) | List of Process Step codes | |
| stepOwnerContactCodes (String) | List of Step Owner Contact codes | |
| stepOwnerContactPoolCodes (String) | List of Step Owner Team codes | |
| stepOwnerType (String) | List of Step Owner Type | |
| processOwnerContactCodes (String) | List of Step Owner Contact codes | |
| processOwnerContactPoolCodes (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 | |
| requestDateClosedFrom (String) | Date from which requests were closed | |
| requestDateClosedTo (String) | Date to which requests were closed | |
| requestStatusNames (String) | List of Request Status Names | |
| searchTerm (String) | searchTerm | |
| sortBy (String) | Sort By | |
| sortDir (String) | Sort Direction | |
| page (Int) | page | |
| pageSize (Int) | page size (max 20) | |
| byExternalStepOwner (Boolean) | only show requests with external steps owned by stepOwnerContactCodes |
getRequestStep
Returns
Returns RequestStepType
Arguments
| Argument | Required? | Description |
|---|---|---|
| stepCode (String) | Step code |
getRequestStepForm
Returns
Returns FormType
Arguments
| Argument | Required? | Description |
|---|---|---|
| stepCode (String) | Step Code |
getSearchFacet
Returns
Returns SearchFacetType
getTeam
Returns
Returns ContactPoolType
Arguments
| Argument | Required? | Description |
|---|---|---|
| contactPoolCode (String) | contact Pool Code |
getTeams
Returns
Returns [ContactPoolType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| ownerContactCodes (String) | List of Owner Contact codes | |
| memberContactCodes (String) | List of Member Contact codes | |
| searchTerm (String) | searchTerm | |
| page (Int) | page | |
| pageSize (Int) | page size (max 20) |
getTeamsSearch
Returns
Returns SearchPageResultType
Arguments
| Argument | Required? | Description |
|---|---|---|
| ownerContactCodes (String) | List of Owner Contact codes | |
| memberContactCodes (String) | List of Member Contact codes | |
| searchTerm (String) | searchTerm | |
| sortBy (String) | Sort By | |
| sortDir (String) | Sort Direction | |
| page (Int) | page | |
| pageSize (Int) | page size (max 20) |
getTemplates
Returns
Returns [ProcessType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| templateID (Int) | template ID | |
| templateCategory (Int) | template Category |
getThirdPartyUsers
Returns
Returns [ContactType]
Arguments
| Argument | Required? | Description |
|---|---|---|
| contactPoolCode (String) | contact Pool Code | |
| includeDeactive (Int) | includeDeactive |
me
Returns
Returns ContactType