Types

Sep 22, 2022

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 (Int) 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

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

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
contactPoolUpdateDateStamp (Int) Team update date
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 ()
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 ()
processes ([ProcessType])
processSteps ([ProcessStepType])
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

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
otpToken (String) one time password token
otpTokenExpirationStamp (Int) one time password token expiration timestamp
sponsorContactId (Int) sponsorContactId
sponsorContactName (String) sponsorContactName
sponsorContactPoolId (Int) sponsorContactPoolId

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


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

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 ()
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

Back to Top


MilestoneType

Fields

Field Description
dOrder (Int) dOrder
milestoneCode (String) Milestone Code
milestoneId (Int) Milestone ID
milestoneName (String) Milestone Name
projectId (Int) Request ID
requests ([RequestType])

Back to Top


NoteType

Fields

Field Description
activityFeedRecordTypeEnum (ActivityFeedRecordTypeEnum)
canDelete (Int) canDelete
contact (ContactType)
ip (String) IP address
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

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

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


ProcessStepGroupType

Fields

Field Description
dorder (Int) Step Group DOrder
dueDateDependentStepCode (String) Step Due Date Dependent Step Code
dueDateDependentStepId (Int) Step Group Due Date Dependent Step Id
dueDateDependentStepIsGroup (Int) Step Due Date Dependent Step Is A Group?
dueDateDependentStepName (String) Step Due Date Dependent Step Name
dueDateDependentStepOrder (Int) Step Due Date Dependent Step Order
dueDateStamp (Int) Step Group Due Date
dueDateTimeToComplete (Int) Step Group Due Date Time to Complete
isArchive (Int) Is Archive?
isTrash (Int) Is Trash?
numberOfStepsInGroup (Int) Number of Steps in the Step Group
processID (Int) ProcessID
stepGroupCode (String) Step Group Code
stepGroupId (Int) Step Group Id
stepGroupName (String) Step Group Name
stepNumber (String) Step Number
steps ()

Back to Top


ProcessStepType

Fields

Field Description
allowableUploadExtentions (String) List of allowable upload extensions
analytics (AnalyticsType)
autoCompleteAfterDays (Int) Auto-Complete after days
completeFormDesignId (Int) form Id
dueDateDependentStep (ProcessStepType)
dueDateDependentStepCode (String) Step Due Date Dependent Step Code
dueDateDependentStepGroup (ProcessStepGroupType)
dueDateDependentStepId (Int) Step Due Date Dependent Step Id
dueDateDependentStepIsGroup (Int) Step Due Date Dependent Step Is A Group?
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
groupLetter (String) Letter of Step in Group
groupOrder (Int) Order of Step in Group
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
isHideNotes (Int) Whether the step hides due dates
isHideUpload (Int) 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
isNonAction (Int) Whether the step is non-action
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
isSkipActionRequired (Int) Whether the step should skip the action required email
isSkippable (Int) Whether the step is skippable
isTrash (Int) Whether the step is deleted
milestoneName (String) Milestone name
process (ProcessType)
processCode (String) Process code used for identity
processId (Int) Process Id
processMasterParentCode (String) Process Master Parent code
processName (String) Process Name
reminder1Days (Int) Reminder 1 days
reminder2Days (Int) Reminder 2 days
reminder3Days (Int) Reminder 3 days
reminderForeverDays (Int) Reminder forever days
reminderVoicemailUrl (String) Reminder voicemail url
requestSubmitMessage (String) Submit message
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
stepGroup (ProcessStepGroupType)
stepGroupID (Int) Step Group ID
stepId (Int) Id of Step
stepName (String) Name of Step
stepNotes (String) Notes attached to step
stepNumber (String) Badge Number of the steps
stepOrder (Int) Order of the steps
stepOwner (OwnerType)
stepOwnerContactEmailFieldCode (String) Step owner contact email field code
stepOwnerContactFirstNameFieldCode (String) Step owner contact first name field code
stepOwnerContactId (Int) Step owner contact
stepOwnerContactLastNameFieldCode (String) Step owner contact last name field code
stepOwnerContactPhoneFieldCode (String) Step owner contact phone field code
stepOwnerTeamId (Int) Step owner team
stepParam1 (String) Process step type parameter 1
stepParam2 (String) Process step type parameter 2
stepParam3 (String) Process step type parameter 3