Mutations

Mar 30, 2021

addAdHocStep

Returns

Returns RequestStepType

Arguments

Argument Required? Description
stepName (String) Step Name
stepOrder (Int) Step order
assignTo (String) Assign to
stepDescription (String) Step Description
requestCode (String) Request Code

Back to Top


addContactPoolMembers

Returns

Returns String

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code
contactEmail (String) contact Email

Back to Top


addContactPoolOwners

Returns

Returns String

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code
contactEmail (String) contact Email

Back to Top


addFile

Returns

Returns RequestStepType

Arguments

Argument Required? Description
stepCode (String) Step Code
fileName (String) File Name
fileUrl (String) File Url

Back to Top


addFiles

Returns

Returns [FileType]

Arguments

Argument Required? Description
stepCode (String) Step Code
fileNames () File Names
fileUrls () File Urls
isExternal (Boolean) Is External Submission
originalContactCode (String) Original Contact Code
contactFirstName (String) Contact First Name
contactLastName (String) Contact Last Name
contactEmail (String) Contact Email

Back to Top


addFollower

Returns

Returns Boolean

Arguments

Argument Required? Description
requestCode (String) Request Code
contactEmail (String) Contact Email

Back to Top


addNote

Returns

Returns RequestStepType

Arguments

Argument Required? Description
requestCode (String) Request Code
stepCode (String) Step Code
noteContent (String) Note Content
isExternal (Boolean) Is External Submission
originalContactCode (String) Original Contact Code
contactFirstName (String) Contact First Name
contactLastName (String) Contact Last Name
contactEmail (String) Contact Email

Back to Top


addProcessField

Returns

Returns Boolean

Arguments

Argument Required? Description
processCode (String) Process Code
stepCode (String) Step Code
formID (Decimal) Form ID
dOrder (Int) DOrder
fieldType (String) Field Type
fieldTitle (String) Field Title
fieldHelp (String) Field Help
fieldSelectionOptions (String) Field Selection Options
formFieldLibraryID (Decimal) Form Field Library ID
fieldPlaceholder (String) Field Placeholder

Back to Top


addProcessFollower

Returns

Returns ProcessType

Arguments

Argument Required? Description
processCode (String) process Code
contactEmail (String) contact Email

Back to Top


addProcessStep

Returns

Returns ProcessStepType

Arguments

Argument Required? Description
processCode (String) Process Code
stepName (String) Step Name
assignTo (String) Assign To
stepDescription (String) Step Description
stepOrder (Int) Step order

Back to Top


addProjectFollower

Returns

Returns ProjectType

Arguments

Argument Required? Description
projectCode (String) Project Code
contactEmail (String) Contact Email
contactPoolCode (String) Contact Pool Code

Back to Top


addProjectRequest

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCode (String) Project Code
requestCode (String) Request Code

Back to Top


addProjectRequests

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCodes ([String]) Project Codes
requestCodes ([String]) Request Codes

Back to Top


addRule

Returns

Returns String

Arguments

Argument Required? Description
processCode (String) Process Code
fieldCode (String) Field Code
ruleEvaluatorID (Int) Rule Evaluator ID
ruleTestValue (String) Rule Test Value
primaryTargetItem (Int) Primary Target Item
primaryTargetItemText (String) Primary Target Item Text
ruleActionTypeID (Int) Rule Action Type ID
secondaryTargetItem (Int) Secondary Target Item
secondaryTargetItemText (String) Secondary Target Item Text
secondaryTargetItemDOrder (Int) Secondary Target Item DOrder
secondaryTargetItemContactEmail (String) Secondary Target Item Contact Email

Back to Top


addSystemActivity

Returns

Returns NoteType

Arguments

Argument Required? Description
requestCode (String) Requect code
activityFeedTypeId (Int) Activity Feed Type ID
allowDuplicates (Int) Allow duplicates

Back to Top


cancelProject

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCode (String) Project Code

Back to Top


cancelRequest

Returns

Returns RequestType

Arguments

Argument Required? Description
requestCode (String) Request Code
noteContent (String) Reason for canceling the request

Back to Top


closeRequest

Returns

Returns RequestType

Arguments

Argument Required? Description
requestCode (String) Request Code
noteContent (String) Reason for closing the request

Back to Top


completeStep

Returns

Returns RequestStepType

Arguments

Argument Required? Description
requestCode (String) Request Code
stepCode (String) Step Code
contactCode (String) contact Code
noteContent (String) Note Content

Back to Top


createContact

Returns

Returns ContactType

Arguments

Argument Required? Description
contactEmail (String) Contact Email
contactFirstName (String) Contact First Name
contactLastName (String) Contact Last Name
isSkipInvite (Int) Is Skip Invite?
customerCode (String) Customer Code

Back to Top


createProcess

Returns

Returns ProcessType

Arguments

Argument Required? Description
processName (String) Process Name
processAbstract (String) Process Abstract
stepsCount (String) Step Count
groupId (String) process group ID
groupLabelId (String) process group label ID
flowAssigneeOwnershipValue (String) Owner of the flow

Back to Top


createProject

Returns

Returns ProjectType

Arguments

Argument Required? Description
projectName (String) Project Name
projectDescription (String) Project Description
contactEmail (String) Contact Email
contactPoolCode (String) Contact Pool Code

Back to Top


createRequest

Returns

Returns RequestType

Arguments

Argument Required? Description
processCode (String) Process Code
contactEmail (String) Contact Email
requestName (String) Request Name
requestComment (String) Request Comment
requestFields ([InputFieldType]) Request Fields

Back to Top


createRequestRecurrence

Returns

Returns RequestRecurrenceType

Arguments

Argument Required? Description
requestCode (String) Request Code
recurrenceTitle (String) Recurrence Title
recurrenceStartDate (DateTime) Recurrence Start Date
recurrenceFrequency (Int) Recurrence Frequency
recurrenceEndDate (DateTime) Recurrence End Date
recurrenceDuration (Int) Recurrence Frequency

Back to Top


createTeam

Returns

Returns ContactPoolType

Arguments

Argument Required? Description
contactCode (String) Contact Code
contactPoolName (String) Contact Pool Name
description (String) Description

Back to Top


createWorkflowVersion

Returns

Returns String

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


deactivateProject

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCode (String) Project Code

Back to Top


deactivateWorkflow

Returns

Returns ProcessType

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


deleteAdHocStep

Returns

Returns Boolean

Arguments

Argument Required? Description
selectedStepID (Decimal) Selected Step ID

Back to Top


deleteContactPoolMembers

Returns

Returns String

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code
contactCode (String) contact Code

Back to Top


deleteContactPoolOwners

Returns

Returns String

Arguments

Argument Required? Description
contactPoolCode (String) contact Pool Code
contactCode (String) contact Code

Back to Top


deleteFile

Returns

Returns Boolean

Arguments

Argument Required? Description
requestCode (String) Request Code
attachmentCode (String) Attachment Code
isExternal (Boolean) Is External Submission
originalContactCode (String) Original Contact Code
contactFirstName (String) Contact First Name
contactLastName (String) Contact Last Name
contactEmail (String) Contact Email

Back to Top


deleteFollower

Returns

Returns RequestType

Arguments

Argument Required? Description
requestCode (String) Request Code
contactCode (String) Contact Code

Back to Top


deleteNote

Returns

Returns Boolean

Arguments

Argument Required? Description
noteID (Decimal) noteID
contactID (Decimal) contactID
isExternal (Boolean) Is External Submission
originalContactCode (String) Original Contact Code
contactFirstName (String) Contact First Name
contactLastName (String) Contact Last Name
contactEmail (String) Contact Email

Back to Top


deleteProcess

Returns

Returns Boolean

Arguments

Argument Required? Description
processCode (String) Process Code

Back to Top


deleteProcessStep

Returns

Returns Boolean

Arguments

Argument Required? Description
stepCode (String) Step Code

Back to Top


deleteProcessStepForm

Returns

Returns Boolean

Arguments

Argument Required? Description
stepCode (String) Step Code

Back to Top


deleteProject

Returns

Returns Boolean

Arguments

Argument Required? Description
projectCode (String) Project Code

Back to Top


deleteRequest