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 |
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 |
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 |
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 |
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 |
DropDownOptionType
Fields
| Field | Description |
|---|---|
| optionName (String) | Option Name |
| optionValue (String) | Option Value |
FacetsType
Fields
| Field | Description |
|---|---|
| currentStepOwnerContactPools () | |
| currentStepOwnerContacts () | |
| currentSteps () | |
| processCodes () | Facet process codes |
| processCurrentStepOwnerContactPools () | |
| processCurrentSteps () | |
| processes () | |
| processesNew ([ProcessType]) | |
| processOwnerContactPools () | |
| processOwnerContacts () | |
| processStepOwnerContactPools () | |
| requesters () | |
| requestStatuses () |
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 |
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 |
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]) |
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 |
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 |
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 |
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 () |
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 |
| stepParam4 (String) | Process step type parameter 4 |
| stepParam5 (String) | Process step type parameter 5 |
| stepParameterTemplate (String) | Process step parameter template |
| stepParamLarge1 (String) | Process step type parameter 1 |
| stepParamLarge2 (String) | Process step type parameter 2 |
| 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 |
| submitMessage (String) | Submit message |
| targetStep (ProcessStepType) |
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 (Int) | Average elapsed days |
| averageStepOwners (Int) | Average step owners |
| averageStepsPerRequest (Int) | 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]) | |
| defaultFollowerTeams ([ContactPoolType]) | |
| externalHiddenFieldIDs (String) | List of External field IDs hidden on request form |
| externalURL (String) | External Create Ask Form URL |
| forms ([FormType]) | |
| 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 |
| hasConfidentialSteps (Int) | Whether the process has any steps flagged as confidential |
| hasCreateAskCustomFields (Int) | Whether the process has any custome fields in the Create Ask Form |
| 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 |
| parentProcess (ProcessType) | |
| 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 |
| 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 |
| requestsByMonthThisYear ([RequestsByMonthThisYearType]) | |
| requestsInLifetime (RequestsByLifetimeType) | |
| requestsSubmittedByContactCount (Int) | Count of requests submitted by contact for this process |
| requestsThisYear (RequestsThisYearType) | |
| requestSummary (String) | Request summary template |
| 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 |
| step0AppId (String) | Step 0 App ID |
| step0Notes (String) | Step 0 Notes |
| step0Process (ProcessType) | |
| stepgroups ([ProcessStepGroupType]) | |
| steps () | |
| stepZAppId (String) | Step Z App ID |
| stepZNotes (String) | Step Z Notes |
| stepZProcess (ProcessType) | |
| submitMessage (String) | Submit message |
| templateCategoryId (Int) | Template Category |
| templateCategoryName (String) | Template Category Name |
| 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 (Int) | Template Price |
| templateSourceMasterParentCode (String) | Template source master parent code |
| toggleLiveToolTipText (String) | The tooltip text for toggle live |
| totalStepCount (Int) | Number of total steps |
| totalStepsByOwner ([TotalStepsByOwnerType]) | |
| useDueDates (Boolean) | useDueDates |
| versionCount (Int) | Number of versions for this Workflow |
| versionId (Int) | the version id of the workflow |
| workflowOwner (OwnerType) |
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 |
| milestones ([MilestoneType]) | |
| 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 (Int) | 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 |
| projectUpdateDateStamp (Int) | Project update date |
| requests ([RequestType]) |
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 |
RequestsByLifetimeType
Fields
| Field | Description |
|---|---|
| averageTimeCanceled (Int) | averageTimeCanceled |
| averageTimeCompleted (Int) | averageTimeCompleted |
| averageTimeOpen (Int) | averageTimeOpen |
| canceled (Int) | canceled |
| completed (Int) | completed |
| open (Int) | open |
RequestsByMonthThisYearType
Fields
| Field | Description |
|---|---|
| canceled (Int) | canceled |
| completed (Int) | comppleted |
| month (Int) | month |
| submitted (Int) | submitted |
| uniqueSubmitters (Int) | uniqueSubmitters |
RequestStepGroupType
Fields
| Field | Description |
|---|---|
| canceledStepCount (Int) | Number of Canceled Steps in the Step Group |
| completedStepCount (Int) | Number of Completed Steps in the Step Group |
| dorder (Int) | Step Group DOrder |
| dueDateDependentStepId (Int) | Step Group Due Date Dependent Step Id |
| dueDateStamp (Int) | Step Group Due Date |
| dueDateTimeToComplete (Int) | Step Group Due Date Time to Complete |
| groupCompletionDateStamp (Int) | Step Group Completion Date |
| groupStartDateStamp (Int) | Step Group Start Date |
| groupStatus (Int) | Step Group Status |
| groupStatusName (String) | Step Group Status Name |
| isArchive (Int) | Is Archive? |
| isPastDue (Boolean) | Is past due? |
| isTrash (Int) | Is Trash? |
| openStepCount (Int) | Number of Open Steps in the Step Group |
| processStepGroupID (Int) | Processs Step Group ID |
| progress (Int) | Step Group Progress |
| requestID (Int) | Request ID |
| stepGroupCode (String) | Step Group Code |
| stepGroupId (Int) | Step Group Id |
| stepGroupName (String) | Step Group Name |
| steps () | |
| totalStepCount (Int) | Total Number of Steps in the Step Group |
RequestStepType
Fields
| Field | Description |
|---|---|
| activityFeedEntries ([ActivityFeedEntryType]) | |
| allowableUploadExtentions (String) | Allowable file extensions |
| attachments ([FileType]) | |
| autoCompleteAfterDays (Int) | Auto-Complete after days |
| canReassignStep (Boolean) | Can Reassign Step |
| canRenderDisabledEditAndDeleteAdhocButtons (Boolean) | canRenderDisabledEditAndDeleteAdhocButtons |
| canRenderEditAndDeleteAdhocButtons (Boolean) | canRenderEditAndDeleteAdhocButtons |
| canSendReminder (Boolean) | Can Send a Reminder |
| canViewStep (Boolean) | Can View Confidential Step |
| costsAcutal (Int) | Cost Actual |
| costsBudgeted (Int) | 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 |
| groupLetter (String) | Letter of Step in Group |
| groupOrder (Int) | Order of Step in Group |
| hoursBillable (Int) | Hours Billable |
| hoursBudgeted (Int) | 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 |
| isContactExternalNextStepOwner (Boolean) | Is current user the next external step owner |
| isContactExternalPreviousStepOwner (Boolean) | Is current user the previous external step owner |
| 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 |
| isCurrentStepGroup (Boolean) | Is the step in a step group that has the current step in the Ask |
| isExternal (Int) | Whether the step can be completed externally |
| isFilesRequired (Int) | Whether the step requires file upload |
| isHiddenDescription (Int) | Whether the instructions / description should be hidden |
| isHideNotes (Int) | Whether the step hides due dates |
| isHideUpload (Int) | Whether the step hides due dates |
| isOpen (Boolean) | Is the step Open |
| isPastDue (Boolean) | Is past due? |
| isPrecedingStepAGroup (Boolean) | Whether the preceding step is a group |
| isRequestOpen (Boolean) | Whether the request is open |
| isRequireUpload (Boolean) | Is require upload to complete step |
| isSkippable (Int) | Whether the step is skippable |
| nextStepCode (String) | Next Step code |
| nextUserStep (RequestStepType) | |
| notes ([NoteType]) | |
| notificationOwner (OwnerType) | |
| previousStepCode (String) | Previous Step code |
| previousStepGroupCode (String) | Previous Step Group code |
| previousUserStep (RequestStepType) | |
| processStep (ProcessStepType) | |
| processStepCode (String) | Process Step Code |
| processStepId (Int) | Process Step ID |
| processStepName (String) | Process Step Name |
| processStepOwnerContactId (Int) | Step contact ID |
| processStepOwnerContactPoolId (Int) | Step owner contact pool ID |
| 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 |
| requestCode (String) | Request code |
| requestId (Int) | Request ID |
| requestStatusName (String) | Request Status |
| showAssignTo (Boolean) | Can Show Assign To |
| showCompleteButton (Boolean) | Can Show Complete Buttons |
| showInstructions (Boolean) | Can Show Step Instructions |
| showStepFormEdit (Boolean) | Can Show Step Form in Edit Mode |
| stepCode (String) | Step code |
| stepCompleteDateStamp (Int) | Step complete date |
| stepCompleteName (String) | Step complete name |
| stepCreateDateStamp (Int) | Step create date |
| stepDescription (String) | Step description |
| stepDueDateStamp (Int) | Step due date |
| stepgroup (RequestStepGroupType) | |
| stepGroupID (Int) | Step Group ID |
| stepId (Int) | Step ID |
| stepName (String) | Step name |
| stepNote (String) | Step note |
| stepNumber (String) | Badge Number of the steps |
| stepOrder (Int) | Step order |
| stepOwner (OwnerType) | |
| stepOwnerIsRequester (Boolean) | Step Owner is Requester |
| stepParam1 (String) | Process step type parameter 1 |
| stepParam2 (String) | Process step type parameter 2 |
| stepParam3 (String) | Process step type parameter 3 |
| stepParam4 (String) | Process step type parameter 4 |
| stepParam5 (String) | Process step type parameter 5 |
| stepParamLarge1 (String) | Process step type parameter 1 |
| stepParamLarge2 (String) | Process step type parameter 2 |
| stepProcessOwner (OwnerType) | |
| stepRejectName (String) | Step reject name |
| stepStartDateStamp (Int) | Step start date |
| stepStatusId (Int) | Step status ID |
| stepStatusName (String) | Step status |
| stepTypeId (Int) | Step type ID |
| stepUpdateDateStamp (Int) | Step update date |
| useDueDates (Boolean) | Request uses Due Dates |
| writeToActivityFeed (Boolean) | Write to Actiivty feed |
RequestsThisYearType
Fields
| Field | Description |
|---|---|
| averageTimeCanceled (Int) | averageTimeCanceled |
| averageTimeCompleted (Int) | averageTimeCompleted |
| averageTimeOpen (Int) | averageTimeOpen |
| canceled (Int) | canceled |
| completed (Int) | completed |
| open (Int) | open |
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 |
| currentDueDateStamp (Int) | Current due date |
| currentProcessStepOwnerTeamName (String) | Current Process Step Owner Team Name |
| currentStep (RequestStepType) | |
| currentStepCode (String) | Current Step Code |
| currentStepCompleteDateStamp (Int) | Current step complete date |
| currentStepDueDateStamp (Int) | Current step due date |
| currentStepId (Int) | Current Step Id |
| currentStepName (String) | Current step name |
| currentStepOrder (Int) | Current Step Order |
| currentStepRename (RequestStepType) | |
| followers ([ContactType]) | |
| followerTeams ([ContactPoolType]) | |
| 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 (Int) | Request non-adhoc step progress |
| notes ([NoteType]) | |
| originalDueDateStamp (Int) | Original due date |
| originalRequestCode (String) | Original request code |
| originalRequestId (Int) | Original request ID |
| originalRequestName (String) | Original request name |
| previousStep (RequestStepType) | |
| process (ProcessType) | |
| processCode (String) | Process code |
| processId (Int) | Process ID |
| processName (String) | Process name |
| progress (Int) | 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 |
| requestDomain (String) | Request Domain |
| requester (ContactType) | |
| requestId (Int) | Request ID |
| requestName (String) | Request name |
| requestRecurrenceId (Int) | Request recurrence ID |
| requestStatusId (Int) | Request status ID |
| requestStatusName (String) | Request status |
| requestUpdateDateStamp (Int) | Request update date |
| requestUrl (String) | Request Url |
| stepgroups ([RequestStepGroupType]) | |
| steps () | |
| 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) |
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 |
| isTargetItemOwnerConflict (Int) | If the logged in contact does not have access to the rule action target item. |
| primarytargetItem (Int) | Primary Target Item |
| primarytargetItemDescription (String) | Primary Target Item Description |
| primarytargetItemID (Int) | 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 (Int) | 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 (Int) | Secondary Target Item ID |
| secondaryItemName (String) | Secondary Target Item Name |
| secondaryItemText (String) | Secondary Target Item Text |
| secondarytargetItem (Int) | Secondary Target Item |
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 (Int) | Process ID |
| processRuleCreateDateStamp (Int) | Process Rule Create Date |
| processRuleCreatorContact (ContactType) | |
| processRuleCreatorContactID (Int) | Process Rule Creator Contact ID |
| processRuleUpdateDateStamp (Int) | Process Rule Update Date |
| processRuleUpdaterContact (ContactType) | |
| processRuleUpdaterContactID (Int) | Process Rule Update Contact ID |
| ruleActions ([RuleActionType]) | |
| ruleCode (String) | Rule Code |
| ruleEvaluatorDescription (String) | Evaluator Description |
| ruleID (Int) | Rule ID |
| ruleName (String) | Rule Name |
| step (ProcessStepType) | |
| stepId (Int) | Step ID |
| testValue (String) | Test Value |
SearchFacetType
Fields
| Field | Description |
|---|---|
| contactPoolMembers ([ContactType]) | |
| contactPoolOwners ([ContactType]) | |
| contactPools ([ContactPoolType]) | |
| processCurrentSteps ([ProcessStepType]) | |
| processOwnerContactPools ([ContactPoolType]) | |
| processOwnerContacts ([ContactType]) | |
| processStepOwnerContactPools ([ContactPoolType]) | |
| processsteps ([ProcessStepType]) | |
| projectOwners ([OwnerType]) | |
| projects ([ProjectType]) | |
| requestCurrentProcesses ([ProcessType]) | |
| requestCurrentStepOwnerContactPools ([ContactPoolType]) | |
| requestCurrentStepOwnerContacts ([ContactType]) | |
| requestCurrentStepProcessOwnerContactPools ([ContactPoolType]) | |
| requesters ([ContactType]) | |
| requestMasterProcesses ([ProcessType]) | |
| requestProcessOwnerContactPools ([ContactPoolType]) | |
| requestProcessOwnerContacts ([ContactType]) | |
| searchFacetCode (String) | Search Facet Code |
SearchPageResultType
Fields
| Field | Description |
|---|---|
| contactPools ([ContactPoolType]) | |
| page (Int) | Page |
| pageSize (Int) | Page Size |
| processes ([ProcessType]) | |
| projects ([ProjectType]) | |
| requests ([RequestType]) | |
| searchPageResultCode (String) | Search Page Result Code |
| searchTerm (String) | Search Term |
| totalCount (Int) | Total count |
TotalStepsByOwnerType
Fields
| Field | Description |
|---|---|
| ownerName (String) | Owner Name |
| totalCanceled (Int) | totalCanceled |
| totalComplete (Int) | totalComplete |
| totalCurrent (Int) | totalCurrent |
| totalOpen (Int) | totalOpen |