Types

Mar 26, 2021

ActivityFeedEntryType

 

Fields

Field Description
activityType (String) Activity Type
attachment (FileType)  
contactDoingAction (ContactType)  
contactPoolDoingAction (ContactPoolType)  
contactPoolReceivingAction (ContactPoolType)  
contactReceivingAction (ContactType)  
fromRule (Boolean) Note from Rule Execution?
note (NoteType)  
noteAttachmentId (Int) Note Attachment ID
noteDoingActionContactId (Int) Note Doing Action Contact ID
noteDoingActionContactPoolId (Decimal) Note Doing Action Contact Pool ID
noteId (Int) Note ID
noteReceivingActionContactId (Int) Note Receiving Action Contact ID
noteReceivingActionContactPoolId (Int) Note Receiving Action Contact Pool ID
otherProcessStep (ProcessStepType)  
otherRequestStep (RequestStepType)  
otherStep (RequestStepType)  
otherStepId (Int) Other Step ID
processStep (ProcessStepType)  
requestDeliverable (RequestDeliverableType)  
requestStep (RequestStepType)  
step (RequestStepType)  
stepId (Int) Step ID

Fragment

The recommended fragment to use is:

fragment ActivityFeedItemFragment on ActivityFeedEntryType {
    requestDeliverable {
        requestDeliverableFieldTitle
        __typename
    }
    contactDoingAction {
        ...ContactFragment
    }
    contactPoolDoingAction 
        ...TeamFragment
    }
    contactReceivingAction {
        ...ContactFragment
    }
    contactPoolReceivingAction {
        ...TeamFragment
    }
    attachment {
        attachmentCode
        attachmentName
        attachmentUrl
        attachmentIcon
        __typename
    }
    note {
        __typename
        activityFeedRecordTypeEnum
        noteContent
        noteCreateDateStamp
    }
    step {
        stepCode
        stepName
        stepOrder
        __typename
    }
    otherStep {
        stepCode
        stepName
        stepOrder
        __typename
    }
    fromRule
    __typename
}
${contactFragment}
${teamFragment}

Back to Top

 

AnalyticsType

 

Fields

Field Description
canceledCount (Int) Canceled Count
canceledEta (Int) Canceled ETA
closedCount (Int) Closed Count
closedEta (Int) Closed ETA
completedCount (Int) Completed Count
completedEta (Int) Completed ETA
openCount (Int) Open Count
ownerCount (Int) Owner Count
totalCount (Int) Closed ETA

Fragment

The recommended fragment to use is:

fragment AnalyticsFragment on AnalyticsType {
    __typename
    canceledCount
    canceledEta
    closedCount
    closedEta
    completedCount
    completedEta
    openCount
    ownerCount
    totalCount
}

Back to Top

 

ContactEmailSettingType

 

Fields

Field Description
name (String) Name of Email Setting setting
title (String) Title of Email Setting setting
tooltip (String) Tooltip of Email Setting setting
value (Boolean) Value of Email Setting setting

Back to Top

 

ContactPoolType

 

Fields

Field Description
bundleCount (Int) Count of bundles
canDelete (Int) Can delete the team?
contactPoolCode (String) Code of the team
contactPoolCreateDateStamp (Int) Team create date
contactPoolDescription (String) Description of the team
contactPoolId (Int) Id of the team
contactPoolName (String) Name of the team
contactPoolProfileImageUrl (String) Profile Image Url of the team
deleteToolTipText (String) Delete tooltip text rendered explaining why team cannot be deleted
isAdmin (Int) Whether the team is the account administrator
isMember (Int) Whether the viewer is a member of the team
isOwner (Int) Whether the viewer is an owner of the team
isPrivate (Int) Whether the team is private
isTrash (Boolean) Is team deactivated/deleted
memberCount (Int) Count of team members
memberNames (String) Names of team members
members ([ContactType])  
openRequestsUsageCount (Int) Count of how many open requests the team owns at least one request step
ownerCount (Int) Count of team owners
ownerNames (String) Names of team owners
owners ([ContactType])  
processes ([ProcessType])  
processStepOnlyUsageCount (Int) Count of how many instances where the team ONLY owns process steps
processStepUsageCount (Int) Count of how many process steps the team owns
processUsageCount (Int) Count of how many processes the team owns
projects ([ProjectType])  
requestCanceledCount (Int) Count of canceled requests
requestCompletedCount (Int) Count of completed requests
requestOpenCount (Int) Count of open requests
requestToDoCount (Int) Count of to-do requests
requestTotalCount (Int) Count of total requests
requestUnassignedCount (Int) Count of unassigned requests
viewerName (String) Name of the viewer

Fragment

The recommended fragment to use is:

fragment ContactPoolFragment on ContactPoolType {
    __typename
    contactPoolName
    contactPoolCode
    contactPoolDescription
    contactPoolProfileImageUrl
    ownerCount
    memberCount
    contactPoolCreateDateStamp
    isMember
    isOwner
    isAdmin
    memberNames
    ownerNames
}

Back to Top

 

ContactType

 

Fields

Field Description
contactCode (String) contact code
contactCorpId (String) contact corp ID
contactCreateDateStamp (Int) contact create date
contactDepartment (String) contact department
contactEmail (String) contact email
contactFirstName (String) contact first name
contactId (Int) contact ID
contactInviteDateStamp (Int) contact invite date
contactLastName (String) contact last name
contactMobilePhone (String) contact mobile phone
contactName (String) contact name
contactPhone (String) contact phone
contactProfileImageUrl (String) contact profile image Url
contactTitle (String) contact job title
emailSettings ([ContactEmailSettingType])  
externalValidDateStamp (Int) externalValidDate
getActionRequiredEmails (Boolean) Get Action Required Emails
getBundleOwnerChangedEmails (Boolean) Get Bundle Owner Changed Emails
getNoteAddedEmails (Boolean) Get Note Added Emails
getRequestCanceledEmails (Boolean) Get Request Canceled Emails
getRequestUpdatedEmails (Boolean) Get Request Updated Emails
getWorkflowOwnerChangedEmails (Boolean) Get WorkflowOwner Changed Emails
isAccountAdmin (Boolean) isAccountAdmin
isArchive (Boolean) isArchive
isExternal (Boolean) isExternal
isNew (Boolean) isNew
isSponsorshipValid (Int) isSponsorshipValid
isTrash (Boolean) is contact archived
sponsorContactId (Decimal) sponsorContactId
sponsorContactName (String) sponsorContactName
sponsorContactPoolId (Decimal) sponsorContactPoolId

Fragment

The recommended fragment to use is:

fragment ContactFragment on ContactType {
    __typename
    contactFirstName
    contactLastName
    contactEmail
    contactTitle
    contactDepartment
    contactPhone
    contactMobilePhone
    contactCode
    contactProfileImageUrl
    isTrash            
}

Back to Top

 

DropdownOptionType

 

Fields

Field Description
optionName (String) Option Name
optionValue (String) Option Value

Back to Top

 

FacetsType

 

Fields

Field Description
currentStepOwnerContactPools ()  
currentStepOwnerContacts ()  
currentSteps ()  
processCodes () Facet process codes
processCurrentStepOwnerContactPools ()  
processCurrentSteps ()  
processes ()  
processesNew ([ProcessType])  
processOwnerContactPools ()  
processOwnerContacts ()  
processStepOwnerContactPools ()  
requesters ()  
requestStatuses ()  

Back to Top

 

FieldType

 

Fields

Field Description
childFields ([FieldType])  
columnOptionName (String) Column Option Name
columnOptionValue (String) Column Option Value
dbTable (String) DB Table
dbTableCondition (String) DB Table Condition
dependencies ([FieldDependencyType])  
dependentFieldCheck (String) Dependent Field Check
dependentFieldId (Int) Dependent Field Id
dependentFieldTitle (String) Dependent Field Title
dependentFieldValue (String) Dependent Field Value
dOrder (Int) dOrder
dropdownId (Int) DropDown ID
editableFieldValue (String) Editable Field Value
fieldAttributes (String) Field Attributes
fieldCode (String) Field Code
fieldDefaultValue (String) Field Default Value
fieldHelp (String) Field Help
fieldId (Int) Field ID
fieldName (String) Field Name
fieldPlaceholderValue (String) Field Placeholder Value
fieldTitle (String) Field Title
fieldType (String) Field Type
fieldValue (String) Field Value
formFieldLibraryItemId (Decimal) Form Field Library ID
formId (Int) Form ID
hasDefaultValue (Int) Has Default Value?
hasDependencies (Int) Has Dependencies?
hasValidation (Int) Has Validation?
isChildField (Int) Is the Field a Child Field?
isHideable (Int) Is Hideable?
isProcessRequiredField (Boolean) Is Process Field Required?
isRequired (Int) Is Required?
isSystemField (Int) Is System Field?
metDependency (Boolean) Met Dependency?
options ([DropdownOptionType])  
parentFieldId (Decimal) Parent Field ID
requestDeliverableValue (String) Request Deliverable Value
requestId (Int) Request ID
validations ([FieldValidationType])  
validDependencyExists (Int) Valid Dependency Exists?

Fragment

fragment FieldFragment on FieldType {
    fieldCode
    editableFieldValue
    fieldTitle
    fieldType
    fieldValue
    fieldName
    metDependency
    childFields{
        fieldCode
        editableFieldValue
        fieldTitle
        fieldType
        fieldValue
        fieldName
        metDependency
    }
}

Back to Top

 

FileType

 

Fields

Field Description
attachmentCode (String) Attachment code
attachmentExtension (String) Attachment extension
attachmentIcon (String) Attachment icon CSS class
attachmentId (Int) Attachment ID
attachmentName (String) Attachment name
attachmentThumbUrl (String) Attachment Thumb Url
attachmentUploadDateStamp (Int) Attachment upload date
attachmentUrl (String) Attachment Url
canDelete (Boolean) Can Delete Attachment
contact (ContactType)  
isActionable (Boolean) Contact can take action on Attachment
requestCode (String) Request code
requestId (Int) Request ID
step (RequestStepType)  
stepCode (String) Step code
stepId (Int) Step ID
stepName (String) Step name
stepOrder (Int) Step order
uploaderContactCode (String) Uploader contact code
uploaderContactEmail (String) Uploader contact email
uploaderContactFirstName (String) Uploader contact first name
uploaderContactId (Int) Uploader contact ID
uploaderContactLastName (String) Uploader contact last name
uploaderContactName (String) Uploader contact name
uploaderProfileImageUrl (String) Uploader Profile Image URL

Fragment

The recommended fragment to use is:

fragment FileFragment on FileType {
    attachmentCode
    requestCode
    attachmentExtension
    attachmentName
    attachmentIcon
    attachmentThumbUrl        
    attachmentUrl
    attachmentUploadDateStamp
    canDelete
    isActionable
    contact {
        ...ContactFragment
    }
    step {
        isFilesRequired
        stepCode
        stepOrder
        stepStatusId
        stepName
        stepStatusName
        __typename
    }
    uploaderContactCode
    uploaderProfileImageUrl
    uploaderContactEmail
    uploaderContactName
    __typename
}
${contactFragment}

Back to Top

 

FormType

 

Fields

Field Description
countryId (Int) Country ID
errorLayout (String) Error layout
errorLayoutAfter (String) Error layout after
errorLayoutBefore (String) Error layout before
fieldHelpIcon (String) Field help icon
fields ([FieldType])  
formCategoryId (Int) Form category ID
formCode (String) Form Code
formCreateDateStamp (Int) Form create date
formCreator (String) Form creator
formExtendedHelp (String) Form extended help
formId (Int) Form ID
formName (String) Form name
formTemplateId (Int) Form Template ID
formTitle (String) Form title
formUpdateDateStamp (Int) Form updat date
formUpdater (String) Form updater
genesisAppId (Int) Genesis app Id
genesisMenuId (Int) Genesis menu Id
isArchive (Int) Whether the form is archived
isDeployDiff (Int) Whether there is a deployment difference
isSet (Int) Is set toggle
isTrash (Int) Whether the form is deleted
languageId (Int) Languate ID
pipelineProcessId (Int) Pipeline process Id
pipelineStepId (Int) Pipeline step Id
regionId (Int) Region ID
requestId (Int) Request ID

Fragment

The recommended fragment to use is:

fragment FormFragment on FormType {
    __typename
    formId
    fields {
        ...FieldFragment
    }
}
${fieldFragment}

Back to Top

 

NoteType

 

Fields

Field Description
activityFeedRecordTypeEnum (ActivityFeedRecordTypeEnum)  
canDelete (Int) canDelete
contact (ContactType)  
isSystem (Int) Is system
noteContactCode (String) Note contact code
noteContactEmail (String) Note contact email
noteContactFirstName (String) Note contact first name
noteContactId (Int) Note contact ID
noteContactLastName (String) Note contact last name
noteContactName (String) Note contact name
noteContent (String) Note content
noteCreateDateStamp (Int) Note create date
noteId (Int) Note ID
processStep (ProcessStepType)  
requestCode (String) Request code
requestId (Int) Request ID
requestStep (RequestStepType)  
step (RequestStepType)  
stepCode (String) Step code
stepId (Int) Step ID
stepName (String) Step name
stepOrder (Int) Step order

Fragment

The recommended fragment to use is:

fragment NoteFragment on NoteType {
    noteContent
    stepOrder
    requestCode
    isSystem
    canDelete
    activityFeedRecordTypeEnum
    noteCreateDateStamp
    contact {
        ...ContactFragment
    }
    step {
        stepCode
        stepOrder
        stepName
        __typename
    }
    __typename
}
${contactFragment}

Back to Top

 

OwnerType

 

Fields

Field Description
bundleCount (Int) Count of bundles
contactCode (String) contact code
contactCorpId (String) contact corp ID
contactCreateDateStamp (Int) contact create date
contactDepartment (String) contact department
contactEmail (String) contact email
contactFirstName (String) contact first name
contactId (Int) contact ID
contactIsMe (Boolean) Contact of record matches the contact accessing this data
contactLastName (String) contact last name
contactMobilePhone (String) contact mobile phone
contactName (String) contact name
contactPhone (String) contact phone
contactPoolCode (String) Code of the team
contactPoolCreateDateStamp (Int) Team create date
contactPoolDescription (String) Description of the team
contactPoolId (Int) Id of the team
contactPoolName (String) Name of the team
contactPoolProfileImageUrl (String) contact pool profile image Url
contactProfileImageUrl (String) contact profile image Url
contactTitle (String) contact job title
getActionRequiredEmails (Boolean) Get Action Required Emails
getBundleOwnerChangedEmails (Boolean) Get Bundle Owner Changed Emails
getNoteAddedEmails (Boolean) Get Note Added Emails
getRequestCanceledEmails (Boolean) Get Request Canceled Emails
getRequestUpdatedEmails (Boolean) Get Request Updated Emails
getWorkflowOwnerChangedEmails (Boolean) Get WorkflowOwner Changed Emails
isMember (Int) Whether the viewer is a member of the team
isOwner (Int) Whether the viewer is an owner of the team
isTrash (Boolean) whether contact is archived
memberCount (Int) Count of team members
memberNames (String) Names of team members
members ([ContactType])  
openRequestsUsageCount (Int) Count of how many open requests the team owns at least one request step
ownerCount (Int) Count of team owners
ownerNames (String) Names of team owners
owners ([ContactType])  
processStepUsageCount (Int) Count of how many process steps the team owns
processUsageCount (Int) Count of how many processes the team owns
requestCanceledCount (Int) Count of canceled requests
requestCompletedCount (Int) Count of completed requests
requestOpenCount (Int) Count of open requests
requestTotalCount (Int) Count of total requests
requestUnassignedCount (Int) Count of unassigned requests
type (String) owner type
viewerName (String) Name of the viewer

Fragment

The recommended fragment to use is:

fragment OwnerFragment on OwnerType {
    __typename
    contactFirstName
    contactLastName
    contactEmail
    contactCode
    type
    contactProfileImageUrl
    contactPoolProfileImageUrl
    contactPoolName
    contactPoolCode
    contactIsMe
    isMember
    isOwner
    isTrash
    contactIsMe
    members {
        ...ContactFragment
    }
}
${contactFragment}

Back to Top

 

ProcessLabelType

 

Fields

Field Description
processLabelAbstract (String) Process Label Abstract
processLabelAbstractCSS (String) Process Label Abstract CSS
processLabelCode (String) Process Label Code
processLabelDescription (String) Process Label Description
processLabelName (String) Process Label Name

Back to Top

 

ProcessStepType

 

Fields

Field Description
allowableUploadExtentions (String) List of allowable upload extensions
analytics (AnalyticsType)  
completeFormDesignId (Int) form Id
dueDateDependentStepCode (String) Step Due Date Dependent Step Code
dueDateDependentStepId (Decimal) Step Due Date Dependent Step Id
dueDateDependentStepName (String) Step Due Date Dependent Step Name
dueDateDependentStepOptions ([DropdownOptionType])  
dueDateDependentStepOrder (Int) Step Due Date Dependent Step Order
dueDateStamp (Int) Step Due Date
dueDateTimeToComplete (Int) Step Due Date Time to Complete
durationDays (Int) Number of days left in the duration
form (FormType)  
formId (Int) form Id
integrationId (Int) Process step integration Id
isArchive (Int) Whether the step is archived
isConfidential (Int) Whether the step is confidential
isExternal (Int) Whether the step can be completed externally
isFilesRequired (Int) isFilesRequired
isHiddenDescription (Boolean) Whether the step hides description
isHideDueDates (Boolean) Whether the step hides due dates
isIncludeNonBusinessDays (Int) Whether the step includes non-business days in duration calculation
isMilestone (Int) Whether the step is a milestone
isPreventWorkAhead (Int) Whether the step prevents work ahead
isPrivate (Int) Whether the process step is private
isRejectCancelRequest (Int) Whether the step cancels the request if it's rejected
isRequesterStepOwner (Boolean) Whether the step is owned by the requester
isRequireUpload (Int) Whether the step requires uploads
isShowCosts (Int) Whether the step shows costs
isShowHours (Int) Whether the step shows hours
isSkippable (Int) Whether the step is skippable
isTrash (Int) Whether the step is deleted
milestoneName (String) Milestone name
processCode (String) Process code used for identity
processId (Int) Process Id
ruleTotalCount (Int) Rules Count
stepArchiveDateStamp (Int) Process step archive date
stepCode (String) Step code used for identity
stepCompleteName (String) Name of complete step
stepDescription (String) Step description
stepEmailBCC (String) Process step email bcc
stepEmailCC (String) Process step email cc
stepEmailFrom (String) Process step email from
stepEmailId (Int) Process step email Id
stepEmailTo (String) Process step email to
stepHTTPHeader (String) Process step http header
stepId (Int) Id of Step
stepName (String) Name of Step
stepNotes (String) Notes attached to step
stepOrder (Int) Order of the steps
stepOwner (OwnerType)  
stepOwnerContactId (Int) Step owner contact
stepOwnerTeamId (Int) Step owner team
stepParameterTemplate (String) Process step parameter template
stepRejectName (String) Name of reject step
stepTrashDateStamp (Int) Process step trash date
stepTypeId (Int) Id of the type of step
stepUpdateDateStamp (Int) Process step update date
stepUpdater (String) Process step updater
stepWebHTTPAction (String) Process step web http action
stepWebUrl (String) Process step web Url

Fragment

The recommended fragment to use is:

fragment ProcessStepFragment on ProcessStepType {
    stepName
    stepDescription
    stepNotes
    stepCode
    stepId
    stepTypeId
    stepOrder
    isExternal
    durationDays
    isRequesterStepOwner
    isHiddenDescription
    processCode
    isFilesRequired
    isSkippable
    isConfidential
    completeFormDesignId
    stepCompleteOverrideName
    stepRejectOverrideName
    stepCompleteName
    stepRejectName
    isHideDueDates
    dueDateStamp
    dueDateString
    dueDateTimeToComplete
    dueDateDependentStepName
    dueDateDependentStepCode
    dueDateDependentStepOrder
    dueDateDependentStepOptions {
        optionName
        optionValue
    }
    stepOwner {
        ...OwnerFragment
    }
    __typename
}
${ownerFragment}

Back to Top

 

ProcessType

 

Fields

Field Description
allowableUploadExtensions (Boolean) Whether the process allows upload extensions
allProcessVersions ([ProcessType])  
allVersionsRequestCanceledCount (Int) Count of canceled requests across all versions
allVersionsRequestCompletedCount (Int) Count of completed requests across all versions
allVersionsRequestOpenCount (Int) Count of open requests across all versions
allVersionsRequestTotalCount (Int) Count of total requests across all versions
analytics (AnalyticsType)  
averageElapsedDays (Decimal) Average elapsed days
averageStepOwners (Decimal) Average step owners
averageStepsPerRequest (Decimal) Average steps per request
cancelFormId (Int) Cancel form id
canToggleLive (Int) Whether the process can toggle live or not
completeFormId (Int) Complete form id
customCSS (String) Custom CSS
defaultFollowers ([ContactType])  
groupId (Int) Group id
groupLabelId (Int) Group label id
hasAnyLabels (Int) Whether the process has any labels and thus whether set as public can be toggled
hiddenFieldIDs (String) List of field IDs hidden on request form
hiddenFieldNames (String) List of field names hidden on request form
isAddStepEnabled (Int) Whether the process has add ad-hoc step enabled
isArchive (Int) Whether the process is archived
isAssignByRole (Boolean) Whether the process is assigned by role
isDraft (Int) Whether the process is in draft status
isEditable (Int) Whether the process can be edited
isExternal (Int) Whether the process can be external-facing
isHideDetailsField (Int) Whether the process hides the details field
isHideDueDates (Int) Whether the process hides due dates
isHideFilesField (Int) Whether the process hides the files field
isHideRequestNameField (Int) Whether the hides the request name field
isIWSourceTemplate (Boolean) Is an IW Source Template
isLive (Int) Whether the process is live or not
isNew (Int) Whether the process is new
isOnlyShowContactPool (Boolean) Whether the process is only show contact pool
isOwner (Int) Whether the contact pool id or contact id owns the workflow
isParentProcess (Int) Whether the process is the parent process or not
isPreventAutoAddRequesterAsFollower (Int) Whether the process prevents the auto-add of requester as a follower
isPreventRequests (Int) Whether the process prevents new requests
isPreventWorkAhead (Int) Whether the process prevents completing steps before the current step is complete
isPrivate (Int) Whether the process is private
isProhibitUpload (Int) Whether the process prevents file uploads
isPublic (Boolean) Whether the process is public
isPublicTemplate (Boolean) Whether the process is a public template
isRequireRequesterUpload (Int) Whether the process requires the requester to upload file(s) in order to create a request
isTeamOwned (Int) Whether the owner is a team
isTemplate (Boolean) Whether the process is a template
isTrash (Int) Whether the process is deleted
labels ([ProcessLabelType])  
mailThisLink (String) link for mail this option in dropdown
masterParentCode (String) masterParentCode
originatingIWTemplateID (String) Template source master parent code
ownerName (String) Name of owner
ownerUserId (Int) Id of owner user
parentProcessId (Int) Abstract of the process
parentTemplateProcessId (Int) Parent template Process ID
processAbstract (String) Abstract of the process
processArchiveDateStamp (Int) Process archive date
processCode (String) Code of the team
processCreateDateStamp (Int) Process create date
processCreator (String) Name of the process creator
processDescription (String) Description of the process
processId (Int) Id of the process
processName (String) Name of the process
processOwnerContactId (Int) Process owner contact ID
processOwnerTeamId (Int) Process owner team ID
processTrashDateStamp (Int) Process trash date
processUpdateDateStamp (Int) Process update date
processUpdater (String) Process updater
repeatRequesterContactId (Int) Repeat requester contact id
repeatRequestName (String) Repeat request name
repeatStartDateStamp (Int) Repeat start date
repeatTypeId (Int) Repeat type id
requestCanceledCount (Int) Count of canceled requests
requestCompletedCount (Int) Count of completed requests
requestForm (FormType)  
requestFormId (Int) Request form id
requestOpenCount (Int) Count of open requests
requestsSubmittedByContactCount (Int) Count of requests submitted by contact for this process
requestTotalCount (Int) Count of total requests
requestUnassignedCount (Int) Count of unassigned requests
rules ([RuleType])  
searchProcessName (String) the name of the process that appears in search
steps ([ProcessStepType])  
templateCategory (Decimal) Template Category
templateCoverUrl (String) Template cover Url
templateDescription (String) Template Description
templateLogoUrl (String) Template logo Url
templateOwnerEmail (String) Template owner email
templateOwnerName (String) Template owner name
templatePrice (Decimal) Template Price
templateSourceMasterParentCode (String) Template source master parent code
toggleLiveToolTipText (String) The tooltip text for toggle live
totalStepCount (Int) Number of total steps
useDueDates (Boolean) useDueDates
versionCount (Decimal) Number of versions for this Workflow
versionId (Int) the version id of the workflow
workflowOwner (OwnerType)  

Fragment

The recommended fragment to use is:

fragment WorkflowFragment on ProcessType {
    __typename
    processId
    processCode
    processName
    processDescription
    processAbstract
    processCreateDateStamp
    useDueDates
    isEditable
    isArchive
    requestFormId
    isExternal
    isAddStepEnabled
    requestTotalCount
    externalURL        
    hiddenFieldIDs
}

Back to Top

 

ProjectType

 

Fields

Field Description
followers ([OwnerType])  
hoursBudgetedPerDay (String) Hours budgeted per day per member
isActive (Int) Whether the project is active
isArchive (Int) Whether the project is archived
isCanceled (Int) Whether the project is canceled
isComplete (Boolean) Whether the project is completed
isFollower (Boolean) Is contact viewing project record a follower?
isTeamOwner (Boolean) is Team Owner
ownerName (String) Name of owner
projectCanceledRequestCount (Int) Canceled requests associated with the project
projectCode (String) Code of the project
projectCompletedRequestCount (Int) Completed requests associated with the project
projectCreateDateStamp (Int) Project create date
projectDays (Int) Project days
projectDescription (String) Description of the project
projectEndDateStamp (Decimal) Project start date
projectId (Int) Id of the project
projectIsActive (Int) Is project active?
projectName (String) Name of the project
projectObjective (String) Project objective
projectOpenRequestCount (Int) Open requests associated with the project
projectOwner (OwnerType)  
projectOwnerContactId (Int) Project owner contact ID
projectOwnerTeamId (Int) Project owner team ID
projectProgress (String) Progress of project
projectStartDateStamp (Int) Project start date
projectStatusName (String) Project Status Name
projectTotalRequestCount (Int) Total requests associated with the project
requests ([RequestType])  

Fragment

The recommended fragment to use is:

fragment ProjectFragment on ProjectType {
    __typename
    projectName,
    projectCode,
    projectDescription,
    projectCreateDateStamp
    projectStartDateStamp
    projectEndDateStamp
    projectCompletedRequestCount
    projectTotalRequestCount
    projectProgress
    isOwner
    isTeamOwner
    isTeamOwned
    ownerName
    isArchive
    isCanceled
    isComplete
    projectStatusName
}

Back to Top

 

RequestRecurrenceType

 

Fields

Field Description
isArchive (Int) Is Archive?
isComplete (Int) Is Recurrence Completed?
isTrash (Int) Is Trash?
recurrenceDuration (Int) Recurrence duration
recurrenceDurationText (String) Recurrence duration text
recurrenceEndDateStamp (Int) Recurrence end date
recurrenceFrequencyText (String) Recurrence frequency text
recurrenceId (Int) Recurrence ID
recurrenceStartDateStamp (Int) Recurrence start date
recurrenceTitle (String) Recurrence Title
requestId (Decimal) Request ID
requestRecurrenceCode (String) Request Recurrence Code

Fragment

The recommended fragment to use is:

fragment RequestRecurrenceFragment on RequestRecurrenceType {
    isArchive
    isComplete
    isTrash
    recurrenceDuration
    recurrenceDurationText
    recurrenceEndDateStamp
    recurrenceFrequencyText
    recurrenceStartDateStamp
    recurrenceTitle
    requestRecurrenceCode
}

Back to Top

 

RequestStepType

 

Fields

Field Description
attachments ([FileType])  
canReassignStep (Boolean) Can Reassign Step
canRenderDisabledEditAndDeleteAdhocButtons (Boolean) canRenderDisabledEditAndDeleteAdhocButtons
canRenderEditAndDeleteAdhocButtons (Boolean) canRenderEditAndDeleteAdhocButtons
canSendReminder (Boolean) Can Send a Reminder
costsAcutal (Decimal) Cost Actual
costsBudgeted (Decimal) Cost Budgeted
dueDateDependentStepId (Int) Due date dependent step ID
dueDateStamp (Int) Due date
dueDateTimeToComplete (Int) Due date time to complete
filesCount (Int) # of upload files for step
form (FormType)  
formId (Int) Form ID
hoursBillable (Decimal) Hours Billable
hoursBudgeted (Decimal) Hours Budgeted
isAdHocStep (Boolean) Is ad-hoc step
isAdHocStepCreator (Boolean) Is ad hoc step creator?
isAdHocStepOwner (Boolean) Is ad hoc step owner?
isConfidential (Int) Whether the step is confidential
isContactExternalStepOwner (Boolean) Is current user an external step owner
isContactStepOwner (Boolean) Is current user a step owner
isCurrentStep (Boolean) Is the step the current step in the Ask
isExternal (Int) Whether the step can be completed externally
isFilesRequired (Int) isFilesRequired
isHiddenDescription (Int) Whether the instructions / description should be hidden
isOpen (Boolean) Is the step Open
isPastDue (Boolean) Is past due?
isRequireUpload (Boolean) Is require upload to complete step
isSkippable (Int) Whether the step is skippable
notes ([NoteType])  
previousStepCode (String) Previous Step code
processStep (ProcessStepType)  
processStepId (Int) Process Step ID
processStepOwnerContactId (Int) Step contact ID
processStepOwnerContactPoolId (Int) Step owner contact pool ID
requestCode (String) Request code
requestId (Int) Request ID
showAssignTo (Boolean) Can Show Assign To
showCompleteButton (Boolean) Can Show Complete Buttons
showCostsButton (Int) Show Costs Button
showHoursButton (Int) Show Hours Button?
showInstructions (Boolean) Can Show Step Instructions
showStepFormEdit (Boolean) Can Show Step Form in Edit Mode
stepCode (String) Step code
stepCompleteDateStamp (Decimal) Step complete date
stepCompleteName (String) Step complete name
stepCreateDateStamp (Decimal) Step create date
stepDescription (String) Step description
stepDueDateStamp (Decimal) Step due date
stepId (Int) Step ID
stepName (String) Step name
stepNote (String) Step note
stepOrder (Int) Step order
stepOwner (OwnerType)  
stepOwnerContactId (Int) Step contact ID
stepOwnerContactPoolId (Int) Step owner contact pool ID
stepOwnerIsRequester (Boolean) Step Owner is Requester
stepOwnerTeamId (Int) Step owner team ID
stepProcessOwner (OwnerType)  
stepRejectName (String) Step reject name
stepStartDateStamp (Decimal) Step start date
stepStatusId (Int) Step status ID
stepStatusName (String) Step status
stepTypeId (Int) Step type ID
stepUpdateDateStamp (Decimal) Step update date
uploadAllowableExtensions (String) Allowable file extensions
useDueDates (Boolean) Request uses Due Dates
writeToActivityFeed (Boolean) Write to Actiivty feed

Fragment

The recommended fragment to use for an overview is:

fragment RequestStepFragment on RequestStepType {
    __typename
    stepCode
    stepName
    stepStatusName
    dueDateTimeToComplete
    dueDateStamp
    useDueDates
    isPastDue
    stepOrder
    isAdHocStep
    isExternal
    isSkippable
    isConfidential
    canViewStep
    stepCreateDateStamp
    stepStartDateStamp
    requestCode
    canReassignStep
    canSendReminder
    stepOwner {
        ...OwnerFragment
    }
}
${ownerFragment}

The recommended fragment to use for details, i.e. when the step is expanded:

fragment RequestStepDetailsFragment on RequestStepType {
    ...RequestStepFragment
    canRenderEditAndDeleteAdhocButtons
    canRenderDisabledEditAndDeleteAdhocButtons
    canSendReminder
    stepOwnerIsRequester
    showCompleteButton
    stepDescription
    showAssignTo
    stepRejectName
    showInstructions
    stepCompleteName
    stepCompleteDateStamp
    showStepFormEdit
    isFilesRequired
    filesCount
    previousStepCode
    writeToActivityFeed
    isCurrentStep
    isContactStepOwner
    isContactExternalStepOwner
    isOpen
    form {
        ...FormFragment
    }
    attachments {
        ...FileFragment
    }
    notes {
        ...NoteFragment
    }
}
${requestStepFragment}
${formFragment}
${fileFragment}
${noteFragment}

Back to Top

 

RequestType

 

Fields

Field Description
activityFeedEntries ([ActivityFeedEntryType])  
attachments ([FileType])  
canContactAddAdhocStep (Int) Can contact add/edit/delete an adhoc step
canSeeReccurences (Boolean) Can the user access reccurences
completedNonAdhocStepCount (Int) Number of non-adhoc steps that were completed
completedStepCount (Int) Number of steps that were completed
contactEmail (String) Email of the contact
currentDueDateStamp (Int) Current due date
currentProcessStepOwnerTeamName (String) Current Process Step Owner Team Name
currentStep (Decimal) Current Step
currentStepAssignmentDate (String) Current Steps start date
currentStepAssignmentDateStamp (Int) Current Steps start date
currentStepCode (String) Current Step Code
currentStepCompleteDateStamp (Int) Current step complete date
currentStepDueDateStamp (Int) Current step due date
currentStepId (Int) Current Step Id
currentStepLatestNote (String) Current step latest note
currentStepName (String) Current step name
currentStepOrder (Decimal) Current Step Order
currentStepOwner (String) Name of the current step owner
currentStepOwnerContactId (Int) Current step contact ID
currentStepOwnerTeamId (Int) Current step team ID
currentStepRename (RequestStepType)  
currentStepStartDateStamp (Int) Current step start date
followers ([ContactType])  
form (FormType)  
formId (Int) Create Request Form ID
forms ([FormType])  
isAddStepEnabled (Boolean) Is Add Adhoc Step Enabled?
isCurrentStepOwnerMe (Boolean) Current step contact name
isCurrentStepOwnerPerson (Boolean) Current step owner is a person
isCurrentStepOwnerTeamMember (Boolean) Process owner team member
isDelayed (Boolean) Is Delayed according to due date?
isProcessExternal (Boolean) Boolean if the process is external
isProcessOwnerContactTeamMate (Boolean) Process owner contact a team mate
isProcessOwnerExternal (Boolean) Process owner external
isProcessOwnerPerson (Boolean) Process owner is a person
isProcessOwnerTeamMember (Boolean) Process owner team member
isRequesterMe (Boolean) Process owner team member
isViewable (Boolean) Can contact view this request?
nonAdhocProgress (Decimal) Request non-adhoc step progress
notes ([NoteType])  
originalDueDateStamp (Int) Original due date
originalRequestCode (String) Original request code
originalRequestId (Decimal) Original request ID
originalRequestName (String) Original request name
previousStep (RequestStepType)  
process (ProcessType)  
processCode (String) Process code
processId (Int) Process ID
processName (String) Process name
processOwner (String) Name of process owner
processOwnerContactId (Int) Process owner contact ID
processOwnerTeamId (Int) Process owner team ID
progress (Decimal) Request progress
progressString (String) progressString
projects ([ProjectType])  
recurrences ([RequestRecurrenceType])  
relatedProjects ([ProjectType])  
requestCloseDateStamp (Int) Request close date
requestCode (String) Request code
requestComment (String) Request code
requestDateStamp (Int) Request date
requester (ContactType)  
requestId (Int) Request ID
requestName (String) Request name
requestNotes () Array of all the request notes
requestRecurrenceId (Int) Request recurrence ID
requestStatusId (Int) Request status ID
requestStatusName (String) Request status
requestUpdateDateStamp (Int) Request update date
requestUrl (String) Request Url
status (String) Request status
stepName (String) Current Step
steps ([RequestStepType])  
toDo (String) Name of the current to-do task
totalNonAdhocStepCount (Int) Number of non-adhoc steps
totalSkippedStepCount (Int) Number of skipped steps
totalSteps (Int) Total steps
totalTodoSteps (Int) Remaining open steps to complete
useDueDates (Boolean) Use Due Dates?
workflowOwner (OwnerType)  

Fragment

The recommended fragment to use for an overview, i.e. as part of a search result list:

fragment RequestOverviewFragment on RequestType {
    requestCode
    requestName
    requestRecurrenceId
    requestStatusName
    totalSteps
    totalTodoSteps
    completedStepCount
    isDelayed
    useDueDates
    originalDueDateStamp
    currentDueDateStamp
    requester {
        ...ContactFragment
    }
    processName
    processCode
    requestComment
    requestDateStamp
}
${contactFragment}

The recommended fragment to use for the details, i.e. when viewing the Ask:

fragment RequestFragment on RequestType {
    requestStatusName
    process {
        processName
        processCode
        isArchive
    }
    requestComment
    requestCode
    requestName
    requestDateStamp
    currentStepId
    currentStepCode
    requestRecurrenceId
    totalSteps
    completedStepCount
    totalTodoSteps
    currentProcessStepOwnerTeamName
    isDelayed
    useDueDates
    originalDueDateStamp
    currentDueDateStamp
    requester {
        ...ContactFragment
    }
    workflowOwner {
        ...OwnerFragment
        type
        contactPoolName
        contactIsMe
        isMember
    }
    form {
        ...FormFragment
    }
    relatedProjects {
        ...ProjectFragment
        requests {
            requestName
            requestCode
            isViewable
        }
    }
    attachments {
        ...FileFragment
    }
    steps {
        ...RequestStepFragment
    }
}
${ownerFragment}
${formFragment}
${contactFragment}
${fileFragment}
${requestStepFragment}
${projectFragment}

Back to Top

 

RuleActionType

 

Fields

Field Description
defaultRuleActionNote (String) Default Action Note
dOrder (Int) DOrder
formPrimaryTargetItemText (String) Form Primary Target Item Text
formSecondaryItemText (String) Form Secondary Target Item Text
primarytargetItem (Int) Primary Target Item
primarytargetItemDescription (String) Primary Target Item Description
primarytargetItemID (Decimal) Primary Target Item ID
primarytargetItemName (String) Primary Target Item Name
primarytargetItemText (String) Primary Target Item Text
ruleActionCode (String) Rule Action Code
ruleActionId (Int) Rule Action ID
ruleActionName (String) Rule Action Name
ruleActionTypeID (Int) Rule Action Type ID
ruleActionTypeName (String) Rule Action Type Name
ruleActionTypeTooltipText (String) Rule Action Type Tooltip
ruleId (Decimal) Rule ID
secondaryItemContactEmail (String) Secondary Target Item Contact Email
secondaryItemDescription (String) Secondary Target Item Description
secondaryItemDorder (Int) Secondary Target Item DOrder
secondaryItemDorderDescription (String) Secondary Target Item DOrder Description
secondaryItemID (Decimal) Secondary Target Item ID
secondaryItemName (String) Secondary Target Item Name
secondaryItemText (String) Secondary Target Item Text
secondarytargetItem (Int) Secondary Target Item

Fragment

The recommended fragment to use is:

fragment RuleActionFragment on RuleActionType{
    dOrder
    primarytargetItem
    primarytargetItemName
    primarytargetItemText
    formPrimaryTargetItemText
    primarytargetItemDescription
    primarytargetItemID
    ruleActionId
    ruleActionCode
    ruleActionName
    ruleActionTypeID
    ruleActionTypeName
    ruleActionTypeTooltipText
    secondarytargetItem
    secondaryItemName
    secondaryItemText
    formSecondaryItemText
    secondaryItemDescription
    secondaryItemID
    secondaryItemDorder
    secondaryItemDorderDescription
    secondaryItemContactEmail
    defaultRuleActionNote
}

Back to Top

 

RuleType

 

Fields

Field Description
dOrder (Int) DOrder
evaluatorTypeEnum (EvaluatorTypeEnum)  
evaluatorTypeId (Int) Evaluator Type ID
evaluatorTypeName (String) Evaluator Type Name
fieldCode (String) Field Code
fieldId (Int) Field ID
fieldName (String) Field Name
fieldTitle (String) Field Title
formFieldCode (String) Form Field Code
isArchive (Int) Is Archive?
isSkipEvaluation (Int) Is Skip Evaluation?
isStopProcessing (Int) Is Stop Processing?
isTrash (Int) Is Trash?
processCode (String) Process Code
processID (Decimal) Process ID
ruleActions ([RuleActionType])  
ruleCode (String) Rule Code
ruleID (Decimal) Rule ID
ruleName (String) Rule Name
stepName (String) Step Name
testValue (String) Test Value

Fragment

The recommended fragment to use is:

fragment RuleFragment on RuleType {
    dOrder
    fieldCode
    formFieldCode
    fieldName
    fieldTitle
    evaluatorTypeEnum
    evaluatorTypeName
    isArchive
    isTrash
    isSkipEvaluation
    isStopProcessing
    processCode
    ruleCode
    ruleName
    ruleActions {
        ...RuleActionFragment
    }
    stepName
    testValue
}
${ruleActionFragment}

Back to Top