“unsupported” API Reference¶

class workfront.versions.unsupported.AccessLevel(session=None, **fields)¶

Object for ACSLVL

access_level_permissions¶: Collection for accessLevelPermissions

access_restrictions¶: Field for accessRestrictions

access_rule_preferences¶: Collection for accessRulePreferences

access_scope_actions¶: Collection for accessScopeActions

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

calculate_sharing(obj_code=None, obj_id=None)¶

The calculateSharing action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

clear_access_rule_preferences(obj_code=None)¶

The clearAccessRulePreferences action.

Parameters:	obj_code – objCode (type: `string`)

create_unsupported_worker_access_level_for_testing()¶: The createUnsupportedWorkerAccessLevelForTesting action.

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

display_access_type¶: Field for displayAccessType

ext_ref_id¶: Field for extRefID

field_access_privileges¶: Field for fieldAccessPrivileges

filter_actions_for_external(obj_code=None, action_types=None)¶

The filterActionsForExternal action.

Parameters:	obj_code – objCode (type: `string`) action_types – actionTypes (type: `string[]`)
Returns:	`string[]`

filter_available_actions(user_id=None, obj_code=None, action_types=None)¶

The filterAvailableActions action.

Parameters:	user_id – userID (type: `string`) obj_code – objCode (type: `string`) action_types – actionTypes (type: `string[]`)
Returns:	`string[]`

get_access_level_permissions_for_obj_code(obj_code=None, access_level_ids=None)¶

The getAccessLevelPermissionsForObjCode action.

Parameters:	obj_code – objCode (type: `string`) access_level_ids – accessLevelIDs (type: `string[]`)
Returns:	`map`

get_default_access_permissions(license_type=None)¶

The getDefaultAccessPermissions action.

Parameters:	license_type – licenseType (type: `com.attask.common.constants.LicenseTypeEnum`)
Returns:	`map`

get_default_access_rule_preferences()¶

The getDefaultAccessRulePreferences action.

Returns:	`map`

get_default_forbidden_actions(obj_code=None, obj_id=None)¶

The getDefaultForbiddenActions action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`map`

get_maximum_access_permissions(license_type=None)¶

The getMaximumAccessPermissions action.

Parameters:	license_type – licenseType (type: `com.attask.common.constants.LicenseTypeEnum`)
Returns:	`map`

get_security_parent_ids(obj_code=None, obj_id=None)¶

The getSecurityParentIDs action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`map`

get_security_parent_obj_code(obj_code=None, obj_id=None)¶

The getSecurityParentObjCode action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`string`

get_user_accessor_ids(user_id=None)¶

The getUserAccessorIDs action.

Parameters:	user_id – userID (type: `string`)
Returns:	`string[]`

get_viewable_object_obj_codes()¶

The getViewableObjectObjCodes action.

Returns:	`string[]`

has_any_access(obj_code=None, action_type=None)¶

The hasAnyAccess action.

Parameters:	obj_code – objCode (type: `string`) action_type – actionType (type: `com.attask.common.constants.ActionTypeEnum`)
Returns:	`java.lang.Boolean`

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

is_admin¶: Field for isAdmin

is_unsupported_worker_license¶: Field for isUnsupportedWorkerLicense

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

last_updated_date¶: Field for lastUpdatedDate

legacy_access_level_id¶: Field for legacyAccessLevelID

legacy_diagnostics()¶

The legacyDiagnostics action.

Returns:	`map`

license_type¶: Field for licenseType

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

rank¶: Field for rank

security_model_type¶: Field for securityModelType

set_access_rule_preferences(access_rule_preferences=None)¶

The setAccessRulePreferences action.

Parameters:	access_rule_preferences – accessRulePreferences (type: `string[]`)

class workfront.versions.unsupported.AccessLevelPermissions(session=None, **fields)¶

Object for ALVPER

access_level¶: Reference for accessLevel

access_level_id¶: Field for accessLevelID

core_action¶: Field for coreAction

customer¶: Reference for customer

customer_id¶: Field for customerID

forbidden_actions¶: Field for forbiddenActions

is_admin¶: Field for isAdmin

obj_obj_code¶: Field for objObjCode

secondary_actions¶: Field for secondaryActions

class workfront.versions.unsupported.AccessRequest(session=None, **fields)¶

Object for ACSREQ

action¶: Field for action

auto_generated¶: Field for autoGenerated

auto_share_action¶: Field for autoShareAction

awaiting_approvals¶: Collection for awaitingApprovals

customer¶: Reference for customer

customer_id¶: Field for customerID

grant_access(access_request_id=None, action_type=None, forbidden_actions=None)¶

The grantAccess action.

Parameters:	access_request_id – accessRequestID (type: `string`) action_type – actionType (type: `string`) forbidden_actions – forbiddenActions (type: `string[]`)

grant_object_access(obj_code=None, id=None, accessor_id=None, action_type=None, forbidden_actions=None)¶

The grantObjectAccess action.

Parameters:	obj_code – objCode (type: `string`) id – id (type: `string`) accessor_id – accessorID (type: `string`) action_type – actionType (type: `string`) forbidden_actions – forbiddenActions (type: `string[]`)

granter¶: Reference for granter

granter_id¶: Field for granterID

ignore(access_request_id=None)¶

The ignore action.

Parameters:	access_request_id – accessRequestID (type: `string`)

last_remind_date¶: Field for lastRemindDate

last_update_date¶: Field for lastUpdateDate

message¶: Field for message

recall(access_request_id=None)¶

The recall action.

Parameters:	access_request_id – accessRequestID (type: `string`)

remind(access_request_id=None)¶

The remind action.

Parameters:	access_request_id – accessRequestID (type: `string`)

request_access(obj_code=None, obj_id=None, requestee_id=None, core_action=None, message=None)¶

The requestAccess action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) requestee_id – requesteeID (type: `string`) core_action – coreAction (type: `com.attask.common.constants.ActionTypeEnum`) message – message (type: `string`)

request_date¶: Field for requestDate

requested_obj_code¶: Field for requestedObjCode

requested_obj_id¶: Field for requestedObjID

requested_object_name¶: Field for requestedObjectName

requestor¶: Reference for requestor

requestor_id¶: Field for requestorID

status¶: Field for status

class workfront.versions.unsupported.AccessRule(session=None, **fields)¶

Object for ACSRUL

accessor_id¶: Field for accessorID

accessor_obj_code¶: Field for accessorObjCode

ancestor_id¶: Field for ancestorID

ancestor_obj_code¶: Field for ancestorObjCode

core_action¶: Field for coreAction

customer¶: Reference for customer

customer_id¶: Field for customerID

forbidden_actions¶: Field for forbiddenActions

is_inherited¶: Field for isInherited

secondary_actions¶: Field for secondaryActions

security_obj_code¶: Field for securityObjCode

security_obj_id¶: Field for securityObjID

class workfront.versions.unsupported.AccessRulePreference(session=None, **fields)¶

Object for ARPREF

access_level¶: Reference for accessLevel

access_level_id¶: Field for accessLevelID

accessor_id¶: Field for accessorID

accessor_obj_code¶: Field for accessorObjCode

core_action¶: Field for coreAction

customer¶: Reference for customer

customer_id¶: Field for customerID

forbidden_actions¶: Field for forbiddenActions

secondary_actions¶: Field for secondaryActions

security_obj_code¶: Field for securityObjCode

template¶: Reference for template

template_id¶: Field for templateID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.AccessScope(session=None, **fields)¶

Object for ACSCP

allow_non_view_external¶: Field for allowNonViewExternal

allow_non_view_hd¶: Field for allowNonViewHD

allow_non_view_review¶: Field for allowNonViewReview

allow_non_view_team¶: Field for allowNonViewTeam

allow_non_view_ts¶: Field for allowNonViewTS

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

display_order¶: Field for displayOrder

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

scope_expression¶: Field for scopeExpression

scope_obj_code¶: Field for scopeObjCode

class workfront.versions.unsupported.AccessScopeAction(session=None, **fields)¶

Object for ASCPAT

access_level¶: Reference for accessLevel

access_level_id¶: Field for accessLevelID

access_scope¶: Reference for accessScope

access_scope_id¶: Field for accessScopeID

actions¶: Field for actions

customer¶: Reference for customer

customer_id¶: Field for customerID

scope_obj_code¶: Field for scopeObjCode

class workfront.versions.unsupported.AccessToken(session=None, **fields)¶

Object for ACSTOK

action¶: Field for action

calendar¶: Reference for calendar

calendar_id¶: Field for calendarID

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_id¶: Field for documentID

document_request¶: Reference for documentRequest

document_request_id¶: Field for documentRequestID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

expire_date¶: Field for expireDate

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

token_type¶: Field for tokenType

user¶: Reference for user

user_id¶: Field for userID

value¶: Field for value

class workfront.versions.unsupported.AccountRep(session=None, **fields)¶

Object for ACNTRP

admin_level¶: Field for adminLevel

description¶: Field for description

email_addr¶: Field for emailAddr

ext_ref_id¶: Field for extRefID

first_name¶: Field for firstName

is_active¶: Field for isActive

last_name¶: Field for lastName

password¶: Field for password

phone_number¶: Field for phoneNumber

reseller¶: Reference for reseller

reseller_id¶: Field for resellerID

ui_code¶: Field for uiCode

username¶: Field for username

class workfront.versions.unsupported.Acknowledgement(session=None, **fields)¶

Object for ACK

acknowledge(obj_code=None, obj_id=None)¶

The acknowledge action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`string`

acknowledge_many(obj_code_ids=None)¶

The acknowledgeMany action.

Parameters:	obj_code_ids – objCodeIDs (type: `map`)
Returns:	`string[]`

acknowledgement_type¶: Field for acknowledgementType

customer¶: Reference for customer

customer_id¶: Field for customerID

entry_date¶: Field for entryDate

owner¶: Reference for owner

owner_id¶: Field for ownerID

reference_object_name¶: Field for referenceObjectName

target¶: Reference for target

target_id¶: Field for targetID

unacknowledge(obj_code=None, obj_id=None)¶

The unacknowledge action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

class workfront.versions.unsupported.Announcement(session=None, **fields)¶

Object for ANCMNT

actual_subject¶: Field for actualSubject

announcement_recipients¶: Collection for announcementRecipients

announcement_type¶: Field for announcementType

attachments¶: Collection for attachments

content¶: Field for content

customer_recipients¶: Field for customerRecipients

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

file_handle(attachment_id=None)¶

The fileHandle action.

Parameters:	attachment_id – attachmentID (type: `string`)
Returns:	`string`

formatted_recipients¶: Field for formattedRecipients

has_attachments¶: Field for hasAttachments

is_draft¶: Field for isDraft

last_sent_date¶: Field for lastSentDate

other_recipient_names¶: Field for otherRecipientNames

preview_user_id¶: Field for previewUserID

recipient_types¶: Field for recipientTypes

send_draft¶: Field for sendDraft

subject¶: Field for subject

summary¶: Field for summary

type¶: Field for type

zip_announcement_attachments(announcement_id=None)¶

The zipAnnouncementAttachments action.

Parameters:	announcement_id – announcementID (type: `string`)
Returns:	`string`

class workfront.versions.unsupported.AnnouncementAttachment(session=None, **fields)¶

Object for ANMATT

announcement¶: Reference for announcement

announcement_id¶: Field for announcementID

doc_size¶: Field for docSize

file_extension¶: Field for fileExtension

format_doc_size¶: Field for formatDocSize

forward_attachments(announcement_id=None, old_attachment_ids=None, new_attachments=None)¶

The forwardAttachments action.

Parameters:	announcement_id – announcementID (type: `string`) old_attachment_ids – oldAttachmentIDs (type: `string[]`) new_attachments – newAttachments (type: `map`)

name¶: Field for name

upload_attachments(announcement_id=None, attachments=None)¶

The uploadAttachments action.

Parameters:	announcement_id – announcementID (type: `string`) attachments – attachments (type: `map`)

class workfront.versions.unsupported.AnnouncementOptOut(session=None, **fields)¶

Object for AMNTO

announcement_opt_out(announcement_opt_out_types=None)¶

The announcementOptOut action.

Parameters:	announcement_opt_out_types – announcementOptOutTypes (type: `string[]`)

announcement_type¶: Field for announcementType

customer¶: Reference for customer

customer_id¶: Field for customerID

customer_name¶: Field for customerName

opt_out_date¶: Field for optOutDate

type¶: Field for type

user¶: Reference for user

user_first_name¶: Field for userFirstName

user_id¶: Field for userID

user_last_name¶: Field for userLastName

class workfront.versions.unsupported.AnnouncementRecipient(session=None, **fields)¶

Object for ANCREC

announcement¶: Reference for announcement

announcement_id¶: Field for announcementID

company¶: Reference for company

company_id¶: Field for companyID

customer¶: Reference for customer

customer_id¶: Field for customerID

group¶: Reference for group

group_id¶: Field for groupID

recipient_id¶: Field for recipientID

recipient_obj_code¶: Field for recipientObjCode

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.AppBuild(session=None, **fields)¶

Object for APPBLD

build_id¶: Field for buildID

build_number¶: Field for buildNumber

entry_date¶: Field for entryDate

class workfront.versions.unsupported.AppEvent(session=None, **fields)¶

Object for APEVT

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

event_obj_code¶: Field for eventObjCode

event_type¶: Field for eventType

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

query_expression¶: Field for queryExpression

script_expression¶: Field for scriptExpression

class workfront.versions.unsupported.AppGlobal(session=None, **fields)¶

Object for APGLOB

access_levels¶: Collection for accessLevels

access_scopes¶: Collection for accessScopes

app_events¶: Collection for appEvents

expense_types¶: Collection for expenseTypes

external_sections¶: Collection for externalSections

features_mapping¶: Collection for featuresMapping

hour_types¶: Collection for hourTypes

layout_templates¶: Collection for layoutTemplates

meta_records¶: Collection for metaRecords

portal_profiles¶: Collection for portalProfiles

portal_sections¶: Collection for portalSections

ui_filters¶: Collection for uiFilters

ui_group_bys¶: Collection for uiGroupBys

ui_views¶: Collection for uiViews

class workfront.versions.unsupported.AppInfo(session=None, **fields)¶

Object for APPINF

attask_version¶: Field for attaskVersion

build_number¶: Field for buildNumber

has_upgrade_error¶: Field for hasUpgradeError

last_update¶: Field for lastUpdate

upgrade_build¶: Field for upgradeBuild

upgrade_step¶: Field for upgradeStep

class workfront.versions.unsupported.Approval(session=None, **fields)¶

Object for APPROVAL

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

actual_benefit¶: Field for actualBenefit

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration¶: Field for actualDuration

actual_duration_expression¶: Field for actualDurationExpression

actual_duration_minutes¶: Field for actualDurationMinutes

actual_expense_cost¶: Field for actualExpenseCost

actual_hours_last_month¶: Field for actualHoursLastMonth

actual_hours_last_three_months¶: Field for actualHoursLastThreeMonths

actual_hours_this_month¶: Field for actualHoursThisMonth

actual_hours_two_months_ago¶: Field for actualHoursTwoMonthsAgo

actual_labor_cost¶: Field for actualLaborCost

actual_revenue¶: Field for actualRevenue

actual_risk_cost¶: Field for actualRiskCost

actual_start_date¶: Field for actualStartDate

actual_value¶: Field for actualValue

actual_work¶: Field for actualWork

actual_work_required¶: Field for actualWorkRequired

actual_work_required_expression¶: Field for actualWorkRequiredExpression

age_range_as_string¶: Field for ageRangeAsString

alignment¶: Field for alignment

alignment_score_card¶: Reference for alignmentScoreCard

alignment_score_card_id¶: Field for alignmentScoreCardID

alignment_values¶: Collection for alignmentValues

all_approved_hours¶: Field for allApprovedHours

all_hours¶: Collection for allHours

all_priorities¶: Collection for allPriorities

all_severities¶: Collection for allSeverities

all_statuses¶: Collection for allStatuses

all_unapproved_hours¶: Field for allUnapprovedHours

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approver_statuses¶: Collection for approverStatuses

approvers_string¶: Field for approversString

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

assignments_list_string¶: Field for assignmentsListString

audit_note¶: Field for auditNote

audit_types¶: Field for auditTypes

audit_user_ids¶: Field for auditUserIDs

auto_baseline_recur_on¶: Field for autoBaselineRecurOn

auto_baseline_recurrence_type¶: Field for autoBaselineRecurrenceType

auto_closure_date¶: Field for autoClosureDate

awaiting_approvals¶: Collection for awaitingApprovals

backlog_order¶: Field for backlogOrder

baselines¶: Collection for baselines

bccompletion_state¶: Field for BCCompletionState

billed_revenue¶: Field for billedRevenue

billing_amount¶: Field for billingAmount

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

billing_records¶: Collection for billingRecords

budget¶: Field for budget

budget_status¶: Field for budgetStatus

budgeted_completion_date¶: Field for budgetedCompletionDate

budgeted_cost¶: Field for budgetedCost

budgeted_hours¶: Field for budgetedHours

budgeted_labor_cost¶: Field for budgetedLaborCost

budgeted_start_date¶: Field for budgetedStartDate

business_case_status_label¶: Field for businessCaseStatusLabel

can_start¶: Field for canStart

category¶: Reference for category

category_id¶: Field for categoryID

children¶: Collection for children

color¶: Field for color

commit_date¶: Field for commitDate

commit_date_range¶: Field for commitDateRange

company¶: Reference for company

company_id¶: Field for companyID

completion_pending_date¶: Field for completionPendingDate

completion_type¶: Field for completionType

condition¶: Field for condition

condition_type¶: Field for conditionType

constraint_date¶: Field for constraintDate

converted_op_task_entry_date¶: Field for convertedOpTaskEntryDate

converted_op_task_name¶: Field for convertedOpTaskName

converted_op_task_originator¶: Reference for convertedOpTaskOriginator

converted_op_task_originator_id¶: Field for convertedOpTaskOriginatorID

cost_amount¶: Field for costAmount

cost_type¶: Field for costType

cpi¶: Field for cpi

csi¶: Field for csi

currency¶: Field for currency

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

current_status_duration¶: Field for currentStatusDuration

customer¶: Reference for customer

customer_id¶: Field for customerID

days_late¶: Field for daysLate

default_baseline¶: Reference for defaultBaseline

default_baseline_task¶: Reference for defaultBaselineTask

default_forbidden_contribute_actions¶: Field for defaultForbiddenContributeActions

default_forbidden_manage_actions¶: Field for defaultForbiddenManageActions

default_forbidden_view_actions¶: Field for defaultForbiddenViewActions

deliverable_score_card¶: Reference for deliverableScoreCard

deliverable_score_card_id¶: Field for deliverableScoreCardID

deliverable_success_score¶: Field for deliverableSuccessScore

deliverable_success_score_ratio¶: Field for deliverableSuccessScoreRatio

deliverable_values¶: Collection for deliverableValues

description¶: Field for description

display_order¶: Field for displayOrder

display_queue_breadcrumb¶: Field for displayQueueBreadcrumb

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

done_statuses¶: Collection for doneStatuses

due_date¶: Field for dueDate

duration¶: Field for duration

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

duration_type¶: Field for durationType

duration_unit¶: Field for durationUnit

eac¶: Field for eac

eac_calculation_method¶: Field for eacCalculationMethod

enable_auto_baselines¶: Field for enableAutoBaselines

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

estimate¶: Field for estimate

exchange_rate¶: Reference for exchangeRate

exchange_rates¶: Collection for exchangeRates

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

filter_hour_types¶: Field for filterHourTypes

finance_last_update_date¶: Field for financeLastUpdateDate

first_response¶: Field for firstResponse

fixed_cost¶: Field for fixedCost

fixed_end_date¶: Field for fixedEndDate

fixed_revenue¶: Field for fixedRevenue

fixed_start_date¶: Field for fixedStartDate

group¶: Reference for group

group_id¶: Field for groupID

handoff_date¶: Field for handoffDate

has_budget_conflict¶: Field for hasBudgetConflict

has_calc_error¶: Field for hasCalcError

has_completion_constraint¶: Field for hasCompletionConstraint

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

has_rate_override¶: Field for hasRateOverride

has_resolvables¶: Field for hasResolvables

has_start_constraint¶: Field for hasStartConstraint

has_timed_notifications¶: Field for hasTimedNotifications

has_timeline_exception¶: Field for hasTimelineException

hour_types¶: Collection for hourTypes

hours¶: Collection for hours

hours_per_point¶: Field for hoursPerPoint

how_old¶: Field for howOld

indent¶: Field for indent

is_agile¶: Field for isAgile

is_complete¶: Field for isComplete

is_critical¶: Field for isCritical

is_duration_locked¶: Field for isDurationLocked

is_help_desk¶: Field for isHelpDesk

is_in_my_approvals(object_type=None, object_id=None)¶

The isInMyApprovals action.

Parameters:	object_type – objectType (type: `string`) object_id – objectID (type: `string`)
Returns:	`java.lang.Boolean`

is_in_my_submitted_approvals(object_type=None, object_id=None)¶

The isInMySubmittedApprovals action.

Parameters:	object_type – objectType (type: `string`) object_id – objectID (type: `string`)
Returns:	`java.lang.Boolean`

is_leveling_excluded¶: Field for isLevelingExcluded

is_project_dead¶: Field for isProjectDead

is_ready¶: Field for isReady

is_status_complete¶: Field for isStatusComplete

is_work_required_locked¶: Field for isWorkRequiredLocked

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

last_calc_date¶: Field for lastCalcDate

last_condition_note¶: Reference for lastConditionNote

last_condition_note_id¶: Field for lastConditionNoteID

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_mode¶: Field for levelingMode

leveling_start_delay¶: Field for levelingStartDelay

leveling_start_delay_expression¶: Field for levelingStartDelayExpression

leveling_start_delay_minutes¶: Field for levelingStartDelayMinutes

lucid_migration_date¶: Field for lucidMigrationDate

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

milestone¶: Reference for milestone

milestone_id¶: Field for milestoneID

milestone_path¶: Reference for milestonePath

milestone_path_id¶: Field for milestonePathID

name¶: Field for name

next_auto_baseline_date¶: Field for nextAutoBaselineDate

notification_records¶: Collection for notificationRecords

number_of_children¶: Field for numberOfChildren

number_open_op_tasks¶: Field for numberOpenOpTasks

object_categories¶: Collection for objectCategories

olv¶: Field for olv

op_task_type¶: Field for opTaskType

op_task_type_label¶: Field for opTaskTypeLabel

op_tasks¶: Collection for opTasks

open_op_tasks¶: Collection for openOpTasks

optimization_score¶: Field for optimizationScore

original_duration¶: Field for originalDuration

original_work_required¶: Field for originalWorkRequired

owner¶: Reference for owner

owner_id¶: Field for ownerID

owner_privileges¶: Field for ownerPrivileges

parameter_values¶: Collection for parameterValues

parent¶: Reference for parent

parent_id¶: Field for parentID

parent_lag¶: Field for parentLag

parent_lag_type¶: Field for parentLagType

pending_calculation¶: Field for pendingCalculation

pending_predecessors¶: Field for pendingPredecessors

pending_update_methods¶: Field for pendingUpdateMethods

percent_complete¶: Field for percentComplete

performance_index_method¶: Field for performanceIndexMethod

personal¶: Field for personal

planned_benefit¶: Field for plannedBenefit

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_date_alignment¶: Field for plannedDateAlignment

planned_duration¶: Field for plannedDuration

planned_duration_minutes¶: Field for plannedDurationMinutes

planned_expense_cost¶: Field for plannedExpenseCost

planned_hours_alignment¶: Field for plannedHoursAlignment

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

planned_risk_cost¶: Field for plannedRiskCost

planned_start_date¶: Field for plannedStartDate

planned_value¶: Field for plannedValue

pop_account¶: Reference for popAccount

pop_account_id¶: Field for popAccountID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

portfolio_priority¶: Field for portfolioPriority

predecessor_expression¶: Field for predecessorExpression

predecessors¶: Collection for predecessors

previous_status¶: Field for previousStatus

primary_assignment¶: Reference for primaryAssignment

priority¶: Field for priority

program¶: Reference for program

program_id¶: Field for programID

progress_status¶: Field for progressStatus

project¶: Reference for project

project_id¶: Field for projectID

project_user_roles¶: Collection for projectUserRoles

project_users¶: Collection for projectUsers

projected_completion_date¶: Field for projectedCompletionDate

projected_duration_minutes¶: Field for projectedDurationMinutes

projected_start_date¶: Field for projectedStartDate

queue_def¶: Reference for queueDef

queue_def_id¶: Field for queueDefID

queue_topic¶: Reference for queueTopic

queue_topic_breadcrumb¶: Field for queueTopicBreadcrumb

queue_topic_id¶: Field for queueTopicID

rates¶: Collection for rates

recurrence_number¶: Field for recurrenceNumber

recurrence_rule¶: Reference for recurrenceRule

recurrence_rule_id¶: Field for recurrenceRuleID

reference_number¶: Field for referenceNumber

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

remaining_cost¶: Field for remainingCost

remaining_duration_minutes¶: Field for remainingDurationMinutes

remaining_revenue¶: Field for remainingRevenue

remaining_risk_cost¶: Field for remainingRiskCost

reserved_time¶: Reference for reservedTime

reserved_time_id¶: Field for reservedTimeID

resolution_time¶: Field for resolutionTime

resolvables¶: Collection for resolvables

resolve_op_task¶: Reference for resolveOpTask

resolve_op_task_id¶: Field for resolveOpTaskID

resolve_project¶: Reference for resolveProject

resolve_project_id¶: Field for resolveProjectID

resolve_task¶: Reference for resolveTask

resolve_task_id¶: Field for resolveTaskID

resolving_obj_code¶: Field for resolvingObjCode

resolving_obj_id¶: Field for resolvingObjID

resource_allocations¶: Collection for resourceAllocations

resource_pool¶: Reference for resourcePool

resource_pool_id¶: Field for resourcePoolID

resource_scope¶: Field for resourceScope

revenue_type¶: Field for revenueType

risk¶: Field for risk

risk_performance_index¶: Field for riskPerformanceIndex

risks¶: Collection for risks

roi¶: Field for roi

role¶: Reference for role

role_id¶: Field for roleID

roles¶: Collection for roles

routing_rules¶: Collection for routingRules

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

schedule_mode¶: Field for scheduleMode

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

selected_on_portfolio_optimizer¶: Field for selectedOnPortfolioOptimizer

severity¶: Field for severity

sharing_settings¶: Reference for sharingSettings

show_commit_date¶: Field for showCommitDate

show_condition¶: Field for showCondition

show_status¶: Field for showStatus

slack_date¶: Field for slackDate

source_obj_code¶: Field for sourceObjCode

source_obj_id¶: Field for sourceObjID

source_task¶: Reference for sourceTask

source_task_id¶: Field for sourceTaskID

spi¶: Field for spi

sponsor¶: Reference for sponsor

sponsor_id¶: Field for sponsorID

status¶: Field for status

status_equates_with¶: Field for statusEquatesWith

status_update¶: Field for statusUpdate

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

successors¶: Collection for successors

summary_completion_type¶: Field for summaryCompletionType

task_constraint¶: Field for taskConstraint

task_number¶: Field for taskNumber

task_number_predecessor_string¶: Field for taskNumberPredecessorString

tasks¶: Collection for tasks

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

timeline_exception_info¶: Field for timelineExceptionInfo

total_hours¶: Field for totalHours

total_op_task_count¶: Field for totalOpTaskCount

total_task_count¶: Field for totalTaskCount

tracking_mode¶: Field for trackingMode

update_type¶: Field for updateType

updates¶: Collection for updates

url¶: Field for URL

url_¶: Field for url

version¶: Field for version

wbs¶: Field for wbs

work¶: Field for work

work_item¶: Reference for workItem

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

work_unit¶: Field for workUnit

class workfront.versions.unsupported.ApprovalPath(session=None, **fields)¶

Object for ARVPTH

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_steps¶: Collection for approvalSteps

customer¶: Reference for customer

customer_id¶: Field for customerID

duration_minutes¶: Field for durationMinutes

duration_unit¶: Field for durationUnit

rejected_status¶: Field for rejectedStatus

rejected_status_label¶: Field for rejectedStatusLabel

should_create_issue¶: Field for shouldCreateIssue

target_status¶: Field for targetStatus

target_status_label¶: Field for targetStatusLabel

class workfront.versions.unsupported.ApprovalProcess(session=None, **fields)¶

Object for ARVPRC

accessor_ids¶: Field for accessorIDs

approval_obj_code¶: Field for approvalObjCode

approval_paths¶: Collection for approvalPaths

approval_statuses¶: Field for approvalStatuses

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

duration_minutes¶: Field for durationMinutes

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

is_private¶: Field for isPrivate

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

class workfront.versions.unsupported.ApprovalProcessAttachable(session=None, **fields)¶

Object for APRPROCATCH

allowed_actions¶: Field for allowedActions

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approver_statuses¶: Collection for approverStatuses

category¶: Reference for category

category_id¶: Field for categoryID

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

force_edit¶: Field for forceEdit

object_categories¶: Collection for objectCategories

parameter_values¶: Collection for parameterValues

previous_status¶: Field for previousStatus

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

class workfront.versions.unsupported.ApprovalStep(session=None, **fields)¶

Object for ARVSTP

approval_path¶: Reference for approvalPath

approval_path_id¶: Field for approvalPathID

approval_type¶: Field for approvalType

customer¶: Reference for customer

customer_id¶: Field for customerID

name¶: Field for name

sequence_number¶: Field for sequenceNumber

step_approvers¶: Collection for stepApprovers

class workfront.versions.unsupported.ApproverStatus(session=None, **fields)¶

Object for ARVSTS

approvable_obj_code¶: Field for approvableObjCode

approvable_obj_id¶: Field for approvableObjID

approval_step¶: Reference for approvalStep

approval_step_id¶: Field for approvalStepID

approved_by¶: Reference for approvedBy

approved_by_id¶: Field for approvedByID

customer¶: Reference for customer

customer_id¶: Field for customerID

delegate_user¶: Reference for delegateUser

delegate_user_id¶: Field for delegateUserID

is_overridden¶: Field for isOverridden

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

overridden_user¶: Reference for overriddenUser

overridden_user_id¶: Field for overriddenUserID

project¶: Reference for project

project_id¶: Field for projectID

status¶: Field for status

step_approver¶: Reference for stepApprover

step_approver_id¶: Field for stepApproverID

task¶: Reference for task

task_id¶: Field for taskID

wildcard_user¶: Reference for wildcardUser

wildcard_user_id¶: Field for wildcardUserID

class workfront.versions.unsupported.Assignment(session=None, **fields)¶

Object for ASSGN

accessor_ids¶: Field for accessorIDs

actual_work_completed¶: Field for actualWorkCompleted

actual_work_per_day_start_date¶: Field for actualWorkPerDayStartDate

assigned_by¶: Reference for assignedBy

assigned_by_id¶: Field for assignedByID

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignment_percent¶: Field for assignmentPercent

avg_work_per_day¶: Field for avgWorkPerDay

customer¶: Reference for customer

customer_id¶: Field for customerID

feedback_status¶: Field for feedbackStatus

is_primary¶: Field for isPrimary

is_team_assignment¶: Field for isTeamAssignment

olv¶: Field for olv

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

planned_user_allocation_percentage¶: Field for plannedUserAllocationPercentage

project¶: Reference for project

project_id¶: Field for projectID

projected_avg_work_per_day¶: Field for projectedAvgWorkPerDay

projected_user_allocation_percentage¶: Field for projectedUserAllocationPercentage

role¶: Reference for role

role_id¶: Field for roleID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

status¶: Field for status

task¶: Reference for task

task_id¶: Field for taskID

team¶: Reference for team

team_id¶: Field for teamID

work¶: Field for work

work_item¶: Reference for workItem

work_required¶: Field for workRequired

work_unit¶: Field for workUnit

class workfront.versions.unsupported.AuditLoginAsSession(session=None, **fields)¶

Object for AUDS

action_count¶: Field for actionCount

all_accessed_users()¶

The allAccessedUsers action.

Returns:	`map`

all_admins()¶

The allAdmins action.

Returns:	`map`

audit_session(user_id=None, target_user_id=None)¶

The auditSession action.

Parameters:	user_id – userID (type: `string`) target_user_id – targetUserID (type: `string`)
Returns:	`string`

customer¶: Reference for customer

customer_id¶: Field for customerID

end_audit(session_id=None)¶

The endAudit action.

Parameters:	session_id – sessionID (type: `string`)

end_date¶: Field for endDate

get_accessed_users(user_id=None)¶

The getAccessedUsers action.

Parameters:	user_id – userID (type: `string`)
Returns:	`map`

journal_entries¶: Collection for journalEntries

note_count¶: Field for noteCount

notes¶: Collection for notes

session_id¶: Field for sessionID

start_date¶: Field for startDate

target_user¶: Reference for targetUser

target_user_display¶: Field for targetUserDisplay

target_user_id¶: Field for targetUserID

user¶: Reference for user

user_display¶: Field for userDisplay

user_id¶: Field for userID

who_accessed_user(user_id=None)¶

The whoAccessedUser action.

Parameters:	user_id – userID (type: `string`)
Returns:	`map`

class workfront.versions.unsupported.Authentication(session=None, **fields)¶

Object for AUTH

create_public_session()¶

The createPublicSession action.

Returns:	`map`

create_schema()¶: The createSchema action.

create_session()¶

The createSession action.

Returns:	`map`

get_days_to_expiration_for_user()¶

The getDaysToExpirationForUser action.

Returns:	`java.lang.Integer`

get_password_complexity_by_token(token=None)¶

The getPasswordComplexityByToken action.

Parameters:	token – token (type: `string`)
Returns:	`string`

get_password_complexity_by_username(username=None)¶

The getPasswordComplexityByUsername action.

Parameters:	username – username (type: `string`)
Returns:	`string`

get_ssooption_by_domain(domain=None)¶

The getSSOOptionByDomain action.

Parameters:	domain – domain (type: `string`)
Returns:	`map`

get_upgrades_info()¶

The getUpgradesInfo action.

Returns:	`map`

login_with_user_name(session_id=None, username=None)¶

The loginWithUserName action.

Parameters:	session_id – sessionID (type: `string`) username – username (type: `string`)
Returns:	`map`

login_with_user_name_and_password(username=None, password=None)¶

The loginWithUserNameAndPassword action.

Parameters:	username – username (type: `string`) password – password (type: `string`)
Returns:	`map`

logout(sso_user=None, is_mobile=None)¶

The logout action.

Parameters:	sso_user – ssoUser (type: `boolean`) is_mobile – isMobile (type: `boolean`)

obj_code¶: Field for objCode

perform_upgrade()¶: The performUpgrade action.

reset_password(user_name=None, old_password=None, new_password=None)¶

The resetPassword action.

Parameters:	user_name – userName (type: `string`) old_password – oldPassword (type: `string`) new_password – newPassword (type: `string`)

reset_password_by_token(token=None, new_password=None)¶

The resetPasswordByToken action.

Parameters:	token – token (type: `string`) new_password – newPassword (type: `string`)
Returns:	`string`

upgrade_progress()¶

The upgradeProgress action.

Returns:	`map`

class workfront.versions.unsupported.Avatar(session=None, **fields)¶

Object for AVATAR

allowed_actions¶: Field for allowedActions

avatar_date¶: Field for avatarDate

avatar_download_url¶: Field for avatarDownloadURL

avatar_size¶: Field for avatarSize

avatar_x¶: Field for avatarX

avatar_y¶: Field for avatarY

crop_unsaved_avatar_file(handle=None, width=None, height=None, avatar_x=None, avatar_y=None)¶

The cropUnsavedAvatarFile action.

Parameters:	handle – handle (type: `string`) width – width (type: `int`) height – height (type: `int`) avatar_x – avatarX (type: `int`) avatar_y – avatarY (type: `int`)
Returns:	`string`

get_avatar_data(obj_code=None, obj_id=None, size=None)¶

The getAvatarData action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) size – size (type: `string`)
Returns:	`string`

get_avatar_download_url(obj_code=None, obj_id=None, size=None, no_grayscale=None, public_token=None)¶

The getAvatarDownloadURL action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) size – size (type: `string`) no_grayscale – noGrayscale (type: `boolean`) public_token – publicToken (type: `string`)
Returns:	`string`

get_avatar_file(obj_code=None, obj_id=None, size=None, no_grayscale=None)¶

The getAvatarFile action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) size – size (type: `string`) no_grayscale – noGrayscale (type: `boolean`)
Returns:	`string`

handle¶: Field for handle

resize_unsaved_avatar_file(handle=None, width=None, height=None)¶

The resizeUnsavedAvatarFile action.

Parameters:	handle – handle (type: `string`) width – width (type: `int`) height – height (type: `int`)

class workfront.versions.unsupported.AwaitingApproval(session=None, **fields)¶

Object for AWAPVL

access_request¶: Reference for accessRequest

access_request_id¶: Field for accessRequestID

approvable_id¶: Field for approvableID

approver_id¶: Field for approverID

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_id¶: Field for documentID

entry_date¶: Field for entryDate

get_my_awaiting_approvals_count()¶

The getMyAwaitingApprovalsCount action.

Returns:	`java.lang.Integer`

get_my_awaiting_approvals_filtered_count(object_type=None)¶

The getMyAwaitingApprovalsFilteredCount action.

Parameters:	object_type – objectType (type: `string`)
Returns:	`java.lang.Integer`

get_my_submitted_awaiting_approvals_count()¶

The getMySubmittedAwaitingApprovalsCount action.

Returns:	`java.lang.Integer`

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

project¶: Reference for project

project_id¶: Field for projectID

role¶: Reference for role

role_id¶: Field for roleID

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

task¶: Reference for task

task_id¶: Field for taskID

team¶: Reference for team

team_id¶: Field for teamID

timesheet¶: Reference for timesheet

timesheet_id¶: Field for timesheetID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.BackgroundJob(session=None, **fields)¶

Object for BKGJOB

access_count¶: Field for accessCount

cache_key¶: Field for cacheKey

can_enqueue_export()¶

The canEnqueueExport action.

Returns:	`java.lang.Boolean`

changed_objects¶: Field for changedObjects

customer¶: Reference for customer

customer_id¶: Field for customerID

end_date¶: Field for endDate

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

error_message¶: Field for errorMessage

expiration_date¶: Field for expirationDate

file_for_completed_job(increase_access_count=None)¶

The fileForCompletedJob action.

Parameters:	increase_access_count – increaseAccessCount (type: `boolean`)
Returns:	`string`

handler_class_name¶: Field for handlerClassName

max_progress¶: Field for maxProgress

migrate_journal_field_wild_card()¶

The migrateJournalFieldWildCard action.

Returns:	`string`

migrate_ppmto_anaconda()¶

The migratePPMToAnaconda action.

Returns:	`string`

percent_complete¶: Field for percentComplete

progress¶: Field for progress

progress_text¶: Field for progressText

running_jobs_count(handler_class_name=None)¶

The runningJobsCount action.

Parameters:	handler_class_name – handlerClassName (type: `string`)
Returns:	`java.lang.Integer`

start_date¶: Field for startDate

start_kick_start_download(export_object_map=None, objcodes=None, exclude_demo_data=None, new_ooxmlformat=None, populate_existing_data=None)¶

The startKickStartDownload action.

Parameters:	export_object_map – exportObjectMap (type: `map`) objcodes – objcodes (type: `string[]`) exclude_demo_data – excludeDemoData (type: `boolean`) new_ooxmlformat – newOOXMLFormat (type: `boolean`) populate_existing_data – populateExistingData (type: `boolean`)
Returns:	`string`

status¶: Field for status

class workfront.versions.unsupported.Baseline(session=None, **fields)¶

Object for BLIN

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration_minutes¶: Field for actualDurationMinutes

actual_start_date¶: Field for actualStartDate

actual_work_required¶: Field for actualWorkRequired

auto_generated¶: Field for autoGenerated

baseline_tasks¶: Collection for baselineTasks

budget¶: Field for budget

condition¶: Field for condition

cpi¶: Field for cpi

csi¶: Field for csi

customer¶: Reference for customer

customer_id¶: Field for customerID

duration_minutes¶: Field for durationMinutes

eac¶: Field for eac

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

is_default¶: Field for isDefault

name¶: Field for name

percent_complete¶: Field for percentComplete

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_start_date¶: Field for plannedStartDate

progress_status¶: Field for progressStatus

project¶: Reference for project

project_id¶: Field for projectID

projected_completion_date¶: Field for projectedCompletionDate

projected_start_date¶: Field for projectedStartDate

spi¶: Field for spi

work_required¶: Field for workRequired

class workfront.versions.unsupported.BaselineTask(session=None, **fields)¶

Object for BSTSK

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration_minutes¶: Field for actualDurationMinutes

actual_start_date¶: Field for actualStartDate

actual_work_required¶: Field for actualWorkRequired

baseline¶: Reference for baseline

baseline_id¶: Field for baselineID

cpi¶: Field for cpi

csi¶: Field for csi

customer¶: Reference for customer

customer_id¶: Field for customerID

duration_minutes¶: Field for durationMinutes

duration_unit¶: Field for durationUnit

eac¶: Field for eac

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

is_default¶: Field for isDefault

name¶: Field for name

percent_complete¶: Field for percentComplete

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_start_date¶: Field for plannedStartDate

progress_status¶: Field for progressStatus

projected_completion_date¶: Field for projectedCompletionDate

projected_start_date¶: Field for projectedStartDate

spi¶: Field for spi

task¶: Reference for task

task_id¶: Field for taskID

work_required¶: Field for workRequired

class workfront.versions.unsupported.BillingRecord(session=None, **fields)¶

Object for BILL

accessor_ids¶: Field for accessorIDs

amount¶: Field for amount

billable_tasks¶: Collection for billableTasks

billing_date¶: Field for billingDate

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_name¶: Field for displayName

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

hours¶: Collection for hours

invoice_id¶: Field for invoiceID

other_amount¶: Field for otherAmount

po_number¶: Field for poNumber

project¶: Reference for project

project_id¶: Field for projectID

status¶: Field for status

class workfront.versions.unsupported.Branding(session=None, **fields)¶

Object for BRND

customer¶: Reference for customer

customer_id¶: Field for customerID

details¶: Field for details

last_update_date¶: Field for lastUpdateDate

class workfront.versions.unsupported.BurndownEvent(session=None, **fields)¶

Object for BDNEVT

apply_date¶: Field for applyDate

burndown_obj_code¶: Field for burndownObjCode

burndown_obj_id¶: Field for burndownObjID

customer¶: Reference for customer

customer_id¶: Field for customerID

delta_points_complete¶: Field for deltaPointsComplete

delta_total_items¶: Field for deltaTotalItems

delta_total_points¶: Field for deltaTotalPoints

entry_date¶: Field for entryDate

event_obj_code¶: Field for eventObjCode

event_obj_id¶: Field for eventObjID

is_complete¶: Field for isComplete

class workfront.versions.unsupported.CalendarEvent(session=None, **fields)¶

Object for CALEVT

calendar_section¶: Reference for calendarSection

calendar_section_id¶: Field for calendarSectionID

color¶: Field for color

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

end_date¶: Field for endDate

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

name¶: Field for name

start_date¶: Field for startDate

class workfront.versions.unsupported.CalendarFeedEntry(session=None, **fields)¶

Object for CALITM

allowed_actions¶: Field for allowedActions

assigned_to_id¶: Field for assignedToID

assigned_to_name¶: Field for assignedToName

assigned_to_title¶: Field for assignedToTitle

calendar_event¶: Reference for calendarEvent

calendar_event_id¶: Field for calendarEventID

calendar_section_ids¶: Field for calendarSectionIDs

color¶: Field for color

due_date¶: Field for dueDate

end_date¶: Field for endDate

obj_code¶: Field for objCode

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

percent_complete¶: Field for percentComplete

project¶: Reference for project

project_display_name¶: Field for projectDisplayName

project_id¶: Field for projectID

ref_name¶: Field for refName

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

start_date¶: Field for startDate

status¶: Field for status

task¶: Reference for task

task_id¶: Field for taskID

class workfront.versions.unsupported.CalendarInfo(session=None, **fields)¶

Object for CALEND

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

calendar_sections¶: Collection for calendarSections

create_first_calendar()¶

The createFirstCalendar action.

Returns:	`string`

create_project_section(project_id=None, color=None)¶

The createProjectSection action.

Parameters:	project_id – projectID (type: `string`) color – color (type: `string`)
Returns:	`string`

customer¶: Reference for customer

customer_id¶: Field for customerID

is_public¶: Field for isPublic

name¶: Field for name

public_token¶: Field for publicToken

run_as_user¶: Reference for runAsUser

run_as_user_id¶: Field for runAsUserID

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.CalendarPortalSection(session=None, **fields)¶

Object for CALPTL

calendar_info¶: Reference for calendarInfo

calendar_info_id¶: Field for calendarInfoID

customer¶: Reference for customer

customer_id¶: Field for customerID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

class workfront.versions.unsupported.CalendarSection(session=None, **fields)¶

Object for CALSEC

cal_events¶: Field for calEvents

calendar¶: Reference for calendar

calendar_events¶: Collection for calendarEvents

calendar_id¶: Field for calendarID

callable_expressions¶: Collection for callableExpressions

color¶: Field for color

customer¶: Reference for customer

customer_id¶: Field for customerID

duration¶: Field for duration

filters¶: Collection for filters

get_concatenated_expression_form(expression=None)¶

The getConcatenatedExpressionForm action.

Parameters:	expression – expression (type: `string`)
Returns:	`string`

get_pretty_expression_form(expression=None)¶

The getPrettyExpressionForm action.

Parameters:	expression – expression (type: `string`)
Returns:	`string`

milestone¶: Field for milestone

name¶: Field for name

planned_date¶: Field for plannedDate

start_date¶: Field for startDate

class workfront.versions.unsupported.CallableExpression(session=None, **fields)¶

Object for CALEXP

customer¶: Reference for customer

customer_id¶: Field for customerID

expression¶: Field for expression

ui_obj_code¶: Field for uiObjCode

validate_callable_expression(custom_expression=None)¶

The validateCallableExpression action.

Parameters:	custom_expression – customExpression (type: `string`)

class workfront.versions.unsupported.Category(session=None, **fields)¶

Object for CTGY

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

assign_categories(obj_id=None, obj_code=None, category_ids=None)¶

The assignCategories action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`) category_ids – categoryIDs (type: `string[]`)

assign_category(obj_id=None, obj_code=None, category_id=None)¶

The assignCategory action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`) category_id – categoryID (type: `string`)

calculate_data_extension()¶: The calculateDataExtension action.

cat_obj_code¶: Field for catObjCode

category_access_rules¶: Collection for categoryAccessRules

category_cascade_rules¶: Collection for categoryCascadeRules

category_parameters¶: Collection for categoryParameters

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

ext_ref_id¶: Field for extRefID

get_expression_types()¶

The getExpressionTypes action.

Returns:	`map`

get_filtered_categories(obj_code=None, object_id=None, object_map=None)¶

The getFilteredCategories action.

Parameters:	obj_code – objCode (type: `string`) object_id – objectID (type: `string`) object_map – objectMap (type: `map`)
Returns:	`string[]`

get_formula_calculated_expression(custom_expression=None)¶

The getFormulaCalculatedExpression action.

Parameters:	custom_expression – customExpression (type: `string`)
Returns:	`string`

get_friendly_calculated_expression(custom_expression=None)¶

The getFriendlyCalculatedExpression action.

Parameters:	custom_expression – customExpression (type: `string`)
Returns:	`string`

group¶: Reference for group

group_id¶: Field for groupID

has_calculated_fields¶: Field for hasCalculatedFields

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

other_groups¶: Collection for otherGroups

reorder_categories(obj_id=None, obj_code=None, category_ids=None)¶

The reorderCategories action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`) category_ids – categoryIDs (type: `string[]`)

unassign_categories(obj_id=None, obj_code=None, category_ids=None)¶

The unassignCategories action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`) category_ids – categoryIDs (type: `string[]`)

unassign_category(obj_id=None, obj_code=None, category_id=None)¶

The unassignCategory action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`) category_id – categoryID (type: `string`)

update_calculated_parameter_values(category_id=None, parameter_ids=None, should_auto_commit=None)¶

The updateCalculatedParameterValues action.

Parameters:	category_id – categoryID (type: `string`) parameter_ids – parameterIDs (type: `string[]`) should_auto_commit – shouldAutoCommit (type: `boolean`)

validate_custom_expression(cat_obj_code=None, custom_expression=None)¶

The validateCustomExpression action.

Parameters:	cat_obj_code – catObjCode (type: `string`) custom_expression – customExpression (type: `string`)

class workfront.versions.unsupported.CategoryAccessRule(session=None, **fields)¶

Object for CATACR

accessor_id¶: Field for accessorID

accessor_obj_code¶: Field for accessorObjCode

category¶: Reference for category

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

class workfront.versions.unsupported.CategoryCascadeRule(session=None, **fields)¶

Object for CTCSRL

category¶: Reference for category

category_cascade_rule_matches¶: Collection for categoryCascadeRuleMatches

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

next_parameter¶: Reference for nextParameter

next_parameter_group¶: Reference for nextParameterGroup

next_parameter_group_id¶: Field for nextParameterGroupID

next_parameter_id¶: Field for nextParameterID

otherwise_parameter¶: Reference for otherwiseParameter

otherwise_parameter_id¶: Field for otherwiseParameterID

rule_type¶: Field for ruleType

to_end_of_form¶: Field for toEndOfForm

class workfront.versions.unsupported.CategoryCascadeRuleMatch(session=None, **fields)¶

Object for CTCSRM

category_cascade_rule¶: Reference for categoryCascadeRule

category_cascade_rule_id¶: Field for categoryCascadeRuleID

customer¶: Reference for customer

customer_id¶: Field for customerID

match_type¶: Field for matchType

parameter¶: Reference for parameter

parameter_id¶: Field for parameterID

value¶: Field for value

class workfront.versions.unsupported.CategoryParameter(session=None, **fields)¶

Object for CTGYPA

category¶: Reference for category

category_id¶: Field for categoryID

category_parameter_expression¶: Reference for categoryParameterExpression

custom_expression¶: Field for customExpression

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

is_invalid_expression¶: Field for isInvalidExpression

is_journaled¶: Field for isJournaled

is_required¶: Field for isRequired

parameter¶: Reference for parameter

parameter_group¶: Reference for parameterGroup

parameter_group_id¶: Field for parameterGroupID

parameter_id¶: Field for parameterID

row_shared¶: Field for rowShared

security_level¶: Field for securityLevel

update_calculated_values¶: Field for updateCalculatedValues

view_security_level¶: Field for viewSecurityLevel

class workfront.versions.unsupported.CategoryParameterExpression(session=None, **fields)¶

Object for CTGPEX

category_parameter¶: Reference for categoryParameter

custom_expression¶: Field for customExpression

customer¶: Reference for customer

customer_id¶: Field for customerID

has_finance_fields¶: Field for hasFinanceFields

class workfront.versions.unsupported.Company(session=None, **fields)¶

Object for CMPY

add_early_access(ids=None)¶

The addEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

default_interface¶: Field for defaultInterface

delete_early_access(ids=None)¶

The deleteEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

has_rate_override¶: Field for hasRateOverride

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

is_primary¶: Field for isPrimary

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

object_categories¶: Collection for objectCategories

parameter_values¶: Collection for parameterValues

rates¶: Collection for rates

class workfront.versions.unsupported.ComponentKey(session=None, **fields)¶

Object for CMPSRV

component_key¶: Field for componentKey

name¶: Field for name

class workfront.versions.unsupported.CustomEnum(session=None, **fields)¶

Object for CSTEM

color¶: Field for color

custom_enum_orders¶: Collection for customEnumOrders

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

enum_class¶: Field for enumClass

equates_with¶: Field for equatesWith

ext_ref_id¶: Field for extRefID

get_default_op_task_priority_enum()¶

The getDefaultOpTaskPriorityEnum action.

Returns:	`java.lang.Integer`

get_default_project_status_enum()¶

The getDefaultProjectStatusEnum action.

Returns:	`string`

get_default_severity_enum()¶

The getDefaultSeverityEnum action.

Returns:	`java.lang.Integer`

get_default_task_priority_enum()¶

The getDefaultTaskPriorityEnum action.

Returns:	`java.lang.Integer`

get_enum_color(enum_class=None, enum_obj_code=None, value=None)¶

The getEnumColor action.

Parameters:	enum_class – enumClass (type: `string`) enum_obj_code – enumObjCode (type: `string`) value – value (type: `string`)
Returns:	`string`

is_primary¶: Field for isPrimary

label¶: Field for label

set_custom_enums(type=None, custom_enums=None, replace_with_key_values=None)¶

The setCustomEnums action.

Parameters:	type – type (type: `string`) custom_enums – customEnums (type: `string[]`) replace_with_key_values – replaceWithKeyValues (type: `map`)
Returns:	`map`

value¶: Field for value

value_as_int¶: Field for valueAsInt

value_as_string¶: Field for valueAsString

class workfront.versions.unsupported.CustomEnumOrder(session=None, **fields)¶

Object for CSTEMO

custom_enum¶: Reference for customEnum

custom_enum_id¶: Field for customEnumID

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

is_hidden¶: Field for isHidden

sub_obj_code¶: Field for subObjCode

class workfront.versions.unsupported.CustomMenu(session=None, **fields)¶

Object for CSTMNU

children_menus¶: Collection for childrenMenus

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

is_parent¶: Field for isParent

label¶: Field for label

menu_obj_code¶: Field for menuObjCode

obj_id¶: Field for objID

obj_interface¶: Field for objInterface

portal_profile¶: Reference for portalProfile

target_external_section¶: Reference for targetExternalSection

target_external_section_id¶: Field for targetExternalSectionID

target_obj_code¶: Field for targetObjCode

target_obj_id¶: Field for targetObjID

target_portal_section¶: Reference for targetPortalSection

target_portal_section_id¶: Field for targetPortalSectionID

target_portal_tab¶: Reference for targetPortalTab

target_portal_tab_id¶: Field for targetPortalTabID

window¶: Field for window

class workfront.versions.unsupported.CustomMenuCustomMenu(session=None, **fields)¶

Object for CMSCMS

child¶: Reference for child

child_id¶: Field for childID

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

parent¶: Reference for parent

parent_id¶: Field for parentID

class workfront.versions.unsupported.CustomQuarter(session=None, **fields)¶

Object for CSTQRT

customer¶: Reference for customer

customer_id¶: Field for customerID

end_date¶: Field for endDate

quarter_label¶: Field for quarterLabel

start_date¶: Field for startDate

class workfront.versions.unsupported.Customer(session=None, **fields)¶

Object for CUST

accept_license_agreement()¶: The acceptLicenseAgreement action.

access_levels¶: Collection for accessLevels

access_rules_per_object_limit¶: Field for accessRulesPerObjectLimit

access_scopes¶: Collection for accessScopes

account_rep¶: Reference for accountRep

account_rep_id¶: Field for accountRepID

account_representative¶: Field for accountRepresentative

address¶: Field for address

address2¶: Field for address2

admin_acct_name¶: Field for adminAcctName

admin_acct_password¶: Field for adminAcctPassword

admin_user¶: Reference for adminUser

admin_user_id¶: Field for adminUserID

api_concurrency_limit¶: Field for apiConcurrencyLimit

app_events¶: Collection for appEvents

approval_processes¶: Collection for approvalProcesses

biz_rule_exclusions¶: Field for bizRuleExclusions

categories¶: Collection for categories

check_license_expiration()¶

The checkLicenseExpiration action.

Returns:	`java.lang.Integer`

city¶: Field for city

cloneable¶: Field for cloneable

country¶: Field for country

currency¶: Field for currency

custom_enum_types¶: Field for customEnumTypes

custom_enums¶: Collection for customEnums

custom_menus¶: Collection for customMenus

custom_quarters¶: Collection for customQuarters

custom_tabs¶: Collection for customTabs

customer_config_map¶: Reference for customerConfigMap

customer_config_map_id¶: Field for customerConfigMapID

customer_prefs¶: Collection for customerPrefs

customer_urlconfig_map¶: Reference for customerURLConfigMap

customer_urlconfig_map_id¶: Field for customerURLConfigMapID

dd_svnversion¶: Field for ddSVNVersion

demo_baseline_date¶: Field for demoBaselineDate

description¶: Field for description

disabled_date¶: Field for disabledDate

document_requests¶: Collection for documentRequests

document_size¶: Field for documentSize

documents¶: Collection for documents

domain¶: Field for domain

email_addr¶: Field for emailAddr

email_templates¶: Collection for emailTemplates

entry_date¶: Field for entryDate

eval_exp_date¶: Field for evalExpDate

event_handlers¶: Collection for eventHandlers

exp_date¶: Field for expDate

expense_types¶: Collection for expenseTypes

ext_ref_id¶: Field for extRefID

external_document_storage¶: Field for externalDocumentStorage

external_sections¶: Collection for externalSections

external_users_enabled¶: Field for externalUsersEnabled

external_users_group¶: Reference for externalUsersGroup

external_users_group_id¶: Field for externalUsersGroupID

extra_document_storage¶: Field for extraDocumentStorage

finance_representative¶: Field for financeRepresentative

firstname¶: Field for firstname

full_users¶: Field for fullUsers

get_license_info()¶

The getLicenseInfo action.

Returns:	`map`

golden¶: Field for golden

groups¶: Collection for groups

has_documents¶: Field for hasDocuments

has_preview_access¶: Field for hasPreviewAccess

has_timed_notifications¶: Field for hasTimedNotifications

help_desk_config_map¶: Reference for helpDeskConfigMap

help_desk_config_map_id¶: Field for helpDeskConfigMapID

hour_types¶: Collection for hourTypes

import_templates¶: Collection for importTemplates

inline_java_script_config_map¶: Reference for inlineJavaScriptConfigMap

inline_java_script_config_map_id¶: Field for inlineJavaScriptConfigMapID

installed_dditems¶: Collection for installedDDItems

ip_ranges¶: Collection for ipRanges

is_advanced_doc_mgmt_enabled¶: Field for isAdvancedDocMgmtEnabled

is_apienabled¶: Field for isAPIEnabled

is_async_reporting_enabled¶: Field for isAsyncReportingEnabled

is_biz_rule_exclusion_enabled(biz_rule=None, obj_code=None, obj_id=None)¶

The isBizRuleExclusionEnabled action.

Parameters:	biz_rule – bizRule (type: `string`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`java.lang.Boolean`

is_custom_quarter_enabled¶: Field for isCustomQuarterEnabled

is_dam_enabled¶: Field for isDamEnabled

is_disabled¶: Field for isDisabled

is_enterprise¶: Field for isEnterprise

is_migrated_to_anaconda¶: Field for isMigratedToAnaconda

is_portal_profile_migrated¶: Field for isPortalProfileMigrated

is_proofing_enabled¶: Field for isProofingEnabled

is_search_enabled¶: Field for isSearchEnabled

is_search_index_active¶: Field for isSearchIndexActive

is_soapenabled¶: Field for isSOAPEnabled

is_ssoenabled()¶

The isSSOEnabled action.

Returns:	`java.lang.Boolean`

is_warning_disabled¶: Field for isWarningDisabled

is_white_list_ipenabled¶: Field for isWhiteListIPEnabled

is_workfront_dam_enabled¶: Field for isWorkfrontDamEnabled

journal_field_limit¶: Field for journalFieldLimit

journal_fields¶: Collection for journalFields

kick_start_expoert_dashboards_limit¶: Field for kickStartExpoertDashboardsLimit

kick_start_expoert_reports_limit¶: Field for kickStartExpoertReportsLimit

last_remind_date¶: Field for lastRemindDate

last_usage_report_date¶: Field for lastUsageReportDate

lastname¶: Field for lastname

layout_templates¶: Collection for layoutTemplates

license_orders¶: Collection for licenseOrders

limited_users¶: Field for limitedUsers

list_auto_refresh_interval_seconds¶: Field for listAutoRefreshIntervalSeconds

locale¶: Field for locale

lucid_migration_date¶: Field for lucidMigrationDate

lucid_migration_mode¶: Field for lucidMigrationMode

lucid_migration_options¶: Field for lucidMigrationOptions

lucid_migration_status¶: Field for lucidMigrationStatus

lucid_migration_step¶: Field for lucidMigrationStep

migrate_to_lucid_security(migration_mode=None, migration_options=None)¶

The migrateToLucidSecurity action.

Parameters:	migration_mode – migrationMode (type: `com.attask.common.constants.LucidMigrationModeEnum`) migration_options – migrationOptions (type: `map`)
Returns:	`string`

milestone_paths¶: Collection for milestonePaths

name¶: Field for name

need_license_agreement¶: Field for needLicenseAgreement

next_usage_report_date¶: Field for nextUsageReportDate

notification_config_map¶: Reference for notificationConfigMap

notification_config_map_id¶: Field for notificationConfigMapID

on_demand_options¶: Field for onDemandOptions

op_task_count_limit¶: Field for opTaskCountLimit

parameter_groups¶: Collection for parameterGroups

parameters¶: Collection for parameters

password_config_map¶: Reference for passwordConfigMap

password_config_map_id¶: Field for passwordConfigMapID

phone_number¶: Field for phoneNumber

portal_profiles¶: Collection for portalProfiles

portal_sections¶: Collection for portalSections

portfolio_management_config_map¶: Reference for portfolioManagementConfigMap

portfolio_management_config_map_id¶: Field for portfolioManagementConfigMapID

postal_code¶: Field for postalCode

project_management_config_map¶: Reference for projectManagementConfigMap

project_management_config_map_id¶: Field for projectManagementConfigMapID

proof_account_id¶: Field for proofAccountID

query_limit¶: Field for queryLimit

record_limit¶: Field for recordLimit

requestor_users¶: Field for requestorUsers

reseller¶: Reference for reseller

reseller_id¶: Field for resellerID

reset_lucid_security_migration_progress()¶: The resetLucidSecurityMigrationProgress action.

resource_pools¶: Collection for resourcePools

revert_lucid_security_migration()¶: The revertLucidSecurityMigration action.

review_users¶: Field for reviewUsers

risk_types¶: Collection for riskTypes

roles¶: Collection for roles

sandbox_count¶: Field for sandboxCount

sandbox_refreshing¶: Field for sandboxRefreshing

schedules¶: Collection for schedules

score_cards¶: Collection for scoreCards

security_model_type¶: Field for securityModelType

set_exclusions(exclusions=None, state=None)¶

The setExclusions action.

Parameters:	exclusions – exclusions (type: `string`) state – state (type: `boolean`)

set_is_custom_quarter_enabled(is_custom_quarter_enabled=None)¶

The setIsCustomQuarterEnabled action.

Parameters:	is_custom_quarter_enabled – isCustomQuarterEnabled (type: `boolean`)

set_is_white_list_ipenabled(is_white_list_ipenabled=None)¶

The setIsWhiteListIPEnabled action.

Parameters:	is_white_list_ipenabled – isWhiteListIPEnabled (type: `boolean`)

set_lucid_migration_enabled(enabled=None)¶

The setLucidMigrationEnabled action.

Parameters:	enabled – enabled (type: `boolean`)

sso_option¶: Reference for ssoOption

sso_type¶: Field for ssoType

state¶: Field for state

status¶: Field for status

style_sheet¶: Field for styleSheet

task_count_limit¶: Field for taskCountLimit

team_users¶: Field for teamUsers

time_zone¶: Field for timeZone

timed_notifications¶: Collection for timedNotifications

timesheet_config_map¶: Reference for timesheetConfigMap

timesheet_config_map_id¶: Field for timesheetConfigMapID

trial¶: Field for trial

ui_config_map¶: Reference for uiConfigMap

ui_config_map_id¶: Field for uiConfigMapID

ui_filters¶: Collection for uiFilters

ui_group_bys¶: Collection for uiGroupBys

ui_views¶: Collection for uiViews

update_currency(base_currency=None)¶

The updateCurrency action.

Parameters:	base_currency – baseCurrency (type: `string`)

update_customer_base(time_zone=None, locale=None, admin_acct_name=None)¶

The updateCustomerBase action.

Parameters:	time_zone – timeZone (type: `string`) locale – locale (type: `string`) admin_acct_name – adminAcctName (type: `string`)

update_proofing_billing_plan(plan_id=None)¶

The updateProofingBillingPlan action.

Parameters:	plan_id – planID (type: `string`)
Returns:	`java.lang.Boolean`

usage_report_attempts¶: Field for usageReportAttempts

use_external_document_storage¶: Field for useExternalDocumentStorage

user_invite_config_map¶: Reference for userInviteConfigMap

user_invite_config_map_id¶: Field for userInviteConfigMapID

class workfront.versions.unsupported.CustomerFeedback(session=None, **fields)¶

Object for CSFD

comment¶: Field for comment

customer_guid¶: Field for customerGUID

entry_date¶: Field for entryDate

feedback_type¶: Field for feedbackType

is_admin¶: Field for isAdmin

is_primary_admin¶: Field for isPrimaryAdmin

license_type¶: Field for licenseType

score¶: Field for score

user_guid¶: Field for userGUID

class workfront.versions.unsupported.CustomerPref(session=None, **fields)¶

Object for CSTPRF

customer¶: Reference for customer

customer_id¶: Field for customerID

pref_name¶: Field for prefName

pref_value¶: Field for prefValue

class workfront.versions.unsupported.CustomerPreferences(session=None, **fields)¶

Object for CUSTPR

name¶: Field for name

obj_code¶: Field for objCode

possible_values¶: Field for possibleValues

set_preference(name=None, value=None)¶

The setPreference action.

Parameters:	name – name (type: `string`) value – value (type: `string`)

value¶: Field for value

class workfront.versions.unsupported.CustomerTimelineCalc(session=None, **fields)¶

Object for CPTC

customer¶: Reference for customer

customer_id¶: Field for customerID

olv¶: Field for olv

start_date¶: Field for startDate

timeline_calculation_status¶: Field for timelineCalculationStatus

class workfront.versions.unsupported.CustsSections(session=None, **fields)¶

Object for CSTSEC

customer¶: Reference for customer

customer_id¶: Field for customerID

section_id¶: Field for sectionID

class workfront.versions.unsupported.DocsFolders(session=None, **fields)¶

Object for DOCFLD

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_id¶: Field for documentID

folder¶: Reference for folder

folder_id¶: Field for folderID

class workfront.versions.unsupported.Document(session=None, **fields)¶

Object for DOCU

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

advanced_proofing_options¶: Field for advancedProofingOptions

approvals¶: Collection for approvals

awaiting_approvals¶: Collection for awaitingApprovals

build_download_manifest(document_idmap=None)¶

The buildDownloadManifest action.

Parameters:	document_idmap – documentIDMap (type: `map`)
Returns:	`string`

calculate_data_extension()¶: The calculateDataExtension action.

cancel_document_proof(document_version_id=None)¶

The cancelDocumentProof action.

Parameters:	document_version_id – documentVersionID (type: `string`)

category¶: Reference for category

category_id¶: Field for categoryID

check_document_tasks()¶: The checkDocumentTasks action.

check_in(document_id=None)¶

The checkIn action.

Parameters:	document_id – documentID (type: `string`)

check_out(document_id=None)¶

The checkOut action.

Parameters:	document_id – documentID (type: `string`)

checked_out_by¶: Reference for checkedOutBy

checked_out_by_id¶: Field for checkedOutByID

copy_document_to_temp_dir(document_id=None)¶

The copyDocumentToTempDir action.

Parameters:	document_id – documentID (type: `string`)
Returns:	`string`

create_document(name=None, doc_obj_code=None, doc_obj_id=None, file_handle=None, file_type=None, folder_id=None, create_proof=None, advanced_proofing_options=None)¶

The createDocument action.

Parameters:

name – name (type: string)
doc_obj_code – docObjCode (type: string)
doc_obj_id – docObjID (type: string)
file_handle – fileHandle (type: string)
file_type – fileType (type: string)
folder_id – folderID (type: string)
create_proof – createProof (type: java.lang.Boolean)
advanced_proofing_options – advancedProofingOptions (type: string)

Returns:

string

create_proof(document_version_id=None, advanced_proofing_options=None)¶

The createProof action.

Parameters:	document_version_id – documentVersionID (type: `string`) advanced_proofing_options – advancedProofingOptions (type: `string`)

create_proof_flag¶: Field for createProof

current_version¶: Reference for currentVersion

current_version_id¶: Field for currentVersionID

customer¶: Reference for customer

customer_id¶: Field for customerID

delete_document_proofs(document_id=None)¶

The deleteDocumentProofs action.

Parameters:	document_id – documentID (type: `string`)

description¶: Field for description

doc_obj_code¶: Field for docObjCode

document_provider_id¶: Field for documentProviderID

document_request¶: Reference for documentRequest

document_request_id¶: Field for documentRequestID

download_url¶: Field for downloadURL

ext_ref_id¶: Field for extRefID

external_integration_type¶: Field for externalIntegrationType

file_type¶: Field for fileType

folder_ids¶: Field for folderIDs

folders¶: Collection for folders

get_advanced_proof_options_url()¶

The getAdvancedProofOptionsURL action.

Returns:	`string`

get_document_contents_in_zip()¶

The getDocumentContentsInZip action.

Returns:	`string`

get_external_document_contents()¶

The getExternalDocumentContents action.

Returns:	`string`

get_generic_thumbnail_url(document_version_id=None)¶

The getGenericThumbnailUrl action.

Parameters:	document_version_id – documentVersionID (type: `string`)
Returns:	`string`

get_proof_details(document_version_id=None)¶

The getProofDetails action.

Parameters:	document_version_id – documentVersionID (type: `string`)
Returns:	`map`

get_proof_details_url(proof_id=None)¶

The getProofDetailsURL action.

Parameters:	proof_id – proofID (type: `string`)
Returns:	`string`

get_proof_url()¶

The getProofURL action.

Returns:	`string`

get_proof_usage()¶

The getProofUsage action.

Returns:	`map`

get_public_generic_thumbnail_url(document_version_id=None, public_token=None)¶

The getPublicGenericThumbnailUrl action.

Parameters:	document_version_id – documentVersionID (type: `string`) public_token – publicToken (type: `string`)
Returns:	`string`

get_public_thumbnail_file_path(document_version_id=None, size=None, public_token=None)¶

The getPublicThumbnailFilePath action.

Parameters:	document_version_id – documentVersionID (type: `string`) size – size (type: `string`) public_token – publicToken (type: `string`)
Returns:	`string`

get_s3document_url(content_disposition=None, external_storage_id=None, customer_prefs=None)¶

The getS3DocumentURL action.

Parameters:	content_disposition – contentDisposition (type: `string`) external_storage_id – externalStorageID (type: `string`) customer_prefs – customerPrefs (type: `map`)
Returns:	`string`

get_thumbnail_data(document_version_id=None, size=None)¶

The getThumbnailData action.

Parameters:	document_version_id – documentVersionID (type: `string`) size – size (type: `string`)
Returns:	`string`

get_thumbnail_file_path(document_version_id=None, size=None)¶

The getThumbnailFilePath action.

Parameters:	document_version_id – documentVersionID (type: `string`) size – size (type: `string`)
Returns:	`string`

get_total_size_for_documents(document_ids=None, include_linked=None)¶

The getTotalSizeForDocuments action.

Parameters:	document_ids – documentIDs (type: `string[]`) include_linked – includeLinked (type: `boolean`)
Returns:	`java.lang.Long`

groups¶: Collection for groups

handle¶: Field for handle

handle_proof_callback(callback_xml=None)¶

The handleProofCallback action.

Parameters:	callback_xml – callbackXML (type: `string`)

has_notes¶: Field for hasNotes

is_dir¶: Field for isDir

is_in_linked_folder(document_id=None)¶

The isInLinkedFolder action.

Parameters:	document_id – documentID (type: `string`)
Returns:	`java.lang.Boolean`

is_linked_document(document_id=None)¶

The isLinkedDocument action.

Parameters:	document_id – documentID (type: `string`)
Returns:	`java.lang.Boolean`

is_private¶: Field for isPrivate

is_proof_auto_genration_enabled()¶

The isProofAutoGenrationEnabled action.

Returns:	`java.lang.Boolean`

is_proofable(document_version_id=None)¶

The isProofable action.

Parameters:	document_version_id – documentVersionID (type: `string`)
Returns:	`java.lang.Boolean`

is_public¶: Field for isPublic

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

last_mod_date¶: Field for lastModDate

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_sync_date¶: Field for lastSyncDate

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

move(obj_id=None, doc_obj_code=None)¶

The move action.

Parameters:	obj_id – objID (type: `string`) doc_obj_code – docObjCode (type: `string`)

name¶: Field for name

obj_id¶: Field for objID

object_categories¶: Collection for objectCategories

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

preview_url¶: Field for previewURL

process_google_drive_change_notification(push_notification=None)¶

The processGoogleDriveChangeNotification action.

Parameters:	push_notification – pushNotification (type: `string`)

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

public_token¶: Field for publicToken

reference_number¶: Field for referenceNumber

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

reference_object_closed¶: Field for referenceObjectClosed

reference_object_name¶: Field for referenceObjectName

refresh_external_document_info(document_id=None)¶

The refreshExternalDocumentInfo action.

Parameters:	document_id – documentID (type: `string`)
Returns:	`string`

refresh_external_documents()¶: The refreshExternalDocuments action.

regenerate_box_shared_link(document_version_id=None)¶

The regenerateBoxSharedLink action.

Parameters:	document_version_id – documentVersionID (type: `string`)

release_version¶: Reference for releaseVersion

release_version_id¶: Field for releaseVersionID

remind_requestee(document_request_id=None)¶

The remindRequestee action.

Parameters:	document_request_id – documentRequestID (type: `string`)
Returns:	`string`

save_document_metadata(document_id=None)¶

The saveDocumentMetadata action.

Parameters:	document_id – documentID (type: `string`)

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

send_documents_to_external_provider(document_ids=None, provider_id=None, destination_folder_id=None)¶

The sendDocumentsToExternalProvider action.

Parameters:	document_ids – documentIDs (type: `string[]`) provider_id – providerID (type: `string`) destination_folder_id – destinationFolderID (type: `string`)

setup_google_drive_push_notifications()¶

The setupGoogleDrivePushNotifications action.

Returns:	`string`

shares¶: Collection for shares

subscribers¶: Collection for subscribers

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

top_doc_obj_code¶: Field for topDocObjCode

top_obj_id¶: Field for topObjID

unlink_documents(ids=None)¶

The unlinkDocuments action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

upload_documents(document_request_id=None, documents=None)¶

The uploadDocuments action.

Parameters:	document_request_id – documentRequestID (type: `string`) documents – documents (type: `string[]`)
Returns:	`string[]`

user¶: Reference for user

user_id¶: Field for userID

versions¶: Collection for versions

zip_document_versions()¶

The zipDocumentVersions action.

Returns:	`string`

zip_documents(obj_code=None, obj_id=None)¶

The zipDocuments action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`string`

zip_documents_versions(ids=None)¶

The zipDocumentsVersions action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`string`

class workfront.versions.unsupported.DocumentApproval(session=None, **fields)¶

Object for DOCAPL

approval_date¶: Field for approvalDate

approver¶: Reference for approver

approver_id¶: Field for approverID

auto_document_share¶: Reference for autoDocumentShare

auto_document_share_id¶: Field for autoDocumentShareID

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_id¶: Field for documentID

note¶: Reference for note

note_id¶: Field for noteID

notify_approver(id=None)¶

The notifyApprover action.

Parameters:	id – ID (type: `string`)

request_date¶: Field for requestDate

requestor¶: Reference for requestor

requestor_id¶: Field for requestorID

status¶: Field for status

class workfront.versions.unsupported.DocumentFolder(session=None, **fields)¶

Object for DOCFDR

accessor_ids¶: Field for accessorIDs

children¶: Collection for children

customer¶: Reference for customer

customer_id¶: Field for customerID

delete_folders_and_contents(document_folder_id=None, obj_code=None, object_id=None)¶

The deleteFoldersAndContents action.

Parameters:	document_folder_id – documentFolderID (type: `string`) obj_code – objCode (type: `string`) object_id – objectID (type: `string`)
Returns:	`string`

documents¶: Collection for documents

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

get_folder_size_in_bytes(folder_id=None, recursive=None, include_linked=None)¶

The getFolderSizeInBytes action.

Parameters:	folder_id – folderID (type: `string`) recursive – recursive (type: `boolean`) include_linked – includeLinked (type: `boolean`)
Returns:	`java.lang.Long`

get_linked_folder_meta_data(linked_folder_id=None)¶

The getLinkedFolderMetaData action.

Parameters:	linked_folder_id – linkedFolderID (type: `string`)
Returns:	`string`

is_linked_folder(document_folder_id=None)¶

The isLinkedFolder action.

Parameters:	document_folder_id – documentFolderID (type: `string`)
Returns:	`java.lang.Boolean`

is_smart_folder(document_folder_id=None)¶

The isSmartFolder action.

Parameters:	document_folder_id – documentFolderID (type: `string`)
Returns:	`java.lang.Boolean`

issue¶: Reference for issue

issue_id¶: Field for issueID

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

last_mod_date¶: Field for lastModDate

linked_folder¶: Reference for linkedFolder

linked_folder_id¶: Field for linkedFolderID

name¶: Field for name

parent¶: Reference for parent

parent_id¶: Field for parentID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

refresh_linked_folder(linked_folder_id=None, obj_code=None, object_id=None)¶

The refreshLinkedFolder action.

Parameters:	linked_folder_id – linkedFolderID (type: `string`) obj_code – objCode (type: `string`) object_id – objectID (type: `string`)

refresh_linked_folder_contents(linked_folder_id=None, obj_code=None, object_id=None)¶

The refreshLinkedFolderContents action.

Parameters:	linked_folder_id – linkedFolderID (type: `string`) obj_code – objCode (type: `string`) object_id – objectID (type: `string`)

refresh_linked_folder_meta_data(linked_folder_id=None)¶

The refreshLinkedFolderMetaData action.

Parameters:	linked_folder_id – linkedFolderID (type: `string`)

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

send_folder_to_external_provider(folder_id=None, document_provider_id=None, parent_external_storage_id=None)¶

The sendFolderToExternalProvider action.

Parameters:	folder_id – folderID (type: `string`) document_provider_id – documentProviderID (type: `string`) parent_external_storage_id – parentExternalStorageID (type: `string`)
Returns:	`string`

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

unlink_folders(ids=None)¶

The unlinkFolders action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.DocumentProvider(session=None, **fields)¶

Object for DOCPRO

configuration¶: Field for configuration

customer¶: Reference for customer

customer_id¶: Field for customerID

doc_provider_config¶: Reference for docProviderConfig

doc_provider_config_id¶: Field for docProviderConfigID

entry_date¶: Field for entryDate

external_integration_type¶: Field for externalIntegrationType

get_all_type_provider_ids(external_integration_type=None, doc_provider_config_id=None)¶

The getAllTypeProviderIDs action.

Parameters:	external_integration_type – externalIntegrationType (type: `string`) doc_provider_config_id – docProviderConfigID (type: `string`)
Returns:	`string[]`

get_provider_with_write_access(external_integration_type=None, config_id=None, external_folder_id=None)¶

The getProviderWithWriteAccess action.

Parameters:	external_integration_type – externalIntegrationType (type: `string`) config_id – configID (type: `string`) external_folder_id – externalFolderID (type: `string`)
Returns:	`string`

name¶: Field for name

owner¶: Reference for owner

owner_id¶: Field for ownerID

web_hook_expiration_date¶: Field for webHookExpirationDate

class workfront.versions.unsupported.DocumentProviderConfig(session=None, **fields)¶

Object for DOCCFG

configuration¶: Field for configuration

customer¶: Reference for customer

customer_id¶: Field for customerID

external_integration_type¶: Field for externalIntegrationType

host¶: Field for host

is_active¶: Field for isActive

name¶: Field for name

class workfront.versions.unsupported.DocumentProviderMetadata(session=None, **fields)¶

Object for DOCMET

customer¶: Reference for customer

customer_id¶: Field for customerID

external_integration_type¶: Field for externalIntegrationType

get_metadata_map_for_provider_type(external_integration_type=None)¶

The getMetadataMapForProviderType action.

Parameters:	external_integration_type – externalIntegrationType (type: `string`)
Returns:	`map`

load_metadata_for_document(document_id=None, external_integration_type=None)¶

The loadMetadataForDocument action.

Parameters:	document_id – documentID (type: `string`) external_integration_type – externalIntegrationType (type: `string`)
Returns:	`map`

mapping¶: Field for mapping

class workfront.versions.unsupported.DocumentRequest(session=None, **fields)¶

Object for DOCREQ

accessor_ids¶: Field for accessorIDs

completion_date¶: Field for completionDate

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

format_entry_date¶: Field for formatEntryDate

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

requestee¶: Reference for requestee

requestee_id¶: Field for requesteeID

requestor¶: Reference for requestor

requestor_id¶: Field for requestorID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

status¶: Field for status

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.DocumentShare(session=None, **fields)¶

Object for DOCSHR

accessor_ids¶: Field for accessorIDs

accessor_obj_code¶: Field for accessorObjCode

accessor_obj_id¶: Field for accessorObjID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

document¶: Reference for document

document_id¶: Field for documentID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

is_approver¶: Field for isApprover

is_download¶: Field for isDownload

is_proofer¶: Field for isProofer

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

notify_share(id=None)¶

The notifyShare action.

Parameters:	id – ID (type: `string`)

pending_approval¶: Reference for pendingApproval

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.DocumentTaskStatus(session=None, **fields)¶

Object for DOCTSK

customer_id¶: Field for customerID

document_version_id¶: Field for documentVersionID

file_path¶: Field for filePath

service_name¶: Field for serviceName

status¶: Field for status

status_date¶: Field for statusDate

task_info¶: Field for taskInfo

user_id¶: Field for userID

class workfront.versions.unsupported.DocumentVersion(session=None, **fields)¶

Object for DOCV

accessor_ids¶: Field for accessorIDs

add_document_version(document_version_bean=None)¶

The addDocumentVersion action.

Parameters:	document_version_bean – documentVersionBean (type: `DocumentVersion`)
Returns:	`string`

advanced_proofing_options¶: Field for advancedProofingOptions

create_proof¶: Field for createProof

customer¶: Reference for customer

customer_id¶: Field for customerID

doc_size¶: Field for docSize

doc_status¶: Field for docStatus

document¶: Reference for document

document_id¶: Field for documentID

document_provider¶: Reference for documentProvider

document_provider_id¶: Field for documentProviderID

document_type_label¶: Field for documentTypeLabel

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext¶: Field for ext

external_download_url¶: Field for externalDownloadURL

external_integration_type¶: Field for externalIntegrationType

external_preview_url¶: Field for externalPreviewURL

external_save_location¶: Field for externalSaveLocation

external_storage_id¶: Field for externalStorageID

file_handle()¶

The fileHandle action.

Returns:	`string`

file_name¶: Field for fileName

file_type¶: Field for fileType

format_doc_size¶: Field for formatDocSize

format_entry_date¶: Field for formatEntryDate

handle¶: Field for handle

icon¶: Field for icon

is_proof_automated¶: Field for isProofAutomated

is_proofable¶: Field for isProofable

location¶: Field for location

proof_id¶: Field for proofID

proof_stage_id¶: Field for proofStageID

proof_status¶: Field for proofStatus

proof_status_date¶: Field for proofStatusDate

proof_status_msg_key¶: Field for proofStatusMsgKey

public_file_handle(version_id=None, public_token=None)¶

The publicFileHandle action.

Parameters:	version_id – versionID (type: `string`) public_token – publicToken (type: `string`)
Returns:	`string`

remove_document_version(document_version=None)¶

The removeDocumentVersion action.

Parameters:	document_version – documentVersion (type: `DocumentVersion`)

version¶: Field for version

virus_scan¶: Field for virusScan

virus_scan_timestamp¶: Field for virusScanTimestamp

class workfront.versions.unsupported.Email(session=None, **fields)¶

Object for EMAILC

obj_code¶: Field for objCode

send_test_email(email_address=None, username=None, password=None, host=None, port=None, usessl=None)¶

The sendTestEmail action.

Parameters:	email_address – emailAddress (type: `string`) username – username (type: `string`) password – password (type: `string`) host – host (type: `string`) port – port (type: `string`) usessl – usessl (type: `java.lang.Boolean`)
Returns:	`string`

test_pop_account_settings(username=None, password=None, host=None, port=None, usessl=None)¶

The testPopAccountSettings action.

Parameters:	username – username (type: `string`) password – password (type: `string`) host – host (type: `string`) port – port (type: `string`) usessl – usessl (type: `boolean`)
Returns:	`string`

class workfront.versions.unsupported.EmailTemplate(session=None, **fields)¶

Object for EMLTPL

content¶: Field for content

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

get_email_subjects(customer_id=None, handler_name_map=None, obj_code=None, obj_id=None, event_type=None)¶

The getEmailSubjects action.

Parameters:	customer_id – customerID (type: `string`) handler_name_map – handlerNameMap (type: `map`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`) event_type – eventType (type: `string`)
Returns:	`map`

get_help_desk_registration_email(user_id=None)¶

The getHelpDeskRegistrationEmail action.

Parameters:	user_id – userID (type: `string`)
Returns:	`string`

get_user_invitation_email(user_id=None)¶

The getUserInvitationEmail action.

Parameters:	user_id – userID (type: `string`)
Returns:	`string`

name¶: Field for name

subject¶: Field for subject

template_obj_code¶: Field for templateObjCode

class workfront.versions.unsupported.Endorsement(session=None, **fields)¶

Object for ENDR

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

get_liked_endorsement_ids(endorsement_ids=None)¶

The getLikedEndorsementIDs action.

Parameters:	endorsement_ids – endorsementIDs (type: `string[]`)
Returns:	`string[]`

has_replies¶: Field for hasReplies

is_assignee¶: Field for isAssignee

is_owner¶: Field for isOwner

like()¶: The like action.

num_likes¶: Field for numLikes

num_replies¶: Field for numReplies

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

receiver¶: Reference for receiver

receiver_id¶: Field for receiverID

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

reference_object_name¶: Field for referenceObjectName

replies¶: Collection for replies

role¶: Reference for role

role_id¶: Field for roleID

shares¶: Collection for shares

sub_obj_code¶: Field for subObjCode

sub_obj_id¶: Field for subObjID

sub_reference_object_name¶: Field for subReferenceObjectName

task¶: Reference for task

task_id¶: Field for taskID

top_obj_code¶: Field for topObjCode

top_obj_id¶: Field for topObjID

top_reference_object_name¶: Field for topReferenceObjectName

unlike()¶: The unlike action.

class workfront.versions.unsupported.EndorsementShare(session=None, **fields)¶

Object for ENDSHR

accessor_obj_code¶: Field for accessorObjCode

accessor_obj_id¶: Field for accessorObjID

customer¶: Reference for customer

customer_id¶: Field for customerID

endorsement¶: Reference for endorsement

endorsement_id¶: Field for endorsementID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.EventHandler(session=None, **fields)¶

Object for EVNTH

always_active¶: Field for alwaysActive

app_events¶: Collection for appEvents

custom_properties¶: Field for customProperties

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

display_subject_value¶: Field for displaySubjectValue

event_obj_code¶: Field for eventObjCode

event_types¶: Field for eventTypes

handler_properties¶: Field for handlerProperties

handler_type¶: Field for handlerType

is_active¶: Field for isActive

is_hidden¶: Field for isHidden

is_system_handler¶: Field for isSystemHandler

name¶: Field for name

name_key¶: Field for nameKey

reset_subjects_to_default(event_handler_ids=None)¶

The resetSubjectsToDefault action.

Parameters:	event_handler_ids – eventHandlerIDs (type: `string[]`)
Returns:	`string[]`

set_custom_subject(custom_subjects=None, custom_subject_properties=None)¶

The setCustomSubject action.

Parameters:	custom_subjects – customSubjects (type: `string[]`) custom_subject_properties – customSubjectProperties (type: `string[]`)
Returns:	`string`

class workfront.versions.unsupported.EventSubscription(session=None, **fields)¶

Object for EVTSUB

customer¶: Reference for customer

customer_id¶: Field for customerID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

event_type¶: Field for eventType

last_update_date¶: Field for lastUpdateDate

notification_url¶: Field for notificationURL

status¶: Field for status

class workfront.versions.unsupported.ExchangeRate(session=None, **fields)¶

Object for EXRATE

accessor_ids¶: Field for accessorIDs

currency¶: Field for currency

customer¶: Reference for customer

customer_id¶: Field for customerID

ext_ref_id¶: Field for extRefID

project¶: Reference for project

project_id¶: Field for projectID

rate¶: Field for rate

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

suggest_exchange_rate(base_currency=None, to_currency_code=None)¶

The suggestExchangeRate action.

Parameters:	base_currency – baseCurrency (type: `string`) to_currency_code – toCurrencyCode (type: `string`)
Returns:	`java.lang.Double`

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.Expense(session=None, **fields)¶

Object for EXPNS

accessor_ids¶: Field for accessorIDs

actual_amount¶: Field for actualAmount

actual_unit_amount¶: Field for actualUnitAmount

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

effective_date¶: Field for effectiveDate

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

exp_obj_code¶: Field for expObjCode

expense_type¶: Reference for expenseType

expense_type_id¶: Field for expenseTypeID

ext_ref_id¶: Field for extRefID

is_billable¶: Field for isBillable

is_reimbursable¶: Field for isReimbursable

is_reimbursed¶: Field for isReimbursed

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

move(obj_id=None, exp_obj_code=None)¶

The move action.

Parameters:	obj_id – objID (type: `string`) exp_obj_code – expObjCode (type: `string`)

obj_id¶: Field for objID

object_categories¶: Collection for objectCategories

parameter_values¶: Collection for parameterValues

planned_amount¶: Field for plannedAmount

planned_date¶: Field for plannedDate

planned_unit_amount¶: Field for plannedUnitAmount

project¶: Reference for project

project_id¶: Field for projectID

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

reference_object_name¶: Field for referenceObjectName

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

top_obj_code¶: Field for topObjCode

top_obj_id¶: Field for topObjID

top_reference_obj_code¶: Field for topReferenceObjCode

top_reference_obj_id¶: Field for topReferenceObjID

class workfront.versions.unsupported.ExpenseType(session=None, **fields)¶

Object for EXPTYP

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

display_per¶: Field for displayPer

display_rate_unit¶: Field for displayRateUnit

ext_ref_id¶: Field for extRefID

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

rate¶: Field for rate

rate_unit¶: Field for rateUnit

class workfront.versions.unsupported.ExternalDocument(session=None, **fields)¶

Object for EXTDOC

allowed_actions¶: Field for allowedActions

browse_list_with_link_action(provider_type=None, document_provider_id=None, search_params=None, link_action=None)¶

The browseListWithLinkAction action.

Parameters:	provider_type – providerType (type: `string`) document_provider_id – documentProviderID (type: `string`) search_params – searchParams (type: `map`) link_action – linkAction (type: `string`)
Returns:	`map`

date_modified¶: Field for dateModified

description¶: Field for description

document_provider_id¶: Field for documentProviderID

download_url¶: Field for downloadURL

ext¶: Field for ext

file_type¶: Field for fileType

get_authentication_url_for_provider(provider_type=None, document_provider_id=None, document_provider_config_id=None)¶

The getAuthenticationUrlForProvider action.

Parameters:	provider_type – providerType (type: `string`) document_provider_id – documentProviderID (type: `string`) document_provider_config_id – documentProviderConfigID (type: `string`)
Returns:	`string`

get_thumbnail_path(provider_type=None, provider_id=None, last_modified_date=None, id=None)¶

The getThumbnailPath action.

Parameters:	provider_type – providerType (type: `string`) provider_id – providerID (type: `string`) last_modified_date – lastModifiedDate (type: `string`) id – id (type: `string`)
Returns:	`string`

icon_url¶: Field for iconURL

load_external_browse_location(provider_type=None, document_provider_id=None, link_action=None)¶

The loadExternalBrowseLocation action.

Parameters:	provider_type – providerType (type: `string`) document_provider_id – documentProviderID (type: `string`) link_action – linkAction (type: `string`)
Returns:	`string[]`

name¶: Field for name

path¶: Field for path

preview_url¶: Field for previewURL

provider_type¶: Field for providerType

read_only¶: Field for readOnly

save_external_browse_location(provider_type=None, document_provider_id=None, link_action=None, breadcrumb=None)¶

The saveExternalBrowseLocation action.

Parameters:	provider_type – providerType (type: `string`) document_provider_id – documentProviderID (type: `string`) link_action – linkAction (type: `string`) breadcrumb – breadcrumb (type: `string`)

show_external_thumbnails()¶

The showExternalThumbnails action.

Returns:	`java.lang.Boolean`

size¶: Field for size

thumbnail_url¶: Field for thumbnailURL

class workfront.versions.unsupported.ExternalSection(session=None, **fields)¶

Object for EXTSEC

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

calculate_url(external_section_id=None, obj_code=None, obj_id=None)¶

The calculateURL action.

Parameters:	external_section_id – externalSectionID (type: `string`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`string`

calculate_urls(external_section_ids=None, obj_code=None, obj_id=None)¶

The calculateURLS action.

Parameters:	external_section_ids – externalSectionIDs (type: `java.util.Collection`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`map`

calculated_url¶: Field for calculatedURL

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

frame¶: Field for frame

friendly_url¶: Field for friendlyURL

global_uikey¶: Field for globalUIKey

height¶: Field for height

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_interface¶: Field for objInterface

obj_obj_code¶: Field for objObjCode

scrolling¶: Field for scrolling

url¶: Field for url

view¶: Reference for view

view_id¶: Field for viewID

class workfront.versions.unsupported.Favorite(session=None, **fields)¶

Object for FVRITE

customer¶: Reference for customer

customer_id¶: Field for customerID

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

update_favorite_name(name=None, favorite_id=None)¶

The updateFavoriteName action.

Parameters:	name – name (type: `string`) favorite_id – favoriteID (type: `string`)

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.Feature(session=None, **fields)¶

Object for FEATR

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

export()¶

The export action.

Returns:	`string`

is_enabled(name=None)¶

The isEnabled action.

Parameters:	name – name (type: `string`)
Returns:	`java.lang.Boolean`

jexl_expression¶: Field for jexlExpression

jexl_updated_date¶: Field for jexlUpdatedDate

name¶: Field for name

old_jexl_expression¶: Field for oldJexlExpression

override_for_session(name=None, value=None)¶

The overrideForSession action.

Parameters:	name – name (type: `string`) value – value (type: `boolean`)

class workfront.versions.unsupported.FinancialData(session=None, **fields)¶

Object for FINDAT

actual_expense_cost¶: Field for actualExpenseCost

actual_fixed_revenue¶: Field for actualFixedRevenue

actual_labor_cost¶: Field for actualLaborCost

actual_labor_cost_hours¶: Field for actualLaborCostHours

actual_labor_revenue¶: Field for actualLaborRevenue

allocationdate¶: Field for allocationdate

customer¶: Reference for customer

customer_id¶: Field for customerID

fixed_cost¶: Field for fixedCost

is_split¶: Field for isSplit

planned_expense_cost¶: Field for plannedExpenseCost

planned_fixed_revenue¶: Field for plannedFixedRevenue

planned_labor_cost¶: Field for plannedLaborCost

planned_labor_cost_hours¶: Field for plannedLaborCostHours

planned_labor_revenue¶: Field for plannedLaborRevenue

project¶: Reference for project

project_id¶: Field for projectID

total_actual_cost¶: Field for totalActualCost

total_actual_revenue¶: Field for totalActualRevenue

total_planned_cost¶: Field for totalPlannedCost

total_planned_revenue¶: Field for totalPlannedRevenue

total_variance_cost¶: Field for totalVarianceCost

total_variance_revenue¶: Field for totalVarianceRevenue

variance_expense_cost¶: Field for varianceExpenseCost

variance_labor_cost¶: Field for varianceLaborCost

variance_labor_cost_hours¶: Field for varianceLaborCostHours

variance_labor_revenue¶: Field for varianceLaborRevenue

class workfront.versions.unsupported.Group(session=None, **fields)¶

Object for GROUP

add_early_access(ids=None)¶

The addEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

check_delete(ids=None)¶

The checkDelete action.

Parameters:	ids – ids (type: `string[]`)

children¶: Collection for children

customer¶: Reference for customer

customer_id¶: Field for customerID

default_interface¶: Field for defaultInterface

delete_early_access(ids=None)¶

The deleteEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

name¶: Field for name

parent¶: Reference for parent

parent_id¶: Field for parentID

replace_delete_groups(ids=None, replace_group_id=None)¶

The replaceDeleteGroups action.

Parameters:	ids – ids (type: `string[]`) replace_group_id – replaceGroupID (type: `string`)

user_groups¶: Collection for userGroups

class workfront.versions.unsupported.Hour(session=None, **fields)¶

Object for HOUR

accessor_ids¶: Field for accessorIDs

actual_cost¶: Field for actualCost

approve()¶: The approve action.

approved_by¶: Reference for approvedBy

approved_by_id¶: Field for approvedByID

approved_on_date¶: Field for approvedOnDate

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

dup_id¶: Field for dupID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

has_rate_override¶: Field for hasRateOverride

hour_type¶: Reference for hourType

hour_type_id¶: Field for hourTypeID

hours¶: Field for hours

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

owner¶: Reference for owner

owner_id¶: Field for ownerID

project¶: Reference for project

project_id¶: Field for projectID

project_overhead¶: Reference for projectOverhead

project_overhead_id¶: Field for projectOverheadID

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

resource_revenue¶: Field for resourceRevenue

role¶: Reference for role

role_id¶: Field for roleID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

status¶: Field for status

task¶: Reference for task

task_id¶: Field for taskID

timesheet¶: Reference for timesheet

timesheet_id¶: Field for timesheetID

unapprove()¶: The unapprove action.

class workfront.versions.unsupported.HourType(session=None, **fields)¶

Object for HOURT

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

count_as_revenue¶: Field for countAsRevenue

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

display_obj_obj_code¶: Field for displayObjObjCode

ext_ref_id¶: Field for extRefID

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

is_active¶: Field for isActive

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

overhead_type¶: Field for overheadType

scope¶: Field for scope

timesheetprofiles¶: Collection for timesheetprofiles

users¶: Collection for users

class workfront.versions.unsupported.IPRange(session=None, **fields)¶

Object for IPRAGE

customer¶: Reference for customer

customer_id¶: Field for customerID

end_range¶: Field for endRange

start_range¶: Field for startRange

class workfront.versions.unsupported.ImportRow(session=None, **fields)¶

Object for IROW

column_number¶: Field for columnNumber

customer¶: Reference for customer

customer_id¶: Field for customerID

field_name¶: Field for fieldName

import_template¶: Reference for importTemplate

import_template_id¶: Field for importTemplateID

class workfront.versions.unsupported.ImportTemplate(session=None, **fields)¶

Object for ITMPL

begin_at_row¶: Field for beginAtRow

customer¶: Reference for customer

customer_id¶: Field for customerID

import_obj_code¶: Field for importObjCode

import_rows¶: Collection for importRows

name¶: Field for name

class workfront.versions.unsupported.InstalledDDItem(session=None, **fields)¶

Object for IDDI

customer¶: Reference for customer

customer_id¶: Field for customerID

iddiobj_code¶: Field for IDDIObjCode

name_key¶: Field for nameKey

class workfront.versions.unsupported.Issue(session=None, **fields)¶

Object for OPTASK

accept_work()¶: The acceptWork action.

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_start_date¶: Field for actualStartDate

actual_work_required¶: Field for actualWorkRequired

actual_work_required_expression¶: Field for actualWorkRequiredExpression

add_comment(text)¶

Add a comment to the current object containing the supplied text.

The new Comment instance is returned, it does not need to be saved.

age_range_as_string¶: Field for ageRangeAsString

all_priorities¶: Collection for allPriorities

all_severities¶: Collection for allSeverities

all_statuses¶: Collection for allStatuses

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The approveApproval action.

Parameters:	user_id – userID (type: `string`) username – username (type: `string`) password – password (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

approver_statuses¶: Collection for approverStatuses

approvers_string¶: Field for approversString

assign(obj_id=None, obj_code=None)¶

The assign action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`)

assign_multiple(user_ids=None, role_ids=None, team_id=None)¶

The assignMultiple action.

Parameters:	user_ids – userIDs (type: `string[]`) role_ids – roleIDs (type: `string[]`) team_id – teamID (type: `string`)

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

audit_types¶: Field for auditTypes

auto_closure_date¶: Field for autoClosureDate

awaiting_approvals¶: Collection for awaitingApprovals

calculate_data_extension()¶: The calculateDataExtension action.

can_start¶: Field for canStart

category¶: Reference for category

category_id¶: Field for categoryID

commit_date¶: Field for commitDate

commit_date_range¶: Field for commitDateRange

condition¶: Field for condition

convert_to_project(project=None, exchange_rate=None, options=None)¶

The convertToProject action.

Parameters:	project – project (type: `Project`) exchange_rate – exchangeRate (type: `ExchangeRate`) options – options (type: `string[]`)
Returns:	`string`

convert_to_task()¶: Convert this issue to a task. The newly converted task will be returned, it does not need to be saved.

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

current_status_duration¶: Field for currentStatusDuration

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_queue_breadcrumb¶: Field for displayQueueBreadcrumb

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

done_statuses¶: Collection for doneStatuses

due_date¶: Field for dueDate

duration_minutes¶: Field for durationMinutes

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

first_response¶: Field for firstResponse

has_documents¶: Field for hasDocuments

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

has_resolvables¶: Field for hasResolvables

has_timed_notifications¶: Field for hasTimedNotifications

hours¶: Collection for hours

how_old¶: Field for howOld

is_complete¶: Field for isComplete

is_help_desk¶: Field for isHelpDesk

last_condition_note¶: Reference for lastConditionNote

last_condition_note_id¶: Field for lastConditionNoteID

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

mark_done(status=None)¶

The markDone action.

Parameters:	status – status (type: `string`)

mark_not_done(assignment_id=None)¶

The markNotDone action.

Parameters:	assignment_id – assignmentID (type: `string`)

move(project_id=None)¶

The move action.

Parameters:	project_id – projectID (type: `string`)

move_to_task(project_id=None, parent_id=None)¶

The moveToTask action.

Parameters:	project_id – projectID (type: `string`) parent_id – parentID (type: `string`)

name¶: Field for name

notification_records¶: Collection for notificationRecords

number_of_children¶: Field for numberOfChildren

object_categories¶: Collection for objectCategories

olv¶: Field for olv

op_task_type¶: Field for opTaskType

op_task_type_label¶: Field for opTaskTypeLabel

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

parent¶: Reference for parent

planned_completion_date¶: Field for plannedCompletionDate

planned_date_alignment¶: Field for plannedDateAlignment

planned_duration_minutes¶: Field for plannedDurationMinutes

planned_hours_alignment¶: Field for plannedHoursAlignment

planned_start_date¶: Field for plannedStartDate

previous_status¶: Field for previousStatus

primary_assignment¶: Reference for primaryAssignment

priority¶: Field for priority

project¶: Reference for project

project_id¶: Field for projectID

projected_completion_date¶: Field for projectedCompletionDate

projected_duration_minutes¶: Field for projectedDurationMinutes

projected_start_date¶: Field for projectedStartDate

queue_topic¶: Reference for queueTopic

queue_topic_breadcrumb¶: Field for queueTopicBreadcrumb

queue_topic_id¶: Field for queueTopicID

recall_approval()¶: The recallApproval action.

reference_number¶: Field for referenceNumber

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The rejectApproval action.

Parameters:	user_id – userID (type: `string`) username – username (type: `string`) password – password (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

remaining_duration_minutes¶: Field for remainingDurationMinutes

reply_to_assignment(note_text=None, commit_date=None)¶

The replyToAssignment action.

Parameters:	note_text – noteText (type: `string`) commit_date – commitDate (type: `dateTime`)

resolution_time¶: Field for resolutionTime

resolvables¶: Collection for resolvables

resolve_op_task¶: Reference for resolveOpTask

resolve_op_task_id¶: Field for resolveOpTaskID

resolve_project¶: Reference for resolveProject

resolve_project_id¶: Field for resolveProjectID

resolve_task¶: Reference for resolveTask

resolve_task_id¶: Field for resolveTaskID

resolving_obj_code¶: Field for resolvingObjCode

resolving_obj_id¶: Field for resolvingObjID

role¶: Reference for role

role_id¶: Field for roleID

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

severity¶: Field for severity

show_commit_date¶: Field for showCommitDate

show_condition¶: Field for showCondition

show_status¶: Field for showStatus

source_obj_code¶: Field for sourceObjCode

source_obj_id¶: Field for sourceObjID

source_task¶: Reference for sourceTask

source_task_id¶: Field for sourceTaskID

status¶: Field for status

status_update¶: Field for statusUpdate

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

timed_notifications(notification_ids=None)¶

The timedNotifications action.

Parameters:	notification_ids – notificationIDs (type: `string[]`)

unaccept_work()¶: The unacceptWork action.

unassign(user_id=None)¶

The unassign action.

Parameters:	user_id – userID (type: `string`)

updates¶: Collection for updates

url¶: Field for url

version¶: Field for version

work_item¶: Reference for workItem

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

class workfront.versions.unsupported.Iteration(session=None, **fields)¶

Object for ITRN

assign_iteration_to_descendants(task_ids=None, iteration_id=None)¶

The assignIterationToDescendants action.

Parameters:	task_ids – taskIDs (type: `string[]`) iteration_id – iterationID (type: `string`)

capacity¶: Field for capacity

category¶: Reference for category

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

end_date¶: Field for endDate

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

estimate_completed¶: Field for estimateCompleted

focus_factor¶: Field for focusFactor

goal¶: Field for goal

has_documents¶: Field for hasDocuments

has_notes¶: Field for hasNotes

is_legacy¶: Field for isLegacy

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

legacy_burndown_info_with_percentage(iteration_id=None)¶

The legacyBurndownInfoWithPercentage action.

Parameters:	iteration_id – iterationID (type: `string`)
Returns:	`map`

legacy_burndown_info_with_points(iteration_id=None)¶

The legacyBurndownInfoWithPoints action.

Parameters:	iteration_id – iterationID (type: `string`)
Returns:	`map`

name¶: Field for name

object_categories¶: Collection for objectCategories

original_total_estimate¶: Field for originalTotalEstimate

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

percent_complete¶: Field for percentComplete

start_date¶: Field for startDate

status¶: Field for status

target_percent_complete¶: Field for targetPercentComplete

task_ids¶: Field for taskIDs

team¶: Reference for team

team_id¶: Field for teamID

total_estimate¶: Field for totalEstimate

url¶: Field for URL

class workfront.versions.unsupported.JournalEntry(session=None, **fields)¶

Object for JRNLE

accessor_ids¶: Field for accessorIDs

approver_status¶: Reference for approverStatus

approver_status_id¶: Field for approverStatusID

assignment¶: Reference for assignment

assignment_id¶: Field for assignmentID

audit_record¶: Reference for auditRecord

audit_record_id¶: Field for auditRecordID

aux1¶: Field for aux1

aux2¶: Field for aux2

aux3¶: Field for aux3

baseline¶: Reference for baseline

baseline_id¶: Field for baselineID

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

change_type¶: Field for changeType

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_approval¶: Reference for documentApproval

document_approval_id¶: Field for documentApprovalID

document_id¶: Field for documentID

document_share¶: Reference for documentShare

document_share_id¶: Field for documentShareID

duration_minutes¶: Field for durationMinutes

edit_field_names(parameter_id=None, field_name=None)¶

The editFieldNames action.

Parameters:	parameter_id – parameterID (type: `string`) field_name – fieldName (type: `string`)
Returns:	`string[]`

edited_by¶: Reference for editedBy

edited_by_id¶: Field for editedByID

entry_date¶: Field for entryDate

expense¶: Reference for expense

expense_id¶: Field for expenseID

ext_ref_id¶: Field for extRefID

field_name¶: Field for fieldName

flags¶: Field for flags

get_liked_journal_entry_ids(journal_entry_ids=None)¶

The getLikedJournalEntryIDs action.

Parameters:	journal_entry_ids – journalEntryIDs (type: `string[]`)
Returns:	`string[]`

hour¶: Reference for hour

hour_id¶: Field for hourID

like()¶: The like action.

new_date_val¶: Field for newDateVal

new_number_val¶: Field for newNumberVal

new_text_val¶: Field for newTextVal

num_likes¶: Field for numLikes

num_replies¶: Field for numReplies

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

old_date_val¶: Field for oldDateVal

old_number_val¶: Field for oldNumberVal

old_text_val¶: Field for oldTextVal

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

reference_object_name¶: Field for referenceObjectName

replies¶: Collection for replies

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

sub_obj_code¶: Field for subObjCode

sub_obj_id¶: Field for subObjID

sub_reference_object_name¶: Field for subReferenceObjectName

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

timesheet¶: Reference for timesheet

timesheet_id¶: Field for timesheetID

top_obj_code¶: Field for topObjCode

top_obj_id¶: Field for topObjID

top_reference_object_name¶: Field for topReferenceObjectName

unlike()¶: The unlike action.

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.JournalField(session=None, **fields)¶

Object for JRNLF

action¶: Field for action

customer¶: Reference for customer

customer_id¶: Field for customerID

display_name¶: Field for displayName

ext_ref_id¶: Field for extRefID

field_name¶: Field for fieldName

is_duration_enabled¶: Field for isDurationEnabled

migrate_wild_card_journal_fields()¶: The migrateWildCardJournalFields action.

obj_obj_code¶: Field for objObjCode

parameter¶: Reference for parameter

parameter_id¶: Field for parameterID

set_journal_fields_for_obj_code(obj_code=None, messages=None)¶

The setJournalFieldsForObjCode action.

Parameters:	obj_code – objCode (type: `string`) messages – messages (type: `com.attask.model.RKJournalField[]`)
Returns:	`string[]`

class workfront.versions.unsupported.KickStart(session=None, **fields)¶

Object for KSS

import_kick_start(file_handle=None, file_type=None)¶

The importKickStart action.

Parameters:	file_handle – fileHandle (type: `string`) file_type – fileType (type: `string`)
Returns:	`map`

obj_code¶: Field for objCode

class workfront.versions.unsupported.LayoutTemplate(session=None, **fields)¶

Object for LYTMPL

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

clear_all_custom_tabs(reset_default_nav=None, reset_nav_items=None)¶

The clearAllCustomTabs action.

Parameters:	reset_default_nav – resetDefaultNav (type: `boolean`) reset_nav_items – resetNavItems (type: `boolean`)

clear_all_user_custom_tabs(user_ids=None, reset_default_nav=None, reset_nav_items=None)¶

The clearAllUserCustomTabs action.

Parameters:	user_ids – userIDs (type: `java.util.Set`) reset_default_nav – resetDefaultNav (type: `boolean`) reset_nav_items – resetNavItems (type: `boolean`)

clear_ppmigration_flag()¶: The clearPPMigrationFlag action.

clear_user_custom_tabs(user_ids=None, reset_default_nav=None, reset_nav_items=None, layout_page_types=None)¶

The clearUserCustomTabs action.

Parameters:	user_ids – userIDs (type: `java.util.Set`) reset_default_nav – resetDefaultNav (type: `boolean`) reset_nav_items – resetNavItems (type: `boolean`) layout_page_types – layoutPageTypes (type: `java.util.Set`)

customer¶: Reference for customer

customer_id¶: Field for customerID

default_nav_item¶: Field for defaultNavItem

description¶: Field for description

description_key¶: Field for descriptionKey

ext_ref_id¶: Field for extRefID

get_layout_template_cards_by_card_location(layout_template_id=None, card_location=None)¶

The getLayoutTemplateCardsByCardLocation action.

Parameters:	layout_template_id – layoutTemplateID (type: `string`) card_location – cardLocation (type: `string`)
Returns:	`string[]`

get_layout_template_users(layout_template_ids=None)¶

The getLayoutTemplateUsers action.

Parameters:	layout_template_ids – layoutTemplateIDs (type: `string[]`)
Returns:	`string[]`

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

layout_template_cards¶: Collection for layoutTemplateCards

layout_template_date_preferences¶: Collection for layoutTemplateDatePreferences

layout_template_pages¶: Collection for layoutTemplatePages

license_type¶: Field for licenseType

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

migrate_portal_profile(portal_profile_ids=None)¶

The migratePortalProfile action.

Parameters:	portal_profile_ids – portalProfileIDs (type: `string[]`)
Returns:	`map`

name¶: Field for name

name_key¶: Field for nameKey

nav_bar¶: Field for navBar

nav_items¶: Field for navItems

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

ui_filters¶: Collection for uiFilters

ui_group_bys¶: Collection for uiGroupBys

ui_views¶: Collection for uiViews

class workfront.versions.unsupported.LayoutTemplateCard(session=None, **fields)¶

Object for LTMPLC

card_location¶: Field for cardLocation

card_type¶: Field for cardType

custom_label¶: Field for customLabel

customer¶: Reference for customer

customer_id¶: Field for customerID

data_type¶: Field for dataType

display_order¶: Field for displayOrder

field_name¶: Field for fieldName

group_name¶: Field for groupName

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

parameter_id¶: Field for parameterID

class workfront.versions.unsupported.LayoutTemplateDatePreference(session=None, **fields)¶

Object for LTMPDP

card_location¶: Field for cardLocation

card_type¶: Field for cardType

customer¶: Reference for customer

customer_id¶: Field for customerID

date_preference¶: Field for datePreference

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

class workfront.versions.unsupported.LayoutTemplatePage(session=None, **fields)¶

Object for LTMPLP

customer¶: Reference for customer

customer_id¶: Field for customerID

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

page_type¶: Field for pageType

tabs¶: Field for tabs

class workfront.versions.unsupported.LicenseOrder(session=None, **fields)¶

Object for LICEOR

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

exp_date¶: Field for expDate

ext_ref_id¶: Field for extRefID

external_users_enabled¶: Field for externalUsersEnabled

full_users¶: Field for fullUsers

is_apienabled¶: Field for isAPIEnabled

is_enterprise¶: Field for isEnterprise

is_soapenabled¶: Field for isSOAPEnabled

limited_users¶: Field for limitedUsers

order_date¶: Field for orderDate

requestor_users¶: Field for requestorUsers

review_users¶: Field for reviewUsers

team_users¶: Field for teamUsers

class workfront.versions.unsupported.Like(session=None, **fields)¶

Object for LIKE

customer¶: Reference for customer

customer_id¶: Field for customerID

endorsement¶: Reference for endorsement

endorsement_id¶: Field for endorsementID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

journal_entry¶: Reference for journalEntry

journal_entry_id¶: Field for journalEntryID

note¶: Reference for note

note_id¶: Field for noteID

class workfront.versions.unsupported.LinkedFolder(session=None, **fields)¶

Object for LNKFDR

customer¶: Reference for customer

customer_id¶: Field for customerID

document_provider¶: Reference for documentProvider

document_provider_id¶: Field for documentProviderID

external_integration_type¶: Field for externalIntegrationType

external_storage_id¶: Field for externalStorageID

folder¶: Reference for folder

folder_id¶: Field for folderID

is_top_level_folder¶: Field for isTopLevelFolder

last_sync_date¶: Field for lastSyncDate

linked_by¶: Reference for linkedBy

linked_by_id¶: Field for linkedByID

linked_date¶: Field for linkedDate

class workfront.versions.unsupported.MasterTask(session=None, **fields)¶

Object for MTSK

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

audit_types¶: Field for auditTypes

billing_amount¶: Field for billingAmount

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

cost_amount¶: Field for costAmount

cost_type¶: Field for costType

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

duration_minutes¶: Field for durationMinutes

duration_type¶: Field for durationType

duration_unit¶: Field for durationUnit

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

groups¶: Collection for groups

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

is_duration_locked¶: Field for isDurationLocked

is_work_required_locked¶: Field for isWorkRequiredLocked

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

milestone¶: Reference for milestone

milestone_id¶: Field for milestoneID

name¶: Field for name

notification_records¶: Collection for notificationRecords

object_categories¶: Collection for objectCategories

parameter_values¶: Collection for parameterValues

planned_cost¶: Field for plannedCost

planned_revenue¶: Field for plannedRevenue

priority¶: Field for priority

revenue_type¶: Field for revenueType

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

tracking_mode¶: Field for trackingMode

url¶: Field for URL

work_required¶: Field for workRequired

class workfront.versions.unsupported.MessageArg(session=None, **fields)¶

Object for MSGARG

allowed_actions¶: Field for allowedActions

color¶: Field for color

href¶: Field for href

objcode¶: Field for objcode

objid¶: Field for objid

text¶: Field for text

type¶: Field for type

class workfront.versions.unsupported.MetaRecord(session=None, **fields)¶

Object for PRSTOBJ

actions¶: Field for actions

bean_classname¶: Field for beanClassname

classname¶: Field for classname

common_display_order¶: Field for commonDisplayOrder

external_actions¶: Field for externalActions

is_asp¶: Field for isASP

is_common¶: Field for isCommon

limit_non_view_external¶: Field for limitNonViewExternal

limit_non_view_hd¶: Field for limitNonViewHD

limit_non_view_review¶: Field for limitNonViewReview

limit_non_view_team¶: Field for limitNonViewTeam

limit_non_view_ts¶: Field for limitNonViewTS

limited_actions¶: Field for limitedActions

message_key¶: Field for messageKey

obj_code¶: Field for objCode

pk_field_name¶: Field for pkFieldName

pk_table_name¶: Field for pkTableName

requestor_actions¶: Field for requestorActions

review_actions¶: Field for reviewActions

team_actions¶: Field for teamActions

class workfront.versions.unsupported.Milestone(session=None, **fields)¶

Object for MILE

color¶: Field for color

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

ext_ref_id¶: Field for extRefID

milestone_path¶: Reference for milestonePath

milestone_path_id¶: Field for milestonePathID

name¶: Field for name

sequence¶: Field for sequence

class workfront.versions.unsupported.MilestonePath(session=None, **fields)¶

Object for MPATH

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

groups¶: Collection for groups

milestones¶: Collection for milestones

name¶: Field for name

class workfront.versions.unsupported.MobileDevice(session=None, **fields)¶

Object for MOBILDVC

device_token¶: Field for deviceToken

device_type¶: Field for deviceType

endpoint¶: Field for endpoint

user¶: Reference for user

class workfront.versions.unsupported.NonWorkDay(session=None, **fields)¶

Object for NONWKD

customer¶: Reference for customer

customer_id¶: Field for customerID

non_work_date¶: Field for nonWorkDate

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

schedule¶: Reference for schedule

schedule_day¶: Field for scheduleDay

schedule_id¶: Field for scheduleID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.Note(session=None, **fields)¶

Object for NOTE

accessor_ids¶: Field for accessorIDs

add_comment(text)¶

Add a comment to this comment.

The new Comment instance is returned, it does not need to be saved.

add_note_to_objects(obj_ids=None, note_obj_code=None, note_text=None, is_private=None, email_users=None, tags=None)¶

The addNoteToObjects action.

Parameters:	obj_ids – objIDs (type: `string[]`) note_obj_code – noteObjCode (type: `string`) note_text – noteText (type: `string`) is_private – isPrivate (type: `boolean`) email_users – emailUsers (type: `boolean`) tags – tags (type: `java.lang.Object`)
Returns:	`string[]`

attach_document¶: Reference for attachDocument

attach_document_id¶: Field for attachDocumentID

attach_obj_code¶: Field for attachObjCode

attach_obj_id¶: Field for attachObjID

attach_op_task¶: Reference for attachOpTask

attach_op_task_id¶: Field for attachOpTaskID

attach_work_id¶: Field for attachWorkID

attach_work_name¶: Field for attachWorkName

attach_work_obj_code¶: Field for attachWorkObjCode

attach_work_user¶: Reference for attachWorkUser

attach_work_user_id¶: Field for attachWorkUserID

audit_record¶: Reference for auditRecord

audit_record_id¶: Field for auditRecordID

audit_text¶: Field for auditText

audit_type¶: Field for auditType

customer¶: Reference for customer

customer_id¶: Field for customerID

document¶: Reference for document

document_id¶: Field for documentID

email_users¶: Field for emailUsers

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

format_entry_date¶: Field for formatEntryDate

get_liked_note_ids(note_ids=None)¶

The getLikedNoteIDs action.

Parameters:	note_ids – noteIDs (type: `string[]`)
Returns:	`string[]`

has_replies¶: Field for hasReplies

indent¶: Field for indent

is_deleted¶: Field for isDeleted

is_message¶: Field for isMessage

is_private¶: Field for isPrivate

is_reply¶: Field for isReply

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

like()¶: The like action.

note_obj_code¶: Field for noteObjCode

note_text¶: Field for noteText

num_likes¶: Field for numLikes

num_replies¶: Field for numReplies

obj_id¶: Field for objID

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

owner¶: Reference for owner

owner_id¶: Field for ownerID

parent_endorsement¶: Reference for parentEndorsement

parent_endorsement_id¶: Field for parentEndorsementID

parent_journal_entry¶: Reference for parentJournalEntry

parent_journal_entry_id¶: Field for parentJournalEntryID

parent_note¶: Reference for parentNote

parent_note_id¶: Field for parentNoteID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

reference_object_name¶: Field for referenceObjectName

replies¶: Collection for replies

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

subject¶: Field for subject

tags¶: Collection for tags

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

thread_date¶: Field for threadDate

thread_id¶: Field for threadID

timesheet¶: Reference for timesheet

timesheet_id¶: Field for timesheetID

top_note_obj_code¶: Field for topNoteObjCode

top_obj_id¶: Field for topObjID

top_reference_object_name¶: Field for topReferenceObjectName

unlike()¶: The unlike action.

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.NoteTag(session=None, **fields)¶

Object for NTAG

customer¶: Reference for customer

customer_id¶: Field for customerID

length¶: Field for length

note¶: Reference for note

note_id¶: Field for noteID

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

reference_object_name¶: Field for referenceObjectName

start_idx¶: Field for startIdx

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.NotificationRecord(session=None, **fields)¶

Object for TMNR

customer¶: Reference for customer

customer_id¶: Field for customerID

email_sent_date¶: Field for emailSentDate

entry_date¶: Field for entryDate

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

notification_obj_code¶: Field for notificationObjCode

notification_obj_id¶: Field for notificationObjID

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

project¶: Reference for project

project_id¶: Field for projectID

recipients¶: Field for recipients

scheduled_date¶: Field for scheduledDate

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

timed_notification¶: Reference for timedNotification

timed_notification_id¶: Field for timedNotificationID

timesheet¶: Reference for timesheet

timesheet_id¶: Field for timesheetID

timesheet_profile¶: Reference for timesheetProfile

timesheet_profile_id¶: Field for timesheetProfileID

class workfront.versions.unsupported.ObjectCategory(session=None, **fields)¶

Object for OBJCAT

category¶: Reference for category

category_id¶: Field for categoryID

category_order¶: Field for categoryOrder

customer¶: Reference for customer

customer_id¶: Field for customerID

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

class workfront.versions.unsupported.Parameter(session=None, **fields)¶

Object for PARAM

customer¶: Reference for customer

customer_id¶: Field for customerID

data_type¶: Field for dataType

description¶: Field for description

display_size¶: Field for displaySize

display_type¶: Field for displayType

ext_ref_id¶: Field for extRefID

format_constraint¶: Field for formatConstraint

is_required¶: Field for isRequired

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

parameter_options¶: Collection for parameterOptions

class workfront.versions.unsupported.ParameterGroup(session=None, **fields)¶

Object for PGRP

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_order¶: Field for displayOrder

ext_ref_id¶: Field for extRefID

is_default¶: Field for isDefault

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

class workfront.versions.unsupported.ParameterOption(session=None, **fields)¶

Object for POPT

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

ext_ref_id¶: Field for extRefID

is_default¶: Field for isDefault

is_hidden¶: Field for isHidden

label¶: Field for label

parameter¶: Reference for parameter

parameter_id¶: Field for parameterID

value¶: Field for value

class workfront.versions.unsupported.ParameterValue(session=None, **fields)¶

Object for PVAL

company¶: Reference for company

company_id¶: Field for companyID

customer¶: Reference for customer

customer_id¶: Field for customerID

date_val¶: Field for dateVal

document¶: Reference for document

document_id¶: Field for documentID

expense¶: Reference for expense

expense_id¶: Field for expenseID

interation_id¶: Field for interationID

iteration¶: Reference for iteration

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

number_val¶: Field for numberVal

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

parameter¶: Reference for parameter

parameter_id¶: Field for parameterID

parameter_name¶: Field for parameterName

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

program¶: Reference for program

program_id¶: Field for programID

project¶: Reference for project

project_id¶: Field for projectID

task¶: Reference for task

task_id¶: Field for taskID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

text_val¶: Field for textVal

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.PopAccount(session=None, **fields)¶

Object for POPA

customer¶: Reference for customer

customer_id¶: Field for customerID

entry_date¶: Field for entryDate

pop_disabled¶: Field for popDisabled

pop_enforce_ssl¶: Field for popEnforceSSL

pop_errors¶: Field for popErrors

pop_password¶: Field for popPassword

pop_port¶: Field for popPort

pop_server¶: Field for popServer

pop_user¶: Field for popUser

project¶: Reference for project

project_id¶: Field for projectID

class workfront.versions.unsupported.PortalProfile(session=None, **fields)¶

Object for PTLPFL

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

custom_menus¶: Collection for customMenus

custom_tabs¶: Collection for customTabs

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

description_key¶: Field for descriptionKey

ext_ref_id¶: Field for extRefID

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

portal_sections¶: Collection for portalSections

portal_tabs¶: Collection for portalTabs

ui_filters¶: Collection for uiFilters

ui_group_bys¶: Collection for uiGroupBys

ui_views¶: Collection for uiViews

class workfront.versions.unsupported.PortalSection(session=None, **fields)¶

Object for PTLSEC

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

controller_class¶: Field for controllerClass

currency¶: Field for currency

customer¶: Reference for customer

customer_id¶: Field for customerID

default_tab¶: Field for defaultTab

definition¶: Field for definition

description¶: Field for description

description_key¶: Field for descriptionKey

enable_prompt_security¶: Field for enablePromptSecurity

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

ext_ref_id¶: Field for extRefID

filter¶: Reference for filter

filter_control¶: Field for filterControl

filter_id¶: Field for filterID

folder_name¶: Field for folderName

force_load¶: Field for forceLoad

get_pk(obj_code=None)¶

The getPK action.

Parameters:	obj_code – objCode (type: `string`)
Returns:	`string`

get_report_from_cache(background_job_id=None)¶

The getReportFromCache action.

Parameters:	background_job_id – backgroundJobID (type: `string`)
Returns:	`map`

global_uikey¶: Field for globalUIKey

group_by¶: Reference for groupBy

group_by_id¶: Field for groupByID

group_control¶: Field for groupControl

is_app_global_copiable¶: Field for isAppGlobalCopiable

is_app_global_editable¶: Field for isAppGlobalEditable

is_new_format¶: Field for isNewFormat

is_public¶: Field for isPublic

is_report¶: Field for isReport

is_report_filterable(query_class_obj_code=None, obj_code=None, obj_id=None)¶

The isReportFilterable action.

Parameters:	query_class_obj_code – queryClassObjCode (type: `string`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)
Returns:	`java.lang.Boolean`

is_standalone¶: Field for isStandalone

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

link_customer()¶: The linkCustomer action.

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

max_results¶: Field for maxResults

method_name¶: Field for methodName

migrate_portal_sections_ppmto_anaconda()¶: The migratePortalSectionsPPMToAnaconda action.

mod_date¶: Field for modDate

name¶: Field for name

name_key¶: Field for nameKey

obj_id¶: Field for objID

obj_interface¶: Field for objInterface

obj_obj_code¶: Field for objObjCode

portal_tab_sections¶: Collection for portalTabSections

preference¶: Reference for preference

preference_id¶: Field for preferenceID

public_run_as_user¶: Reference for publicRunAsUser

public_run_as_user_id¶: Field for publicRunAsUserID

public_token¶: Field for publicToken

report_folder¶: Reference for reportFolder

report_folder_id¶: Field for reportFolderID

report_type¶: Field for reportType

run_as_user¶: Reference for runAsUser

run_as_user_id¶: Field for runAsUserID

scheduled_report¶: Reference for scheduledReport

scheduled_report_id¶: Field for scheduledReportID

scheduled_reports¶: Collection for scheduledReports

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

send_now()¶: The sendNow action.

show_prompts¶: Field for showPrompts

sort_by¶: Field for sortBy

sort_by2¶: Field for sortBy2

sort_by3¶: Field for sortBy3

sort_type¶: Field for sortType

sort_type2¶: Field for sortType2

sort_type3¶: Field for sortType3

special_view¶: Field for specialView

tool_bar¶: Field for toolBar

ui_obj_code¶: Field for uiObjCode

unlink_customer()¶: The unlinkCustomer action.

view¶: Reference for view

view_control¶: Field for viewControl

view_id¶: Field for viewID

width¶: Field for width

class workfront.versions.unsupported.PortalTab(session=None, **fields)¶

Object for PTLTAB

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

advanced_copy(new_name=None, advanced_copies=None)¶

The advancedCopy action.

Parameters:	new_name – newName (type: `string`) advanced_copies – advancedCopies (type: `map`)
Returns:	`string`

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_order¶: Field for displayOrder

doc_id¶: Field for docID

export_dashboard(dashboard_exports=None, dashboard_export_options=None)¶

The exportDashboard action.

Parameters:	dashboard_exports – dashboardExports (type: `string[]`) dashboard_export_options – dashboardExportOptions (type: `map`)
Returns:	`map`

ext_ref_id¶: Field for extRefID

is_public¶: Field for isPublic

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

migrate_custom_tab_user_prefs(user_ids=None)¶

The migrateCustomTabUserPrefs action.

Parameters:	user_ids – userIDs (type: `string[]`)

name¶: Field for name

name_key¶: Field for nameKey

portal_profile¶: Reference for portalProfile

portal_profile_id¶: Field for portalProfileID

portal_tab_sections¶: Collection for portalTabSections

tabname¶: Field for tabname

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.PortalTabSection(session=None, **fields)¶

Object for PRTBSC

area¶: Field for area

calendar_portal_section¶: Reference for calendarPortalSection

calendar_portal_section_id¶: Field for calendarPortalSectionID

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

external_section¶: Reference for externalSection

external_section_id¶: Field for externalSectionID

internal_section¶: Reference for internalSection

internal_section_id¶: Field for internalSectionID

portal_section_obj_code¶: Field for portalSectionObjCode

portal_section_obj_id¶: Field for portalSectionObjID

portal_tab¶: Reference for portalTab

portal_tab_id¶: Field for portalTabID

class workfront.versions.unsupported.Portfolio(session=None, **fields)¶

Object for PORT

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

aligned¶: Field for aligned

alignment_score_card¶: Reference for alignmentScoreCard

alignment_score_card_id¶: Field for alignmentScoreCardID

audit_types¶: Field for auditTypes

budget¶: Field for budget

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

currency¶: Field for currency

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

groups¶: Collection for groups

has_documents¶: Field for hasDocuments

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

is_active¶: Field for isActive

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

net_value¶: Field for netValue

object_categories¶: Collection for objectCategories

on_budget¶: Field for onBudget

on_time¶: Field for onTime

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

programs¶: Collection for programs

projects¶: Collection for projects

roi¶: Field for roi

class workfront.versions.unsupported.Predecessor(session=None, **fields)¶

Object for PRED

customer¶: Reference for customer

customer_id¶: Field for customerID

is_cp¶: Field for isCP

is_enforced¶: Field for isEnforced

lag_days¶: Field for lagDays

lag_type¶: Field for lagType

predecessor¶: Reference for predecessor

predecessor_id¶: Field for predecessorID

predecessor_type¶: Field for predecessorType

successor¶: Reference for successor

successor_id¶: Field for successorID

class workfront.versions.unsupported.Preference(session=None, **fields)¶

Object for PROSET

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

value¶: Field for value

class workfront.versions.unsupported.Program(session=None, **fields)¶

Object for PRGM

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

audit_types¶: Field for auditTypes

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

has_documents¶: Field for hasDocuments

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

move(portfolio_id=None, options=None)¶

The move action.

Parameters:	portfolio_id – portfolioID (type: `string`) options – options (type: `string[]`)

name¶: Field for name

object_categories¶: Collection for objectCategories

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

projects¶: Collection for projects

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

class workfront.versions.unsupported.Project(session=None, **fields)¶

Object for PROJ

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

actual_benefit¶: Field for actualBenefit

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration_expression¶: Field for actualDurationExpression

actual_duration_minutes¶: Field for actualDurationMinutes

actual_expense_cost¶: Field for actualExpenseCost

actual_hours_last_month¶: Field for actualHoursLastMonth

actual_hours_last_three_months¶: Field for actualHoursLastThreeMonths

actual_hours_this_month¶: Field for actualHoursThisMonth

actual_hours_two_months_ago¶: Field for actualHoursTwoMonthsAgo

actual_labor_cost¶: Field for actualLaborCost

actual_revenue¶: Field for actualRevenue

actual_risk_cost¶: Field for actualRiskCost

actual_start_date¶: Field for actualStartDate

actual_value¶: Field for actualValue

actual_work_required¶: Field for actualWorkRequired

actual_work_required_expression¶: Field for actualWorkRequiredExpression

alignment¶: Field for alignment

alignment_score_card¶: Reference for alignmentScoreCard

alignment_score_card_id¶: Field for alignmentScoreCardID

alignment_values¶: Collection for alignmentValues

all_approved_hours¶: Field for allApprovedHours

all_hours¶: Collection for allHours

all_priorities¶: Collection for allPriorities

all_statuses¶: Collection for allStatuses

all_unapproved_hours¶: Field for allUnapprovedHours

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approve_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The approveApproval action.

Parameters:	user_id – userID (type: `string`) approval_username – approvalUsername (type: `string`) approval_password – approvalPassword (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

approver_statuses¶: Collection for approverStatuses

approvers_string¶: Field for approversString

async_delete(projects_to_delete=None, force=None)¶

The asyncDelete action.

Parameters:	projects_to_delete – projectsToDelete (type: `string[]`) force – force (type: `boolean`)
Returns:	`string`

attach_template(template_id=None, predecessor_task_id=None, parent_task_id=None, exclude_template_task_ids=None, options=None)¶

The attachTemplate action.

Parameters:	template_id – templateID (type: `string`) predecessor_task_id – predecessorTaskID (type: `string`) parent_task_id – parentTaskID (type: `string`) exclude_template_task_ids – excludeTemplateTaskIDs (type: `string[]`) options – options (type: `string[]`)
Returns:	`string`

attach_template_with_parameter_values(project=None, template_id=None, predecessor_task_id=None, parent_task_id=None, exclude_template_task_ids=None, options=None)¶

The attachTemplateWithParameterValues action.

Parameters:	project – project (type: `Project`) template_id – templateID (type: `string`) predecessor_task_id – predecessorTaskID (type: `string`) parent_task_id – parentTaskID (type: `string`) exclude_template_task_ids – excludeTemplateTaskIDs (type: `string[]`) options – options (type: `string[]`)
Returns:	`string`

audit_types¶: Field for auditTypes

auto_baseline_recur_on¶: Field for autoBaselineRecurOn

auto_baseline_recurrence_type¶: Field for autoBaselineRecurrenceType

awaiting_approvals¶: Collection for awaitingApprovals

baselines¶: Collection for baselines

bccompletion_state¶: Field for BCCompletionState

billed_revenue¶: Field for billedRevenue

billing_records¶: Collection for billingRecords

budget¶: Field for budget

budget_status¶: Field for budgetStatus

budgeted_completion_date¶: Field for budgetedCompletionDate

budgeted_cost¶: Field for budgetedCost

budgeted_hours¶: Field for budgetedHours

budgeted_labor_cost¶: Field for budgetedLaborCost

budgeted_start_date¶: Field for budgetedStartDate

business_case_status_label¶: Field for businessCaseStatusLabel

calculate_data_extension()¶: The calculateDataExtension action.

calculate_finance()¶: The calculateFinance action.

calculate_project_score_values(type=None)¶

The calculateProjectScoreValues action.

Parameters:	type – type (type: `com.attask.common.constants.ScoreCardTypeEnum`)

calculate_timeline()¶: The calculateTimeline action.

category¶: Reference for category

category_id¶: Field for categoryID

company¶: Reference for company

company_id¶: Field for companyID

completion_type¶: Field for completionType

condition¶: Field for condition

condition_type¶: Field for conditionType

converted_op_task_entry_date¶: Field for convertedOpTaskEntryDate

converted_op_task_name¶: Field for convertedOpTaskName

converted_op_task_originator¶: Reference for convertedOpTaskOriginator

converted_op_task_originator_id¶: Field for convertedOpTaskOriginatorID

cpi¶: Field for cpi

create_project_with_override(project=None, exchange_rate=None)¶

The createProjectWithOverride action.

Parameters:	project – project (type: `Project`) exchange_rate – exchangeRate (type: `ExchangeRate`)
Returns:	`string`

csi¶: Field for csi

currency¶: Field for currency

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

customer¶: Reference for customer

customer_id¶: Field for customerID

default_baseline¶: Reference for defaultBaseline

default_forbidden_contribute_actions¶: Field for defaultForbiddenContributeActions

default_forbidden_manage_actions¶: Field for defaultForbiddenManageActions

default_forbidden_view_actions¶: Field for defaultForbiddenViewActions

deliverable_score_card¶: Reference for deliverableScoreCard

deliverable_score_card_id¶: Field for deliverableScoreCardID

deliverable_success_score¶: Field for deliverableSuccessScore

deliverable_success_score_ratio¶: Field for deliverableSuccessScoreRatio

deliverable_values¶: Collection for deliverableValues

description¶: Field for description

display_order¶: Field for displayOrder

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

eac¶: Field for eac

eac_calculation_method¶: Field for eacCalculationMethod

enable_auto_baselines¶: Field for enableAutoBaselines

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

exchange_rate¶: Reference for exchangeRate

exchange_rates¶: Collection for exchangeRates

expenses¶: Collection for expenses

export_as_msproject_file()¶

The exportAsMSProjectFile action.

Returns:	`string`

export_business_case()¶

The exportBusinessCase action.

Returns:	`string`

ext_ref_id¶: Field for extRefID

filter_hour_types¶: Field for filterHourTypes

finance_last_update_date¶: Field for financeLastUpdateDate

fixed_cost¶: Field for fixedCost

fixed_end_date¶: Field for fixedEndDate

fixed_revenue¶: Field for fixedRevenue

fixed_start_date¶: Field for fixedStartDate

get_help_desk_user_can_add_issue()¶

The getHelpDeskUserCanAddIssue action.

Returns:	`java.lang.Boolean`

get_project_currency()¶

The getProjectCurrency action.

Returns:	`string`

group¶: Reference for group

group_id¶: Field for groupID

has_budget_conflict¶: Field for hasBudgetConflict

has_calc_error¶: Field for hasCalcError

has_completion_constraint¶: Field for hasCompletionConstraint

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

has_rate_override¶: Field for hasRateOverride

has_resolvables¶: Field for hasResolvables

has_start_constraint¶: Field for hasStartConstraint

has_timed_notifications¶: Field for hasTimedNotifications

has_timeline_exception¶: Field for hasTimelineException

hour_types¶: Collection for hourTypes

hours¶: Collection for hours

import_msproject_file(file_handle=None, project_name=None)¶

The importMSProjectFile action.

Parameters:	file_handle – fileHandle (type: `string`) project_name – projectName (type: `string`)
Returns:	`string`

is_project_dead¶: Field for isProjectDead

is_status_complete¶: Field for isStatusComplete

last_calc_date¶: Field for lastCalcDate

last_condition_note¶: Reference for lastConditionNote

last_condition_note_id¶: Field for lastConditionNoteID

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_mode¶: Field for levelingMode

lucid_migration_date¶: Field for lucidMigrationDate

milestone_path¶: Reference for milestonePath

milestone_path_id¶: Field for milestonePathID

name¶: Field for name

next_auto_baseline_date¶: Field for nextAutoBaselineDate

notification_records¶: Collection for notificationRecords

number_open_op_tasks¶: Field for numberOpenOpTasks

object_categories¶: Collection for objectCategories

olv¶: Field for olv

open_op_tasks¶: Collection for openOpTasks

optimization_score¶: Field for optimizationScore

owner¶: Reference for owner

owner_id¶: Field for ownerID

owner_privileges¶: Field for ownerPrivileges

parameter_values¶: Collection for parameterValues

pending_calculation¶: Field for pendingCalculation

pending_update_methods¶: Field for pendingUpdateMethods

percent_complete¶: Field for percentComplete

performance_index_method¶: Field for performanceIndexMethod

personal¶: Field for personal

planned_benefit¶: Field for plannedBenefit

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_date_alignment¶: Field for plannedDateAlignment

planned_expense_cost¶: Field for plannedExpenseCost

planned_hours_alignment¶: Field for plannedHoursAlignment

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

planned_risk_cost¶: Field for plannedRiskCost

planned_start_date¶: Field for plannedStartDate

planned_value¶: Field for plannedValue

pop_account¶: Reference for popAccount

pop_account_id¶: Field for popAccountID

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

portfolio_priority¶: Field for portfolioPriority

previous_status¶: Field for previousStatus

priority¶: Field for priority

program¶: Reference for program

program_id¶: Field for programID

progress_status¶: Field for progressStatus

project¶: Reference for project

project_user_roles¶: Collection for projectUserRoles

project_users¶: Collection for projectUsers

projected_completion_date¶: Field for projectedCompletionDate

projected_start_date¶: Field for projectedStartDate

queue_def¶: Reference for queueDef

queue_def_id¶: Field for queueDefID

rates¶: Collection for rates

recall_approval()¶: The recallApproval action.

reference_number¶: Field for referenceNumber

reject_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The rejectApproval action.

Parameters:	user_id – userID (type: `string`) approval_username – approvalUsername (type: `string`) approval_password – approvalPassword (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

remaining_cost¶: Field for remainingCost

remaining_revenue¶: Field for remainingRevenue

remaining_risk_cost¶: Field for remainingRiskCost

remove_users_from_project(user_ids=None)¶

The removeUsersFromProject action.

Parameters:	user_ids – userIDs (type: `string[]`)

resolvables¶: Collection for resolvables

resource_allocations¶: Collection for resourceAllocations

resource_pool¶: Reference for resourcePool

resource_pool_id¶: Field for resourcePoolID

risk¶: Field for risk

risk_performance_index¶: Field for riskPerformanceIndex

risks¶: Collection for risks

roi¶: Field for roi

roles¶: Collection for roles

routing_rules¶: Collection for routingRules

save_project_as_template(template_name=None, exclude_ids=None, options=None)¶

The saveProjectAsTemplate action.

Parameters:	template_name – templateName (type: `string`) exclude_ids – excludeIDs (type: `string[]`) options – options (type: `string[]`)
Returns:	`string`

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

schedule_mode¶: Field for scheduleMode

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

selected_on_portfolio_optimizer¶: Field for selectedOnPortfolioOptimizer

set_budget_to_schedule()¶: The setBudgetToSchedule action.

sharing_settings¶: Reference for sharingSettings

show_condition¶: Field for showCondition

show_status¶: Field for showStatus

spi¶: Field for spi

sponsor¶: Reference for sponsor

sponsor_id¶: Field for sponsorID

status¶: Field for status

status_update¶: Field for statusUpdate

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

summary_completion_type¶: Field for summaryCompletionType

tasks¶: Collection for tasks

team¶: Reference for team

team_id¶: Field for teamID

template¶: Reference for template

template_id¶: Field for templateID

timeline_exception_info¶: Field for timelineExceptionInfo

total_hours¶: Field for totalHours

total_op_task_count¶: Field for totalOpTaskCount

total_task_count¶: Field for totalTaskCount

update_type¶: Field for updateType

updates¶: Collection for updates

url¶: Field for URL

version¶: Field for version

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

class workfront.versions.unsupported.ProjectUser(session=None, **fields)¶

Object for PRTU

customer¶: Reference for customer

customer_id¶: Field for customerID

project¶: Reference for project

project_id¶: Field for projectID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.ProjectUserRole(session=None, **fields)¶

Object for PTEAM

customer¶: Reference for customer

customer_id¶: Field for customerID

project¶: Reference for project

project_id¶: Field for projectID

role¶: Reference for role

role_id¶: Field for roleID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.QueueDef(session=None, **fields)¶

Object for QUED

accessor_ids¶: Field for accessorIDs

add_op_task_style¶: Field for addOpTaskStyle

allowed_legacy_queue_topic_ids¶: Field for allowedLegacyQueueTopicIDs

allowed_op_task_types¶: Field for allowedOpTaskTypes

allowed_queue_topic_ids¶: Field for allowedQueueTopicIDs

customer¶: Reference for customer

customer_id¶: Field for customerID

default_approval_process¶: Reference for defaultApprovalProcess

default_approval_process_id¶: Field for defaultApprovalProcessID

default_category¶: Reference for defaultCategory

default_category_id¶: Field for defaultCategoryID

default_duration_expression¶: Field for defaultDurationExpression

default_duration_minutes¶: Field for defaultDurationMinutes

default_duration_unit¶: Field for defaultDurationUnit

default_route¶: Reference for defaultRoute

default_route_id¶: Field for defaultRouteID

default_topic_group_id¶: Field for defaultTopicGroupID

ext_ref_id¶: Field for extRefID

has_queue_topics¶: Field for hasQueueTopics

is_public¶: Field for isPublic

object_categories¶: Collection for objectCategories

project¶: Reference for project

project_id¶: Field for projectID

queue_topics¶: Collection for queueTopics

requestor_core_action¶: Field for requestorCoreAction

requestor_forbidden_actions¶: Field for requestorForbiddenActions

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

share_mode¶: Field for shareMode

template¶: Reference for template

template_id¶: Field for templateID

visible_op_task_fields¶: Field for visibleOpTaskFields

class workfront.versions.unsupported.QueueTopic(session=None, **fields)¶

Object for QUET

accessor_ids¶: Field for accessorIDs

allowed_op_task_types¶: Field for allowedOpTaskTypes

allowed_op_task_types_pretty_print¶: Field for allowedOpTaskTypesPrettyPrint

customer¶: Reference for customer

customer_id¶: Field for customerID

default_approval_process¶: Reference for defaultApprovalProcess

default_approval_process_id¶: Field for defaultApprovalProcessID

default_category¶: Reference for defaultCategory

default_category_id¶: Field for defaultCategoryID

default_duration¶: Field for defaultDuration

default_duration_expression¶: Field for defaultDurationExpression

default_duration_minutes¶: Field for defaultDurationMinutes

default_duration_unit¶: Field for defaultDurationUnit

default_route¶: Reference for defaultRoute

default_route_id¶: Field for defaultRouteID

description¶: Field for description

ext_ref_id¶: Field for extRefID

indented_name¶: Field for indentedName

name¶: Field for name

object_categories¶: Collection for objectCategories

parent_topic¶: Reference for parentTopic

parent_topic_group¶: Reference for parentTopicGroup

parent_topic_group_id¶: Field for parentTopicGroupID

parent_topic_id¶: Field for parentTopicID

queue_def¶: Reference for queueDef

queue_def_id¶: Field for queueDefID

class workfront.versions.unsupported.QueueTopicGroup(session=None, **fields)¶

Object for QUETGP

accessor_ids¶: Field for accessorIDs

associated_topics¶: Field for associatedTopics

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

name¶: Field for name

parent¶: Reference for parent

parent_id¶: Field for parentID

queue_def¶: Reference for queueDef

queue_def_id¶: Field for queueDefID

queue_topic_groups¶: Collection for queueTopicGroups

queue_topics¶: Collection for queueTopics

class workfront.versions.unsupported.Rate(session=None, **fields)¶

Object for RATE

accessor_ids¶: Field for accessorIDs

company¶: Reference for company

company_id¶: Field for companyID

customer¶: Reference for customer

customer_id¶: Field for customerID

ext_ref_id¶: Field for extRefID

project¶: Reference for project

project_id¶: Field for projectID

rate_value¶: Field for rateValue

role¶: Reference for role

role_id¶: Field for roleID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.Recent(session=None, **fields)¶

Object for RECENT

customer¶: Reference for customer

customer_id¶: Field for customerID

last_viewed_date¶: Field for lastViewedDate

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

update_last_viewed_object()¶

The updateLastViewedObject action.

Returns:	`string`

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.RecentMenuItem(session=None, **fields)¶

Object for RECENTMENUITEM

allowed_actions¶: Field for allowedActions

bulk_delete_recent(obj_code=None, obj_ids=None)¶

The bulkDeleteRecent action.

Parameters:	obj_code – objCode (type: `string`) obj_ids – objIDs (type: `string[]`)

date_added¶: Field for dateAdded

delete_recent(obj_code=None, obj_id=None)¶

The deleteRecent action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

recent_item_string¶: Field for recentItemString

rotate_recent_menu(obj_code=None, obj_id=None)¶

The rotateRecentMenu action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

class workfront.versions.unsupported.RecentUpdate(session=None, **fields)¶

Object for RUPDTE

author_id¶: Field for authorID

author_name¶: Field for authorName

customer¶: Reference for customer

customer_id¶: Field for customerID

entry_date¶: Field for entryDate

is_private¶: Field for isPrivate

issue_id¶: Field for issueID

issue_name¶: Field for issueName

iteration_id¶: Field for iterationID

iteration_name¶: Field for iterationName

last_updated_on_date¶: Field for lastUpdatedOnDate

latest_comment¶: Field for latestComment

latest_comment_author_id¶: Field for latestCommentAuthorID

latest_comment_author_name¶: Field for latestCommentAuthorName

latest_comment_entry_date¶: Field for latestCommentEntryDate

latest_comment_id¶: Field for latestCommentID

number_of_comments¶: Field for numberOfComments

project_id¶: Field for projectID

project_name¶: Field for projectName

task_id¶: Field for taskID

task_name¶: Field for taskName

team_id¶: Field for teamID

thread_id¶: Field for threadID

update¶: Field for update

update_id¶: Field for updateID

user_id¶: Field for userID

class workfront.versions.unsupported.RecurrenceRule(session=None, **fields)¶

Object for RECR

customer¶: Reference for customer

customer_id¶: Field for customerID

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

duration_unit¶: Field for durationUnit

end_date¶: Field for endDate

recur_on¶: Field for recurOn

recurrence_count¶: Field for recurrenceCount

recurrence_interval¶: Field for recurrenceInterval

recurrence_type¶: Field for recurrenceType

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

start_date¶: Field for startDate

task¶: Reference for task

task_id¶: Field for taskID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

use_end_date¶: Field for useEndDate

class workfront.versions.unsupported.ReportFolder(session=None, **fields)¶

Object for RPTFDR

customer¶: Reference for customer

customer_id¶: Field for customerID

name¶: Field for name

class workfront.versions.unsupported.Reseller(session=None, **fields)¶

Object for RSELR

account_reps¶: Collection for accountReps

address¶: Field for address

address2¶: Field for address2

city¶: Field for city

country¶: Field for country

description¶: Field for description

email¶: Field for email

ext_ref_id¶: Field for extRefID

is_active¶: Field for isActive

name¶: Field for name

phone_number¶: Field for phoneNumber

postal_code¶: Field for postalCode

state¶: Field for state

class workfront.versions.unsupported.ReservedTime(session=None, **fields)¶

Object for RESVT

customer¶: Reference for customer

customer_id¶: Field for customerID

end_date¶: Field for endDate

start_date¶: Field for startDate

task¶: Reference for task

task_id¶: Field for taskID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.ResourceAllocation(session=None, **fields)¶

Object for RSALLO

accessor_ids¶: Field for accessorIDs

allocation_date¶: Field for allocationDate

budgeted_hours¶: Field for budgetedHours

customer¶: Reference for customer

customer_id¶: Field for customerID

is_split¶: Field for isSplit

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

project¶: Reference for project

project_id¶: Field for projectID

projected_scheduled_hours¶: Field for projectedScheduledHours

resource_pool¶: Reference for resourcePool

resource_pool_id¶: Field for resourcePoolID

role¶: Reference for role

role_id¶: Field for roleID

scheduled_hours¶: Field for scheduledHours

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

class workfront.versions.unsupported.ResourcePool(session=None, **fields)¶

Object for RSPOOL

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_order¶: Field for displayOrder

ext_ref_id¶: Field for extRefID

name¶: Field for name

resource_allocations¶: Collection for resourceAllocations

roles¶: Collection for roles

users¶: Collection for users

class workfront.versions.unsupported.Risk(session=None, **fields)¶

Object for RISK

accessor_ids¶: Field for accessorIDs

actual_cost¶: Field for actualCost

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

estimated_effect¶: Field for estimatedEffect

ext_ref_id¶: Field for extRefID

mitigation_cost¶: Field for mitigationCost

mitigation_description¶: Field for mitigationDescription

probability¶: Field for probability

project¶: Reference for project

project_id¶: Field for projectID

risk_type¶: Reference for riskType

risk_type_id¶: Field for riskTypeID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

status¶: Field for status

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.RiskType(session=None, **fields)¶

Object for RSKTYP

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

ext_ref_id¶: Field for extRefID

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

name¶: Field for name

class workfront.versions.unsupported.Role(session=None, **fields)¶

Object for ROLE

add_early_access(ids=None)¶

The addEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

billing_per_hour¶: Field for billingPerHour

cost_per_hour¶: Field for costPerHour

customer¶: Reference for customer

customer_id¶: Field for customerID

default_interface¶: Field for defaultInterface

delete_early_access(ids=None)¶

The deleteEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

max_users¶: Field for maxUsers

name¶: Field for name

class workfront.versions.unsupported.RoutingRule(session=None, **fields)¶

Object for RRUL

accessor_ids¶: Field for accessorIDs

customer¶: Reference for customer

customer_id¶: Field for customerID

default_assigned_to¶: Reference for defaultAssignedTo

default_assigned_to_id¶: Field for defaultAssignedToID

default_project¶: Reference for defaultProject

default_project_id¶: Field for defaultProjectID

default_role¶: Reference for defaultRole

default_role_id¶: Field for defaultRoleID

default_team¶: Reference for defaultTeam

default_team_id¶: Field for defaultTeamID

description¶: Field for description

name¶: Field for name

project¶: Reference for project

project_id¶: Field for projectID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.S3Migration(session=None, **fields)¶

Object for S3MT

customer¶: Reference for customer

customer_id¶: Field for customerID

migration_date¶: Field for migrationDate

status¶: Field for status

class workfront.versions.unsupported.SSOMapping(session=None, **fields)¶

Object for SSOMAP

attask_attribute¶: Field for attaskAttribute

customer¶: Reference for customer

customer_id¶: Field for customerID

default_attribute¶: Field for defaultAttribute

has_mapping_rules¶: Field for hasMappingRules

mapping_rules¶: Collection for mappingRules

override_attribute¶: Field for overrideAttribute

remote_attribute¶: Field for remoteAttribute

sso_option_id¶: Field for ssoOptionID

class workfront.versions.unsupported.SSOMappingRule(session=None, **fields)¶

Object for SSOMR

attask_attribute¶: Field for attaskAttribute

customer¶: Reference for customer

customer_id¶: Field for customerID

matching_rule¶: Field for matchingRule

remote_attribute¶: Field for remoteAttribute

sso_mapping_id¶: Field for ssoMappingID

class workfront.versions.unsupported.SSOOption(session=None, **fields)¶

Object for SSOPT

active_directory_domain¶: Field for activeDirectoryDomain

authentication_type¶: Field for authenticationType

binding_type¶: Field for bindingType

certificate¶: Field for certificate

change_password_url¶: Field for changePasswordURL

customer¶: Reference for customer

customer_id¶: Field for customerID

exclude_users¶: Field for excludeUsers

hosted_entity_id¶: Field for hostedEntityID

is_admin_back_door_access_allowed¶: Field for isAdminBackDoorAccessAllowed

provider_port¶: Field for providerPort

provider_url¶: Field for providerURL

provision_users¶: Field for provisionUsers

remote_entity_id¶: Field for remoteEntityID

require_sslconnection¶: Field for requireSSLConnection

search_attribute¶: Field for searchAttribute

search_base¶: Field for searchBase

signout_url¶: Field for signoutURL

sso_mappings¶: Collection for ssoMappings

ssoenabled¶: Field for SSOEnabled

trusted_domain¶: Field for trustedDomain

upload_saml2metadata(handle=None)¶

The uploadSAML2Metadata action.

Parameters:	handle – handle (type: `string`)
Returns:	`string`

upload_ssocertificate(handle=None)¶

The uploadSSOCertificate action.

Parameters:	handle – handle (type: `string`)

class workfront.versions.unsupported.SSOUsername(session=None, **fields)¶

Object for SSOUSR

customer_id¶: Field for customerID

name¶: Field for name

user_id¶: Field for userID

class workfront.versions.unsupported.SandboxMigration(session=None, **fields)¶

Object for SNDMG

cancel_scheduled_migration()¶: The cancelScheduledMigration action.

customer¶: Reference for customer

customer_id¶: Field for customerID

domain¶: Field for domain

end_date¶: Field for endDate

last_refresh_date¶: Field for lastRefreshDate

last_refresh_duration¶: Field for lastRefreshDuration

migrate_now()¶: The migrateNow action.

migration_estimate()¶

The migrationEstimate action.

Returns:	`map`

migration_queue_duration()¶

The migrationQueueDuration action.

Returns:	`java.lang.Integer`

notified¶: Field for notified

sandbox_type¶: Field for sandboxType

schedule_date¶: Field for scheduleDate

schedule_migration(schedule_date=None)¶

The scheduleMigration action.

Parameters:	schedule_date – scheduleDate (type: `dateTime`)

start_date¶: Field for startDate

status¶: Field for status

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.Schedule(session=None, **fields)¶

Object for SCHED

customer¶: Reference for customer

customer_id¶: Field for customerID

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

friday¶: Field for friday

get_earliest_work_time_of_day(date=None)¶

The getEarliestWorkTimeOfDay action.

Parameters:	date – date (type: `dateTime`)
Returns:	`dateTime`

get_latest_work_time_of_day(date=None)¶

The getLatestWorkTimeOfDay action.

Parameters:	date – date (type: `dateTime`)
Returns:	`dateTime`

get_next_completion_date(date=None, cost_in_minutes=None)¶

The getNextCompletionDate action.

Parameters:	date – date (type: `dateTime`) cost_in_minutes – costInMinutes (type: `int`)
Returns:	`dateTime`

get_next_start_date(date=None)¶

The getNextStartDate action.

Parameters:	date – date (type: `dateTime`)
Returns:	`dateTime`

group¶: Reference for group

group_id¶: Field for groupID

has_non_work_days¶: Field for hasNonWorkDays

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

is_default¶: Field for isDefault

monday¶: Field for monday

name¶: Field for name

non_work_days¶: Collection for nonWorkDays

other_groups¶: Collection for otherGroups

saturday¶: Field for saturday

sunday¶: Field for sunday

thursday¶: Field for thursday

time_zone¶: Field for timeZone

tuesday¶: Field for tuesday

wednesday¶: Field for wednesday

class workfront.versions.unsupported.ScheduledReport(session=None, **fields)¶

Object for SCHREP

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

external_emails¶: Field for externalEmails

format¶: Field for format

group_ids¶: Field for groupIDs

groups¶: Collection for groups

last_runtime_milliseconds¶: Field for lastRuntimeMilliseconds

last_sent_date¶: Field for lastSentDate

name¶: Field for name

page_size¶: Field for pageSize

portal_section¶: Reference for portalSection

portal_section_id¶: Field for portalSectionID

recipients¶: Field for recipients

recurrence_rule¶: Field for recurrenceRule

role_ids¶: Field for roleIDs

roles¶: Collection for roles

run_as_user¶: Reference for runAsUser

run_as_user_id¶: Field for runAsUserID

run_as_user_type_ahead¶: Field for runAsUserTypeAhead

sched_time¶: Field for schedTime

schedule¶: Field for schedule

schedule_start¶: Field for scheduleStart

send_report_delivery_now(user_ids=None, team_ids=None, group_ids=None, role_ids=None, external_emails=None, delivery_options=None)¶

The sendReportDeliveryNow action.

Parameters:	user_ids – userIDs (type: `string[]`) team_ids – teamIDs (type: `string[]`) group_ids – groupIDs (type: `string[]`) role_ids – roleIDs (type: `string[]`) external_emails – externalEmails (type: `string`) delivery_options – deliveryOptions (type: `map`)
Returns:	`java.lang.Integer`

start_date¶: Field for startDate

team_ids¶: Field for teamIDs

teams¶: Collection for teams

ui_obj_code¶: Field for uiObjCode

ui_obj_id¶: Field for uiObjID

user_ids¶: Field for userIDs

users¶: Collection for users

class workfront.versions.unsupported.ScoreCard(session=None, **fields)¶

Object for SCORE

accessor_ids¶: Field for accessorIDs

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

ext_ref_id¶: Field for extRefID

is_public¶: Field for isPublic

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

project¶: Reference for project

project_id¶: Field for projectID

score_card_questions¶: Collection for scoreCardQuestions

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.ScoreCardAnswer(session=None, **fields)¶

Object for SCANS

customer¶: Reference for customer

customer_id¶: Field for customerID

number_val¶: Field for numberVal

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

project¶: Reference for project

project_id¶: Field for projectID

score_card¶: Reference for scoreCard

score_card_id¶: Field for scoreCardID

score_card_option¶: Reference for scoreCardOption

score_card_option_id¶: Field for scoreCardOptionID

score_card_question¶: Reference for scoreCardQuestion

score_card_question_id¶: Field for scoreCardQuestionID

template¶: Reference for template

template_id¶: Field for templateID

type¶: Field for type

class workfront.versions.unsupported.ScoreCardOption(session=None, **fields)¶

Object for SCOPT

customer¶: Reference for customer

customer_id¶: Field for customerID

display_order¶: Field for displayOrder

is_default¶: Field for isDefault

is_hidden¶: Field for isHidden

label¶: Field for label

score_card_question¶: Reference for scoreCardQuestion

score_card_question_id¶: Field for scoreCardQuestionID

value¶: Field for value

class workfront.versions.unsupported.ScoreCardQuestion(session=None, **fields)¶

Object for SCOREQ

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

display_order¶: Field for displayOrder

display_type¶: Field for displayType

name¶: Field for name

score_card¶: Reference for scoreCard

score_card_id¶: Field for scoreCardID

score_card_options¶: Collection for scoreCardOptions

weight¶: Field for weight

class workfront.versions.unsupported.SearchEvent(session=None, **fields)¶

Object for SRCEVT

customer_id¶: Field for customerID

entry_date¶: Field for entryDate

event_obj_code¶: Field for eventObjCode

event_type¶: Field for eventType

obj_ids¶: Field for objIDs

class workfront.versions.unsupported.SecurityAncestor(session=None, **fields)¶

Object for SECANC

ancestor_id¶: Field for ancestorID

ancestor_obj_code¶: Field for ancestorObjCode

customer¶: Reference for customer

customer_id¶: Field for customerID

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

class workfront.versions.unsupported.Sequence(session=None, **fields)¶

Object for SEQ

customer¶: Reference for customer

customer_id¶: Field for customerID

seq_name¶: Field for seqName

seq_value¶: Field for seqValue

class workfront.versions.unsupported.SharingSettings(session=None, **fields)¶

Object for SHRSET

accessor_ids¶: Field for accessorIDs

customer¶: Reference for customer

customer_id¶: Field for customerID

op_task_assignment_core_action¶: Field for opTaskAssignmentCoreAction

op_task_assignment_project_core_action¶: Field for opTaskAssignmentProjectCoreAction

op_task_assignment_project_secondary_actions¶: Field for opTaskAssignmentProjectSecondaryActions

op_task_assignment_secondary_actions¶: Field for opTaskAssignmentSecondaryActions

project¶: Reference for project

project_id¶: Field for projectID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

task_assignment_core_action¶: Field for taskAssignmentCoreAction

task_assignment_project_core_action¶: Field for taskAssignmentProjectCoreAction

task_assignment_project_secondary_actions¶: Field for taskAssignmentProjectSecondaryActions

task_assignment_secondary_actions¶: Field for taskAssignmentSecondaryActions

template¶: Reference for template

template_id¶: Field for templateID

class workfront.versions.unsupported.StepApprover(session=None, **fields)¶

Object for SPAPVR

approval_step¶: Reference for approvalStep

approval_step_id¶: Field for approvalStepID

customer¶: Reference for customer

customer_id¶: Field for customerID

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

wild_card¶: Field for wildCard

class workfront.versions.unsupported.Task(session=None, **fields)¶

Object for TASK

accept_work()¶: The acceptWork action.

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration¶: Field for actualDuration

actual_duration_minutes¶: Field for actualDurationMinutes

actual_expense_cost¶: Field for actualExpenseCost

actual_labor_cost¶: Field for actualLaborCost

actual_revenue¶: Field for actualRevenue

actual_start_date¶: Field for actualStartDate

actual_work¶: Field for actualWork

actual_work_required¶: Field for actualWorkRequired

add_comment(text)¶

Add a comment to the current object containing the supplied text.

The new Comment instance is returned, it does not need to be saved.

all_priorities¶: Collection for allPriorities

all_statuses¶: Collection for allStatuses

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The approveApproval action.

Parameters:	user_id – userID (type: `string`) username – username (type: `string`) password – password (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

approver_statuses¶: Collection for approverStatuses

approvers_string¶: Field for approversString

assign(obj_id=None, obj_code=None)¶

The assign action.

Parameters:	obj_id – objID (type: `string`) obj_code – objCode (type: `string`)

assign_multiple(user_ids=None, role_ids=None, team_id=None)¶

The assignMultiple action.

Parameters:	user_ids – userIDs (type: `string[]`) role_ids – roleIDs (type: `string[]`) team_id – teamID (type: `string`)

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

assignments_list_string¶: Field for assignmentsListString

audit_note¶: Field for auditNote

audit_types¶: Field for auditTypes

audit_user_ids¶: Field for auditUserIDs

awaiting_approvals¶: Collection for awaitingApprovals

backlog_order¶: Field for backlogOrder

billing_amount¶: Field for billingAmount

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

bulk_copy(task_ids=None, project_id=None, parent_id=None, options=None)¶

The bulkCopy action.

Parameters:	task_ids – taskIDs (type: `string[]`) project_id – projectID (type: `string`) parent_id – parentID (type: `string`) options – options (type: `string[]`)
Returns:	`string[]`

bulk_move(task_ids=None, project_id=None, parent_id=None, options=None)¶

The bulkMove action.

Parameters:	task_ids – taskIDs (type: `string[]`) project_id – projectID (type: `string`) parent_id – parentID (type: `string`) options – options (type: `string[]`)

calculate_data_extension()¶: The calculateDataExtension action.

calculate_data_extensions(ids=None)¶

The calculateDataExtensions action.

Parameters:	ids – ids (type: `string[]`)

can_start¶: Field for canStart

category¶: Reference for category

category_id¶: Field for categoryID

children¶: Collection for children

color¶: Field for color

commit_date¶: Field for commitDate

commit_date_range¶: Field for commitDateRange

completion_pending_date¶: Field for completionPendingDate

condition¶: Field for condition

constraint_date¶: Field for constraintDate

convert_to_project(project=None, exchange_rate=None)¶

The convertToProject action.

Parameters:	project – project (type: `Project`) exchange_rate – exchangeRate (type: `ExchangeRate`)
Returns:	`string`

converted_op_task_entry_date¶: Field for convertedOpTaskEntryDate

converted_op_task_name¶: Field for convertedOpTaskName

converted_op_task_originator¶: Reference for convertedOpTaskOriginator

converted_op_task_originator_id¶: Field for convertedOpTaskOriginatorID

cost_amount¶: Field for costAmount

cost_type¶: Field for costType

cpi¶: Field for cpi

csi¶: Field for csi

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

customer¶: Reference for customer

customer_id¶: Field for customerID

days_late¶: Field for daysLate

default_baseline_task¶: Reference for defaultBaselineTask

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

done_statuses¶: Collection for doneStatuses

due_date¶: Field for dueDate

duration¶: Field for duration

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

duration_type¶: Field for durationType

duration_unit¶: Field for durationUnit

eac¶: Field for eac

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

estimate¶: Field for estimate

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

group¶: Reference for group

group_id¶: Field for groupID

handoff_date¶: Field for handoffDate

has_completion_constraint¶: Field for hasCompletionConstraint

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

has_resolvables¶: Field for hasResolvables

has_start_constraint¶: Field for hasStartConstraint

has_timed_notifications¶: Field for hasTimedNotifications

hours¶: Collection for hours

hours_per_point¶: Field for hoursPerPoint

indent¶: Field for indent

is_agile¶: Field for isAgile

is_critical¶: Field for isCritical

is_duration_locked¶: Field for isDurationLocked

is_leveling_excluded¶: Field for isLevelingExcluded

is_ready¶: Field for isReady

is_status_complete¶: Field for isStatusComplete

is_work_required_locked¶: Field for isWorkRequiredLocked

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

last_condition_note¶: Reference for lastConditionNote

last_condition_note_id¶: Field for lastConditionNoteID

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_start_delay¶: Field for levelingStartDelay

leveling_start_delay_expression¶: Field for levelingStartDelayExpression

leveling_start_delay_minutes¶: Field for levelingStartDelayMinutes

mark_done(status=None)¶

The markDone action.

Parameters:	status – status (type: `string`)

mark_not_done(assignment_id=None)¶

The markNotDone action.

Parameters:	assignment_id – assignmentID (type: `string`)

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

milestone¶: Reference for milestone

milestone_id¶: Field for milestoneID

move(project_id=None, parent_id=None, options=None)¶

The move action.

Parameters:	project_id – projectID (type: `string`) parent_id – parentID (type: `string`) options – options (type: `string[]`)

name¶: Field for name

notification_records¶: Collection for notificationRecords

number_of_children¶: Field for numberOfChildren

number_open_op_tasks¶: Field for numberOpenOpTasks

object_categories¶: Collection for objectCategories

olv¶: Field for olv

op_tasks¶: Collection for opTasks

open_op_tasks¶: Collection for openOpTasks

original_duration¶: Field for originalDuration

original_work_required¶: Field for originalWorkRequired

parameter_values¶: Collection for parameterValues

parent¶: Reference for parent

parent_id¶: Field for parentID

parent_lag¶: Field for parentLag

parent_lag_type¶: Field for parentLagType

pending_calculation¶: Field for pendingCalculation

pending_predecessors¶: Field for pendingPredecessors

pending_update_methods¶: Field for pendingUpdateMethods

percent_complete¶: Field for percentComplete

personal¶: Field for personal

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_date_alignment¶: Field for plannedDateAlignment

planned_duration¶: Field for plannedDuration

planned_duration_minutes¶: Field for plannedDurationMinutes

planned_expense_cost¶: Field for plannedExpenseCost

planned_hours_alignment¶: Field for plannedHoursAlignment

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

planned_start_date¶: Field for plannedStartDate

predecessor_expression¶: Field for predecessorExpression

predecessors¶: Collection for predecessors

previous_status¶: Field for previousStatus

primary_assignment¶: Reference for primaryAssignment

priority¶: Field for priority

progress_status¶: Field for progressStatus

project¶: Reference for project

project_id¶: Field for projectID

projected_completion_date¶: Field for projectedCompletionDate

projected_duration_minutes¶: Field for projectedDurationMinutes

projected_start_date¶: Field for projectedStartDate

recall_approval()¶: The recallApproval action.

recurrence_number¶: Field for recurrenceNumber

recurrence_rule¶: Reference for recurrenceRule

recurrence_rule_id¶: Field for recurrenceRuleID

reference_number¶: Field for referenceNumber

reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶

The rejectApproval action.

Parameters:	user_id – userID (type: `string`) username – username (type: `string`) password – password (type: `string`) audit_note – auditNote (type: `string`) audit_user_ids – auditUserIDs (type: `string[]`) send_note_as_email – sendNoteAsEmail (type: `boolean`)

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

remaining_duration_minutes¶: Field for remainingDurationMinutes

reply_to_assignment(note_text=None, commit_date=None)¶

The replyToAssignment action.

Parameters:	note_text – noteText (type: `string`) commit_date – commitDate (type: `dateTime`)

reserved_time¶: Reference for reservedTime

reserved_time_id¶: Field for reservedTimeID

resolvables¶: Collection for resolvables

resource_scope¶: Field for resourceScope

revenue_type¶: Field for revenueType

role¶: Reference for role

role_id¶: Field for roleID

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

show_commit_date¶: Field for showCommitDate

show_condition¶: Field for showCondition

show_status¶: Field for showStatus

slack_date¶: Field for slackDate

spi¶: Field for spi

status¶: Field for status

status_equates_with¶: Field for statusEquatesWith

status_update¶: Field for statusUpdate

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

successors¶: Collection for successors

task_constraint¶: Field for taskConstraint

task_number¶: Field for taskNumber

task_number_predecessor_string¶: Field for taskNumberPredecessorString

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

timed_notifications(notification_ids=None)¶

The timedNotifications action.

Parameters:	notification_ids – notificationIDs (type: `string[]`)

tracking_mode¶: Field for trackingMode

unaccept_work()¶: The unacceptWork action.

unassign(user_id=None)¶

The unassign action.

Parameters:	user_id – userID (type: `string`)

unassign_occurrences(user_id=None)¶

The unassignOccurrences action.

Parameters:	user_id – userID (type: `string`)
Returns:	`string[]`

updates¶: Collection for updates

url¶: Field for URL

version¶: Field for version

wbs¶: Field for wbs

work¶: Field for work

work_item¶: Reference for workItem

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

work_unit¶: Field for workUnit

class workfront.versions.unsupported.Team(session=None, **fields)¶

Object for TEAMOB

add_early_access(ids=None)¶

The addEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

backlog_tasks¶: Collection for backlogTasks

customer¶: Reference for customer

customer_id¶: Field for customerID

default_interface¶: Field for defaultInterface

delete_early_access(ids=None)¶

The deleteEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

description¶: Field for description

estimate_by_hours¶: Field for estimateByHours

hours_per_point¶: Field for hoursPerPoint

is_agile¶: Field for isAgile

is_standard_issue_list¶: Field for isStandardIssueList

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

move_tasks_on_team_backlog(team_id=None, start_number=None, end_number=None, move_to_number=None, moving_task_ids=None)¶

The moveTasksOnTeamBacklog action.

Parameters:	team_id – teamID (type: `string`) start_number – startNumber (type: `int`) end_number – endNumber (type: `int`) move_to_number – moveToNumber (type: `int`) moving_task_ids – movingTaskIDs (type: `string[]`)

my_work_view¶: Reference for myWorkView

my_work_view_id¶: Field for myWorkViewID

name¶: Field for name

op_task_bug_report_statuses¶: Field for opTaskBugReportStatuses

op_task_change_order_statuses¶: Field for opTaskChangeOrderStatuses

op_task_issue_statuses¶: Field for opTaskIssueStatuses

op_task_request_statuses¶: Field for opTaskRequestStatuses

owner¶: Reference for owner

owner_id¶: Field for ownerID

requests_view¶: Reference for requestsView

requests_view_id¶: Field for requestsViewID

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

task_statuses¶: Field for taskStatuses

team_member_roles¶: Collection for teamMemberRoles

team_members¶: Collection for teamMembers

team_story_board_statuses¶: Field for teamStoryBoardStatuses

team_type¶: Field for teamType

updates¶: Collection for updates

users¶: Collection for users

class workfront.versions.unsupported.TeamMember(session=None, **fields)¶

Object for TEAMMB

adhoc_team¶: Field for adhocTeam

customer¶: Reference for customer

customer_id¶: Field for customerID

has_assign_permissions¶: Field for hasAssignPermissions

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.TeamMemberRole(session=None, **fields)¶

Object for TEAMMR

customer¶: Reference for customer

customer_id¶: Field for customerID

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_id¶: Field for teamID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.Template(session=None, **fields)¶

Object for TMPL

access_rule_preferences¶: Collection for accessRulePreferences

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

auto_baseline_recur_on¶: Field for autoBaselineRecurOn

auto_baseline_recurrence_type¶: Field for autoBaselineRecurrenceType

budget¶: Field for budget

calculate_data_extension()¶: The calculateDataExtension action.

calculate_timeline()¶

The calculateTimeline action.

Returns:	`string`

category¶: Reference for category

category_id¶: Field for categoryID

company¶: Reference for company

company_id¶: Field for companyID

completion_day¶: Field for completionDay

completion_type¶: Field for completionType

condition_type¶: Field for conditionType

currency¶: Field for currency

customer¶: Reference for customer

customer_id¶: Field for customerID

default_forbidden_contribute_actions¶: Field for defaultForbiddenContributeActions

default_forbidden_manage_actions¶: Field for defaultForbiddenManageActions

default_forbidden_view_actions¶: Field for defaultForbiddenViewActions

deliverable_score_card¶: Reference for deliverableScoreCard

deliverable_score_card_id¶: Field for deliverableScoreCardID

deliverable_success_score¶: Field for deliverableSuccessScore

deliverable_values¶: Collection for deliverableValues

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

enable_auto_baselines¶: Field for enableAutoBaselines

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

exchange_rate¶: Reference for exchangeRate

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

filter_hour_types¶: Field for filterHourTypes

fixed_cost¶: Field for fixedCost

fixed_revenue¶: Field for fixedRevenue

get_template_currency()¶

The getTemplateCurrency action.

Returns:	`string`

groups¶: Collection for groups

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_notes¶: Field for hasNotes

has_timed_notifications¶: Field for hasTimedNotifications

hour_types¶: Collection for hourTypes

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_mode¶: Field for levelingMode

milestone_path¶: Reference for milestonePath

milestone_path_id¶: Field for milestonePathID

name¶: Field for name

notification_records¶: Collection for notificationRecords

object_categories¶: Collection for objectCategories

olv¶: Field for olv

owner¶: Reference for owner

owner_id¶: Field for ownerID

owner_privileges¶: Field for ownerPrivileges

parameter_values¶: Collection for parameterValues

pending_calculation¶: Field for pendingCalculation

pending_update_methods¶: Field for pendingUpdateMethods

performance_index_method¶: Field for performanceIndexMethod

planned_benefit¶: Field for plannedBenefit

planned_cost¶: Field for plannedCost

planned_expense_cost¶: Field for plannedExpenseCost

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

planned_risk_cost¶: Field for plannedRiskCost

portfolio¶: Reference for portfolio

portfolio_id¶: Field for portfolioID

priority¶: Field for priority

program¶: Reference for program

program_id¶: Field for programID

queue_def¶: Reference for queueDef

queue_def_id¶: Field for queueDefID

rates¶: Collection for rates

reference_number¶: Field for referenceNumber

remove_users_from_template(user_ids=None)¶

The removeUsersFromTemplate action.

Parameters:	user_ids – userIDs (type: `string[]`)

risk¶: Field for risk

risks¶: Collection for risks

roles¶: Collection for roles

routing_rules¶: Collection for routingRules

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

schedule_mode¶: Field for scheduleMode

set_access_rule_preferences(access_rule_preferences=None)¶

The setAccessRulePreferences action.

Parameters:	access_rule_preferences – accessRulePreferences (type: `string[]`)

sharing_settings¶: Reference for sharingSettings

sponsor¶: Reference for sponsor

sponsor_id¶: Field for sponsorID

start_day¶: Field for startDay

summary_completion_type¶: Field for summaryCompletionType

team¶: Reference for team

team_id¶: Field for teamID

template_tasks¶: Collection for templateTasks

template_user_roles¶: Collection for templateUserRoles

template_users¶: Collection for templateUsers

update_type¶: Field for updateType

updates¶: Collection for updates

url¶: Field for URL

version¶: Field for version

work_required¶: Field for workRequired

class workfront.versions.unsupported.TemplateAssignment(session=None, **fields)¶

Object for TASSGN

accessor_ids¶: Field for accessorIDs

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignment_percent¶: Field for assignmentPercent

customer¶: Reference for customer

customer_id¶: Field for customerID

is_primary¶: Field for isPrimary

is_team_assignment¶: Field for isTeamAssignment

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

role¶: Reference for role

role_id¶: Field for roleID

team¶: Reference for team

team_id¶: Field for teamID

template¶: Reference for template

template_id¶: Field for templateID

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

work¶: Field for work

work_required¶: Field for workRequired

work_unit¶: Field for workUnit

class workfront.versions.unsupported.TemplatePredecessor(session=None, **fields)¶

Object for TPRED

customer¶: Reference for customer

customer_id¶: Field for customerID

is_enforced¶: Field for isEnforced

lag_days¶: Field for lagDays

lag_type¶: Field for lagType

predecessor¶: Reference for predecessor

predecessor_id¶: Field for predecessorID

predecessor_type¶: Field for predecessorType

successor¶: Reference for successor

successor_id¶: Field for successorID

class workfront.versions.unsupported.TemplateTask(session=None, **fields)¶

Object for TTSK

accessor_ids¶: Field for accessorIDs

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

assign_multiple(user_ids=None, role_ids=None, team_id=None)¶

The assignMultiple action.

Parameters:	user_ids – userIDs (type: `string[]`) role_ids – roleIDs (type: `string[]`) team_id – teamID (type: `string`)

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

assignments_list_string¶: Field for assignmentsListString

audit_types¶: Field for auditTypes

billing_amount¶: Field for billingAmount

bulk_copy(template_id=None, template_task_ids=None, parent_template_task_id=None, options=None)¶

The bulkCopy action.

Parameters:	template_id – templateID (type: `string`) template_task_ids – templateTaskIDs (type: `string[]`) parent_template_task_id – parentTemplateTaskID (type: `string`) options – options (type: `string[]`)
Returns:	`string[]`

bulk_move(template_task_ids=None, template_id=None, parent_id=None, options=None)¶

The bulkMove action.

Parameters:	template_task_ids – templateTaskIDs (type: `string[]`) template_id – templateID (type: `string`) parent_id – parentID (type: `string`) options – options (type: `string[]`)
Returns:	`string`

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

children¶: Collection for children

completion_day¶: Field for completionDay

constraint_day¶: Field for constraintDay

cost_amount¶: Field for costAmount

cost_type¶: Field for costType

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

duration¶: Field for duration

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

duration_type¶: Field for durationType

duration_unit¶: Field for durationUnit

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_notes¶: Field for hasNotes

has_timed_notifications¶: Field for hasTimedNotifications

indent¶: Field for indent

is_critical¶: Field for isCritical

is_duration_locked¶: Field for isDurationLocked

is_leveling_excluded¶: Field for isLevelingExcluded

is_work_required_locked¶: Field for isWorkRequiredLocked

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_start_delay¶: Field for levelingStartDelay

leveling_start_delay_minutes¶: Field for levelingStartDelayMinutes

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

milestone¶: Reference for milestone

milestone_id¶: Field for milestoneID

move(template_id=None, parent_id=None, options=None)¶

The move action.

Parameters:	template_id – templateID (type: `string`) parent_id – parentID (type: `string`) options – options (type: `string[]`)

name¶: Field for name

notification_records¶: Collection for notificationRecords

number_of_children¶: Field for numberOfChildren

object_categories¶: Collection for objectCategories

original_duration¶: Field for originalDuration

original_work_required¶: Field for originalWorkRequired

parameter_values¶: Collection for parameterValues

parent¶: Reference for parent

parent_id¶: Field for parentID

parent_lag¶: Field for parentLag

parent_lag_type¶: Field for parentLagType

pending_calculation¶: Field for pendingCalculation

pending_update_methods¶: Field for pendingUpdateMethods

planned_cost¶: Field for plannedCost

planned_duration¶: Field for plannedDuration

planned_duration_minutes¶: Field for plannedDurationMinutes

planned_expense_cost¶: Field for plannedExpenseCost

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

predecessor_expression¶: Field for predecessorExpression

predecessors¶: Collection for predecessors

priority¶: Field for priority

recurrence_number¶: Field for recurrenceNumber

recurrence_rule¶: Reference for recurrenceRule

recurrence_rule_id¶: Field for recurrenceRuleID

reference_number¶: Field for referenceNumber

revenue_type¶: Field for revenueType

role¶: Reference for role

role_id¶: Field for roleID

start_day¶: Field for startDay

successors¶: Collection for successors

task_constraint¶: Field for taskConstraint

task_number¶: Field for taskNumber

task_number_predecessor_string¶: Field for taskNumberPredecessorString

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

template¶: Reference for template

template_id¶: Field for templateID

timed_notifications(notification_ids=None)¶

The timedNotifications action.

Parameters:	notification_ids – notificationIDs (type: `string[]`)

tracking_mode¶: Field for trackingMode

url¶: Field for URL

work¶: Field for work

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

work_unit¶: Field for workUnit

class workfront.versions.unsupported.TemplateUser(session=None, **fields)¶

Object for TMTU

customer¶: Reference for customer

customer_id¶: Field for customerID

template¶: Reference for template

template_id¶: Field for templateID

tmp_user_id¶: Field for tmpUserID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.TemplateUserRole(session=None, **fields)¶

Object for TTEAM

customer¶: Reference for customer

customer_id¶: Field for customerID

role¶: Reference for role

role_id¶: Field for roleID

template¶: Reference for template

template_id¶: Field for templateID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.TimedNotification(session=None, **fields)¶

Object for TMNOT

criteria¶: Field for criteria

customer¶: Reference for customer

customer_id¶: Field for customerID

date_field¶: Field for dateField

description¶: Field for description

duration_minutes¶: Field for durationMinutes

duration_unit¶: Field for durationUnit

email_template¶: Reference for emailTemplate

email_template_id¶: Field for emailTemplateID

name¶: Field for name

recipients¶: Field for recipients

timed_not_obj_code¶: Field for timedNotObjCode

timing¶: Field for timing

class workfront.versions.unsupported.Timesheet(session=None, **fields)¶

Object for TSHET

approver¶: Reference for approver

approver_can_edit_hours¶: Field for approverCanEditHours

approver_id¶: Field for approverID

approvers¶: Collection for approvers

approvers_list_string¶: Field for approversListString

available_actions¶: Field for availableActions

awaiting_approvals¶: Collection for awaitingApprovals

customer¶: Reference for customer

customer_id¶: Field for customerID

display_name¶: Field for displayName

end_date¶: Field for endDate

ext_ref_id¶: Field for extRefID

has_notes¶: Field for hasNotes

hours¶: Collection for hours

hours_duration¶: Field for hoursDuration

is_editable¶: Field for isEditable

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

notification_records¶: Collection for notificationRecords

overtime_hours¶: Field for overtimeHours

pin_timesheet_object(user_id=None, obj_code=None, obj_id=None)¶

The pinTimesheetObject action.

Parameters:	user_id – userID (type: `string`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

regular_hours¶: Field for regularHours

start_date¶: Field for startDate

status¶: Field for status

timesheet_profile¶: Reference for timesheetProfile

timesheet_profile_id¶: Field for timesheetProfileID

total_hours¶: Field for totalHours

unpin_timesheet_object(user_id=None, obj_code=None, obj_id=None)¶

The unpinTimesheetObject action.

Parameters:	user_id – userID (type: `string`) obj_code – objCode (type: `string`) obj_id – objID (type: `string`)

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.TimesheetProfile(session=None, **fields)¶

Object for TSPRO

approver¶: Reference for approver

approver_can_edit_hours¶: Field for approverCanEditHours

approver_id¶: Field for approverID

approvers¶: Collection for approvers

approvers_list_string¶: Field for approversListString

customer¶: Reference for customer

customer_id¶: Field for customerID

description¶: Field for description

effective_end_date¶: Field for effectiveEndDate

effective_start_date¶: Field for effectiveStartDate

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

generate_customer_timesheets(obj_ids=None)¶

The generateCustomerTimesheets action.

Parameters:	obj_ids – objIDs (type: `string[]`)

has_reference(ids=None)¶

The hasReference action.

Parameters:	ids – ids (type: `string[]`)
Returns:	`java.lang.Boolean`

hour_types¶: Collection for hourTypes

is_recurring¶: Field for isRecurring

manager_approval¶: Field for managerApproval

name¶: Field for name

notification_records¶: Collection for notificationRecords

pay_period_type¶: Field for payPeriodType

period_start¶: Field for periodStart

period_start_display_name¶: Field for PeriodStartDisplayName

class workfront.versions.unsupported.TimesheetTemplate(session=None, **fields)¶

Object for TSHTMP

customer¶: Reference for customer

customer_id¶: Field for customerID

hour_type¶: Reference for hourType

hour_type_id¶: Field for hourTypeID

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

project¶: Reference for project

project_id¶: Field for projectID

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

task¶: Reference for task

task_id¶: Field for taskID

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.UIFilter(session=None, **fields)¶

Object for UIFT

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

definition¶: Field for definition

display_name¶: Field for displayName

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

filter_type¶: Field for filterType

global_uikey¶: Field for globalUIKey

is_app_global_editable¶: Field for isAppGlobalEditable

is_public¶: Field for isPublic

is_report¶: Field for isReport

is_saved_search¶: Field for isSavedSearch

is_text¶: Field for isText

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

mod_date¶: Field for modDate

msg_key¶: Field for msgKey

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

preference¶: Reference for preference

preference_id¶: Field for preferenceID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

ui_obj_code¶: Field for uiObjCode

un_link_users(filter_id=None, linked_user_ids=None)¶

The unLinkUsers action.

Parameters:	filter_id – filterID (type: `string`) linked_user_ids – linkedUserIDs (type: `string[]`)

users¶: Collection for users

class workfront.versions.unsupported.UIGroupBy(session=None, **fields)¶

Object for UIGB

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

definition¶: Field for definition

display_name¶: Field for displayName

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

global_uikey¶: Field for globalUIKey

is_app_global_editable¶: Field for isAppGlobalEditable

is_public¶: Field for isPublic

is_report¶: Field for isReport

is_text¶: Field for isText

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

mod_date¶: Field for modDate

msg_key¶: Field for msgKey

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

preference¶: Reference for preference

preference_id¶: Field for preferenceID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

ui_obj_code¶: Field for uiObjCode

un_link_users(group_id=None, linked_user_ids=None)¶

The unLinkUsers action.

Parameters:	group_id – groupID (type: `string`) linked_user_ids – linkedUserIDs (type: `string[]`)

class workfront.versions.unsupported.UIView(session=None, **fields)¶

Object for UIVW

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

app_global¶: Reference for appGlobal

app_global_id¶: Field for appGlobalID

customer¶: Reference for customer

customer_id¶: Field for customerID

definition¶: Field for definition

display_name¶: Field for displayName

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

expand_view_aliases(obj_code=None, definition=None)¶

The expandViewAliases action.

Parameters:	obj_code – objCode (type: `string`) definition – definition (type: `map`)
Returns:	`map`

get_view_fields()¶

The getViewFields action.

Returns:	`string[]`

global_uikey¶: Field for globalUIKey

is_app_global_editable¶: Field for isAppGlobalEditable

is_default¶: Field for isDefault

is_new_format¶: Field for isNewFormat

is_public¶: Field for isPublic

is_report¶: Field for isReport

is_text¶: Field for isText

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

layout_type¶: Field for layoutType

linked_roles¶: Collection for linkedRoles

linked_teams¶: Collection for linkedTeams

linked_users¶: Collection for linkedUsers

migrate_uiviews_ppmto_anaconda()¶: The migrateUIViewsPPMToAnaconda action.

mod_date¶: Field for modDate

msg_key¶: Field for msgKey

name¶: Field for name

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

preference¶: Reference for preference

preference_id¶: Field for preferenceID

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

ui_obj_code¶: Field for uiObjCode

uiview_type¶: Field for uiviewType

un_link_users(view_id=None, linked_user_ids=None)¶

The unLinkUsers action.

Parameters:	view_id – viewID (type: `string`) linked_user_ids – linkedUserIDs (type: `string[]`)

class workfront.versions.unsupported.Update(session=None, **fields)¶

Object for UPDATE

allowed_actions¶: Field for allowedActions

audit_record¶: Reference for auditRecord

audit_record_id¶: Field for auditRecordID

audit_session_count(user_id=None, target_user_id=None, start_date=None, end_date=None)¶

The auditSessionCount action.

Parameters:	user_id – userID (type: `string`) target_user_id – targetUserID (type: `string`) start_date – startDate (type: `dateTime`) end_date – endDate (type: `dateTime`)
Returns:	`java.lang.Integer`

combined_updates¶: Collection for combinedUpdates

entered_by_id¶: Field for enteredByID

entered_by_name¶: Field for enteredByName

entry_date¶: Field for entryDate

get_update_types_for_stream(stream_type=None)¶

The getUpdateTypesForStream action.

Parameters:	stream_type – streamType (type: `string`)
Returns:	`string[]`

has_updates_before_date(obj_code=None, obj_id=None, date=None)¶

The hasUpdatesBeforeDate action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) date – date (type: `dateTime`)
Returns:	`java.lang.Boolean`

icon_name¶: Field for iconName

icon_path¶: Field for iconPath

is_valid_update_note(obj_code=None, obj_id=None, comment_id=None)¶

The isValidUpdateNote action.

Parameters:	obj_code – objCode (type: `string`) obj_id – objID (type: `string`) comment_id – commentID (type: `string`)
Returns:	`java.lang.Boolean`

message¶: Field for message

message_args¶: Collection for messageArgs

nested_updates¶: Collection for nestedUpdates

ref_name¶: Field for refName

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

replies¶: Collection for replies

styled_message¶: Field for styledMessage

sub_message¶: Field for subMessage

sub_message_args¶: Collection for subMessageArgs

sub_obj_code¶: Field for subObjCode

sub_obj_id¶: Field for subObjID

thread_id¶: Field for threadID

top_name¶: Field for topName

top_obj_code¶: Field for topObjCode

top_obj_id¶: Field for topObjID

update_actions¶: Field for updateActions

update_endorsement¶: Reference for updateEndorsement

update_journal_entry¶: Reference for updateJournalEntry

update_note¶: Reference for updateNote

update_obj¶: The object referenced by this update.

update_obj_code¶: Field for updateObjCode

update_obj_id¶: Field for updateObjID

update_type¶: Field for updateType

class workfront.versions.unsupported.User(session=None, **fields)¶

Object for USER

access_level¶: Reference for accessLevel

access_level_id¶: Field for accessLevelID

access_rule_preferences¶: Collection for accessRulePreferences

add_customer_feedback_improvement(is_better=None, comment=None)¶

The addCustomerFeedbackImprovement action.

Parameters:	is_better – isBetter (type: `boolean`) comment – comment (type: `string`)

add_customer_feedback_score_rating(score=None, comment=None)¶

The addCustomerFeedbackScoreRating action.

Parameters:	score – score (type: `int`) comment – comment (type: `string`)

add_early_access(ids=None)¶

The addEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

add_external_user(email_addr=None)¶

The addExternalUser action.

Parameters:	email_addr – emailAddr (type: `string`)
Returns:	`string`

add_mobile_device(token=None, device_type=None)¶

The addMobileDevice action.

Parameters:	token – token (type: `string`) device_type – deviceType (type: `string`)
Returns:	`map`

address¶: Field for address

address2¶: Field for address2

assign_user_token()¶

The assignUserToken action.

Returns:	`string`

avatar_date¶: Field for avatarDate

avatar_download_url¶: Field for avatarDownloadURL

avatar_size¶: Field for avatarSize

avatar_x¶: Field for avatarX

avatar_y¶: Field for avatarY

billing_per_hour¶: Field for billingPerHour

calculate_data_extension()¶: The calculateDataExtension action.

category¶: Reference for category

category_id¶: Field for categoryID

check_other_user_early_access()¶

The checkOtherUserEarlyAccess action.

Returns:	`java.lang.Boolean`

city¶: Field for city

clear_access_rule_preferences(obj_code=None)¶

The clearAccessRulePreferences action.

Parameters:	obj_code – objCode (type: `string`)

clear_api_key()¶

The clearApiKey action.

Returns:	`string`

company¶: Reference for company

company_id¶: Field for companyID

complete_external_user_registration(first_name=None, last_name=None, new_password=None)¶

The completeExternalUserRegistration action.

Parameters:	first_name – firstName (type: `string`) last_name – lastName (type: `string`) new_password – newPassword (type: `string`)

complete_user_registration(first_name=None, last_name=None, token=None, title=None, new_password=None)¶

The completeUserRegistration action.

Parameters:	first_name – firstName (type: `string`) last_name – lastName (type: `string`) token – token (type: `string`) title – title (type: `string`) new_password – newPassword (type: `string`)

cost_per_hour¶: Field for costPerHour

country¶: Field for country

custom_tabs¶: Collection for customTabs

customer¶: Reference for customer

customer_id¶: Field for customerID

default_hour_type¶: Reference for defaultHourType

default_hour_type_id¶: Field for defaultHourTypeID

default_interface¶: Field for defaultInterface

delegation_to¶: Reference for delegationTo

delegation_to_id¶: Field for delegationToID

delegations_from¶: Collection for delegationsFrom

delete_early_access(ids=None)¶

The deleteEarlyAccess action.

Parameters:	ids – ids (type: `string[]`)

direct_reports¶: Collection for directReports

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

effective_layout_template¶: Reference for effectiveLayoutTemplate

email_addr¶: Field for emailAddr

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

expire_password()¶: The expirePassword action.

ext_ref_id¶: Field for extRefID

external_sections¶: Collection for externalSections

external_username¶: Reference for externalUsername

favorites¶: Collection for favorites

first_name¶: Field for firstName

fte¶: Field for fte

get_api_key()¶

The getApiKey action.

Returns:	`string`

get_next_customer_feedback_type()¶

The getNextCustomerFeedbackType action.

Returns:	`string`

get_or_add_external_user(email_addr=None)¶

The getOrAddExternalUser action.

Parameters:	email_addr – emailAddr (type: `string`)
Returns:	`string`

get_reset_password_token_expired(token=None)¶

The getResetPasswordTokenExpired action.

Parameters:	token – token (type: `string`)
Returns:	`java.lang.Boolean`

has_apiaccess¶: Field for hasAPIAccess

has_documents¶: Field for hasDocuments

has_early_access()¶

The hasEarlyAccess action.

Returns:	`java.lang.Boolean`

has_notes¶: Field for hasNotes

has_password¶: Field for hasPassword

has_proof_license¶: Field for hasProofLicense

has_reserved_times¶: Field for hasReservedTimes

high_priority_work_item¶: Reference for highPriorityWorkItem

home_group¶: Reference for homeGroup

home_group_id¶: Field for homeGroupID

home_team¶: Reference for homeTeam

home_team_id¶: Field for homeTeamID

hour_types¶: Collection for hourTypes

is_active¶: Field for isActive

is_admin¶: Field for isAdmin

is_box_authenticated¶: Field for isBoxAuthenticated

is_drop_box_authenticated¶: Field for isDropBoxAuthenticated

is_google_authenticated¶: Field for isGoogleAuthenticated

is_npssurvey_available()¶

The isNPSSurveyAvailable action.

Returns:	`java.lang.Boolean`

is_share_point_authenticated¶: Field for isSharePointAuthenticated

is_username_re_captcha_required()¶

The isUsernameReCaptchaRequired action.

Returns:	`java.lang.Boolean`

is_web_damauthenticated¶: Field for isWebDAMAuthenticated

is_workfront_damauthenticated¶: Field for isWorkfrontDAMAuthenticated

last_entered_note¶: Reference for lastEnteredNote

last_entered_note_id¶: Field for lastEnteredNoteID

last_login_date¶: Field for lastLoginDate

last_name¶: Field for lastName

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_status_note¶: Reference for lastStatusNote

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

last_whats_new¶: Field for lastWhatsNew

latest_update_note¶: Reference for latestUpdateNote

latest_update_note_id¶: Field for latestUpdateNoteID

layout_template¶: Reference for layoutTemplate

layout_template_id¶: Field for layoutTemplateID

license_type¶: Field for licenseType

linked_portal_tabs¶: Collection for linkedPortalTabs

locale¶: Field for locale

login_count¶: Field for loginCount

manager¶: Reference for manager

manager_id¶: Field for managerID

messages¶: Collection for messages

migrate_users_ppmto_anaconda()¶: The migrateUsersPPMToAnaconda action.

mobile_devices¶: Collection for mobileDevices

mobile_phone_number¶: Field for mobilePhoneNumber

my_info¶: Field for myInfo

name¶: Field for name

object_categories¶: Collection for objectCategories

parameter_values¶: Collection for parameterValues

password¶: Field for password

password_date¶: Field for passwordDate

persona¶: Field for persona

phone_extension¶: Field for phoneExtension

phone_number¶: Field for phoneNumber

portal_profile¶: Reference for portalProfile

portal_profile_id¶: Field for portalProfileID

portal_sections¶: Collection for portalSections

portal_tabs¶: Collection for portalTabs

postal_code¶: Field for postalCode

registration_expire_date¶: Field for registrationExpireDate

remove_mobile_device(token=None)¶

The removeMobileDevice action.

Parameters:	token – token (type: `string`)
Returns:	`map`

reserved_times¶: Collection for reservedTimes

reset_password(old_password=None, new_password=None)¶

The resetPassword action.

Parameters:	old_password – oldPassword (type: `string`) new_password – newPassword (type: `string`)

reset_password_expire_date¶: Field for resetPasswordExpireDate

resource_pool¶: Reference for resourcePool

resource_pool_id¶: Field for resourcePoolID

retrieve_and_store_oauth2tokens(state=None, authorization_code=None)¶

The retrieveAndStoreOAuth2Tokens action.

Parameters:	state – state (type: `string`) authorization_code – authorizationCode (type: `string`)

retrieve_and_store_oauth_token(oauth_token=None)¶

The retrieveAndStoreOAuthToken action.

Parameters:	oauth_token – oauth_token (type: `string`)

role¶: Reference for role

role_id¶: Field for roleID

roles¶: Collection for roles

schedule¶: Reference for schedule

schedule_id¶: Field for scheduleID

send_invitation_email()¶: The sendInvitationEmail action.

set_access_rule_preferences(access_rule_preferences=None)¶

The setAccessRulePreferences action.

Parameters:	access_rule_preferences – accessRulePreferences (type: `string[]`)

sso_access_only¶: Field for ssoAccessOnly

sso_username¶: Field for ssoUsername

state¶: Field for state

status_update¶: Field for statusUpdate

submit_npssurvey(data_map=None)¶

The submitNPSSurvey action.

Parameters:	data_map – dataMap (type: `map`)

teams¶: Collection for teams

time_zone¶: Field for timeZone

timesheet_profile¶: Reference for timesheetProfile

timesheet_profile_id¶: Field for timesheetProfileID

timesheet_templates¶: Collection for timesheetTemplates

title¶: Field for title

ui_filters¶: Collection for uiFilters

ui_group_bys¶: Collection for uiGroupBys

ui_views¶: Collection for uiViews

update_next_survey_on_date(next_suvey_date=None)¶

The updateNextSurveyOnDate action.

Parameters:	next_suvey_date – nextSuveyDate (type: `dateTime`)

updates¶: Collection for updates

user_activities¶: Collection for userActivities

user_groups¶: Collection for userGroups

user_pref_values¶: Collection for userPrefValues

username¶: Field for username

validate_re_captcha(captcha_response=None)¶

The validateReCaptcha action.

Parameters:	captcha_response – captchaResponse (type: `string`)
Returns:	`java.lang.Boolean`

watch_list¶: Collection for watchList

web_davprofile¶: Field for webDAVProfile

work_items¶: Collection for workItems

class workfront.versions.unsupported.UserActivity(session=None, **fields)¶

Object for USERAC

customer¶: Reference for customer

customer_id¶: Field for customerID

entry_date¶: Field for entryDate

last_update_date¶: Field for lastUpdateDate

name¶: Field for name

user¶: Reference for user

user_id¶: Field for userID

value¶: Field for value

class workfront.versions.unsupported.UserAvailability(session=None, **fields)¶

Object for USRAVL

availability_date¶: Field for availabilityDate

customer¶: Reference for customer

customer_id¶: Field for customerID

delete_duplicate_availability(duplicate_user_availability_ids=None)¶

The deleteDuplicateAvailability action.

Parameters:	duplicate_user_availability_ids – duplicateUserAvailabilityIDs (type: `string[]`)

get_user_assignments(user_id=None, start_date=None, end_date=None)¶

The getUserAssignments action.

Parameters:	user_id – userID (type: `string`) start_date – startDate (type: `string`) end_date – endDate (type: `string`)
Returns:	`string[]`

olv¶: Field for olv

planned_allocation_percent¶: Field for plannedAllocationPercent

planned_assigned_minutes¶: Field for plannedAssignedMinutes

planned_remaining_minutes¶: Field for plannedRemainingMinutes

projected_allocation_percent¶: Field for projectedAllocationPercent

projected_assigned_minutes¶: Field for projectedAssignedMinutes

projected_remaining_minutes¶: Field for projectedRemainingMinutes

total_minutes¶: Field for totalMinutes

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.UserDelegation(session=None, **fields)¶

Object for USRDEL

customer¶: Reference for customer

customer_id¶: Field for customerID

end_date¶: Field for endDate

from_user¶: Reference for fromUser

from_user_id¶: Field for fromUserID

start_date¶: Field for startDate

to_user¶: Reference for toUser

to_user_id¶: Field for toUserID

class workfront.versions.unsupported.UserGroups(session=None, **fields)¶

Object for USRGPS

customer¶: Reference for customer

customer_id¶: Field for customerID

group¶: Reference for group

group_id¶: Field for groupID

is_owner¶: Field for isOwner

user¶: Reference for user

user_id¶: Field for userID

class workfront.versions.unsupported.UserNote(session=None, **fields)¶

Object for USRNOT

acknowledge()¶

The acknowledge action.

Returns:	`string`

acknowledge_all()¶

The acknowledgeAll action.

Returns:	`string[]`

acknowledge_many(obj_ids=None)¶

The acknowledgeMany action.

Parameters:	obj_ids – objIDs (type: `string[]`)
Returns:	`string[]`

acknowledgement¶: Reference for acknowledgement

acknowledgement_id¶: Field for acknowledgementID

add_team_note(team_id=None, obj_code=None, target_id=None, type=None)¶

The addTeamNote action.

Parameters:	team_id – teamID (type: `string`) obj_code – objCode (type: `string`) target_id – targetID (type: `string`) type – type (type: `com.attask.common.constants.UserNoteEventEnum`)
Returns:	`java.util.Collection`

add_teams_notes(team_ids=None, obj_code=None, target_id=None, type=None)¶

The addTeamsNotes action.

Parameters:	team_ids – teamIDs (type: `java.util.Collection`) obj_code – objCode (type: `string`) target_id – targetID (type: `string`) type – type (type: `com.attask.common.constants.UserNoteEventEnum`)
Returns:	`java.util.Collection`

add_user_note(user_id=None, obj_code=None, target_id=None, type=None)¶

The addUserNote action.

Parameters:	user_id – userID (type: `string`) obj_code – objCode (type: `string`) target_id – targetID (type: `string`) type – type (type: `com.attask.common.constants.UserNoteEventEnum`)
Returns:	`string`

add_users_notes(user_ids=None, obj_code=None, target_id=None, type=None)¶

The addUsersNotes action.

Parameters:	user_ids – userIDs (type: `java.util.Collection`) obj_code – objCode (type: `string`) target_id – targetID (type: `string`) type – type (type: `com.attask.common.constants.UserNoteEventEnum`)
Returns:	`java.util.Collection`

announcement¶: Reference for announcement

announcement_favorite_id¶: Field for announcementFavoriteID

announcement_id¶: Field for announcementID

customer¶: Reference for customer

customer_id¶: Field for customerID

document_approval¶: Reference for documentApproval

document_approval_id¶: Field for documentApprovalID

document_request¶: Reference for documentRequest

document_request_id¶: Field for documentRequestID

document_share¶: Reference for documentShare

document_share_id¶: Field for documentShareID

endorsement¶: Reference for endorsement

endorsement_id¶: Field for endorsementID

endorsement_share¶: Reference for endorsementShare

endorsement_share_id¶: Field for endorsementShareID

entry_date¶: Field for entryDate

event_type¶: Field for eventType

get_my_notification_last_view_date()¶

The getMyNotificationLastViewDate action.

Returns:	`dateTime`

has_announcement_delete_access()¶

The hasAnnouncementDeleteAccess action.

Returns:	`java.lang.Boolean`

journal_entry¶: Reference for journalEntry

journal_entry_id¶: Field for journalEntryID

like¶: Reference for like

like_id¶: Field for likeID

mark_deleted(note_id=None)¶

The markDeleted action.

Parameters:	note_id – noteID (type: `string`)

marked_deleted_date¶: Field for markedDeletedDate

note¶: Reference for note

note_id¶: Field for noteID

unacknowledge()¶: The unacknowledge action.

unacknowledged_announcement_count()¶

The unacknowledgedAnnouncementCount action.

Returns:	`java.lang.Integer`

unacknowledged_count()¶

The unacknowledgedCount action.

Returns:	`java.lang.Integer`

unmark_deleted(note_id=None)¶

The unmarkDeleted action.

Parameters:	note_id – noteID (type: `string`)

user¶: Reference for user

user_id¶: Field for userID

user_notable_id¶: Field for userNotableID

user_notable_obj_code¶: Field for userNotableObjCode

class workfront.versions.unsupported.UserObjectPref(session=None, **fields)¶

Object for USOP

customer¶: Reference for customer

customer_id¶: Field for customerID

last_update_date¶: Field for lastUpdateDate

name¶: Field for name

ref_obj_code¶: Field for refObjCode

ref_obj_id¶: Field for refObjID

set(user_id=None, ref_obj_code=None, ref_obj_id=None, name=None, value=None)¶

The set action.

Parameters:	user_id – userID (type: `string`) ref_obj_code – refObjCode (type: `string`) ref_obj_id – refObjID (type: `string`) name – name (type: `string`) value – value (type: `string`)
Returns:	`string`

user¶: Reference for user

user_id¶: Field for userID

value¶: Field for value

class workfront.versions.unsupported.UserPrefValue(session=None, **fields)¶

Object for USERPF

customer¶: Reference for customer

customer_id¶: Field for customerID

get_inactive_notifications_value(user_id=None)¶

The getInactiveNotificationsValue action.

Parameters:	user_id – userID (type: `string`)
Returns:	`string`

name¶: Field for name

set_inactive_notifications_value(user_id=None, value=None)¶

The setInactiveNotificationsValue action.

Parameters:	user_id – userID (type: `string`) value – value (type: `string`)

user¶: Reference for user

user_id¶: Field for userID

value¶: Field for value

class workfront.versions.unsupported.UserResource(session=None, **fields)¶

Object for USERRS

actual_allocation_percentage¶: Field for actualAllocationPercentage

actual_day_summaries¶: Field for actualDaySummaries

allocation_percentage¶: Field for allocationPercentage

allowed_actions¶: Field for allowedActions

assignments¶: Collection for assignments

available_number_of_hours¶: Field for availableNumberOfHours

available_time_per_day¶: Field for availableTimePerDay

average_actual_number_of_hours¶: Field for averageActualNumberOfHours

average_number_of_hours¶: Field for averageNumberOfHours

average_projected_number_of_hours¶: Field for averageProjectedNumberOfHours

day_summaries¶: Field for daySummaries

detail_level¶: Field for detailLevel

number_of_assignments¶: Field for numberOfAssignments

number_of_days_within_actual_threshold¶: Field for numberOfDaysWithinActualThreshold

number_of_days_within_projected_threshold¶: Field for numberOfDaysWithinProjectedThreshold

number_of_days_within_threshold¶: Field for numberOfDaysWithinThreshold

obj_code¶: Field for objCode

projected_allocation_percentage¶: Field for projectedAllocationPercentage

projected_day_summaries¶: Field for projectedDaySummaries

role¶: Reference for role

total_actual_hours¶: Field for totalActualHours

total_available_hours¶: Field for totalAvailableHours

total_number_of_hours¶: Field for totalNumberOfHours

total_projected_hours¶: Field for totalProjectedHours

user¶: Reference for user

user_home_team¶: Reference for userHomeTeam

user_primary_role¶: Reference for userPrimaryRole

working_days¶: Field for workingDays

class workfront.versions.unsupported.UsersSections(session=None, **fields)¶

Object for USRSEC

customer_id¶: Field for customerID

section_id¶: Field for sectionID

user_id¶: Field for userID

class workfront.versions.unsupported.WatchListEntry(session=None, **fields)¶

Object for WATCH

customer¶: Reference for customer

customer_id¶: Field for customerID

optask¶: Reference for optask

optask_id¶: Field for optaskID

project¶: Reference for project

project_id¶: Field for projectID

task¶: Reference for task

task_id¶: Field for taskID

user¶: Reference for user

user_id¶: Field for userID

watchable_obj_code¶: Field for watchableObjCode

watchable_obj_id¶: Field for watchableObjID

class workfront.versions.unsupported.WhatsNew(session=None, **fields)¶

Object for WTSN

description¶: Field for description

entry_date¶: Field for entryDate

feature_name¶: Field for featureName

is_whats_new_available(product_toggle=None)¶

The isWhatsNewAvailable action.

Parameters:	product_toggle – productToggle (type: `int`)
Returns:	`java.lang.Boolean`

locale¶: Field for locale

product_toggle¶: Field for productToggle

start_date¶: Field for startDate

title¶: Field for title

whats_new_types¶: Field for whatsNewTypes

class workfront.versions.unsupported.Work(session=None, **fields)¶

Object for WORK

access_rules¶: Collection for accessRules

accessor_ids¶: Field for accessorIDs

actual_completion_date¶: Field for actualCompletionDate

actual_cost¶: Field for actualCost

actual_duration¶: Field for actualDuration

actual_duration_minutes¶: Field for actualDurationMinutes

actual_expense_cost¶: Field for actualExpenseCost

actual_labor_cost¶: Field for actualLaborCost

actual_revenue¶: Field for actualRevenue

actual_start_date¶: Field for actualStartDate

actual_work¶: Field for actualWork

actual_work_required¶: Field for actualWorkRequired

actual_work_required_expression¶: Field for actualWorkRequiredExpression

age_range_as_string¶: Field for ageRangeAsString

all_priorities¶: Collection for allPriorities

all_severities¶: Collection for allSeverities

all_statuses¶: Collection for allStatuses

approval_est_start_date¶: Field for approvalEstStartDate

approval_planned_start_date¶: Field for approvalPlannedStartDate

approval_planned_start_day¶: Field for approvalPlannedStartDay

approval_process¶: Reference for approvalProcess

approval_process_id¶: Field for approvalProcessID

approval_projected_start_date¶: Field for approvalProjectedStartDate

approver_statuses¶: Collection for approverStatuses

approvers_string¶: Field for approversString

assigned_to¶: Reference for assignedTo

assigned_to_id¶: Field for assignedToID

assignments¶: Collection for assignments

assignments_list_string¶: Field for assignmentsListString

audit_note¶: Field for auditNote

audit_types¶: Field for auditTypes

audit_user_ids¶: Field for auditUserIDs

auto_closure_date¶: Field for autoClosureDate

awaiting_approvals¶: Collection for awaitingApprovals

backlog_order¶: Field for backlogOrder

billing_amount¶: Field for billingAmount

billing_record¶: Reference for billingRecord

billing_record_id¶: Field for billingRecordID

can_start¶: Field for canStart

category¶: Reference for category

category_id¶: Field for categoryID

children¶: Collection for children

color¶: Field for color

commit_date¶: Field for commitDate

commit_date_range¶: Field for commitDateRange

completion_pending_date¶: Field for completionPendingDate

condition¶: Field for condition

constraint_date¶: Field for constraintDate

converted_op_task_entry_date¶: Field for convertedOpTaskEntryDate

converted_op_task_name¶: Field for convertedOpTaskName

converted_op_task_originator¶: Reference for convertedOpTaskOriginator

converted_op_task_originator_id¶: Field for convertedOpTaskOriginatorID

cost_amount¶: Field for costAmount

cost_type¶: Field for costType

cpi¶: Field for cpi

csi¶: Field for csi

current_approval_step¶: Reference for currentApprovalStep

current_approval_step_id¶: Field for currentApprovalStepID

current_status_duration¶: Field for currentStatusDuration

customer¶: Reference for customer

customer_id¶: Field for customerID

days_late¶: Field for daysLate

default_baseline_task¶: Reference for defaultBaselineTask

description¶: Field for description

display_queue_breadcrumb¶: Field for displayQueueBreadcrumb

document_requests¶: Collection for documentRequests

documents¶: Collection for documents

done_statuses¶: Collection for doneStatuses

due_date¶: Field for dueDate

duration¶: Field for duration

duration_expression¶: Field for durationExpression

duration_minutes¶: Field for durationMinutes

duration_type¶: Field for durationType

duration_unit¶: Field for durationUnit

eac¶: Field for eac

entered_by¶: Reference for enteredBy

entered_by_id¶: Field for enteredByID

entry_date¶: Field for entryDate

est_completion_date¶: Field for estCompletionDate

est_start_date¶: Field for estStartDate

estimate¶: Field for estimate

expenses¶: Collection for expenses

ext_ref_id¶: Field for extRefID

first_response¶: Field for firstResponse

get_my_accomplishments_count()¶

The getMyAccomplishmentsCount action.

Returns:	`java.lang.Integer`

get_my_work_count()¶

The getMyWorkCount action.

Returns:	`java.lang.Integer`

get_work_requests_count(filters=None)¶

The getWorkRequestsCount action.

Parameters:	filters – filters (type: `map`)
Returns:	`java.lang.Integer`

group¶: Reference for group

group_id¶: Field for groupID

handoff_date¶: Field for handoffDate

has_completion_constraint¶: Field for hasCompletionConstraint

has_documents¶: Field for hasDocuments

has_expenses¶: Field for hasExpenses

has_messages¶: Field for hasMessages

has_notes¶: Field for hasNotes

has_resolvables¶: Field for hasResolvables

has_start_constraint¶: Field for hasStartConstraint

has_timed_notifications¶: Field for hasTimedNotifications

hours¶: Collection for hours

hours_per_point¶: Field for hoursPerPoint

how_old¶: Field for howOld

indent¶: Field for indent

is_agile¶: Field for isAgile

is_complete¶: Field for isComplete

is_critical¶: Field for isCritical

is_duration_locked¶: Field for isDurationLocked

is_help_desk¶: Field for isHelpDesk

is_leveling_excluded¶: Field for isLevelingExcluded

is_ready¶: Field for isReady

is_status_complete¶: Field for isStatusComplete

is_work_required_locked¶: Field for isWorkRequiredLocked

iteration¶: Reference for iteration

iteration_id¶: Field for iterationID

last_condition_note¶: Reference for lastConditionNote

last_condition_note_id¶: Field for lastConditionNoteID

last_note¶: Reference for lastNote

last_note_id¶: Field for lastNoteID

last_update_date¶: Field for lastUpdateDate

last_updated_by¶: Reference for lastUpdatedBy

last_updated_by_id¶: Field for lastUpdatedByID

leveling_start_delay¶: Field for levelingStartDelay

leveling_start_delay_expression¶: Field for levelingStartDelayExpression

leveling_start_delay_minutes¶: Field for levelingStartDelayMinutes

master_task¶: Reference for masterTask

master_task_id¶: Field for masterTaskID

milestone¶: Reference for milestone

milestone_id¶: Field for milestoneID

name¶: Field for name

notification_records¶: Collection for notificationRecords

number_of_children¶: Field for numberOfChildren

number_open_op_tasks¶: Field for numberOpenOpTasks

object_categories¶: Collection for objectCategories

olv¶: Field for olv

op_task_type¶: Field for opTaskType

op_task_type_label¶: Field for opTaskTypeLabel

op_tasks¶: Collection for opTasks

open_op_tasks¶: Collection for openOpTasks

original_duration¶: Field for originalDuration

original_work_required¶: Field for originalWorkRequired

owner¶: Reference for owner

owner_id¶: Field for ownerID

parameter_values¶: Collection for parameterValues

parent¶: Reference for parent

parent_id¶: Field for parentID

parent_lag¶: Field for parentLag

parent_lag_type¶: Field for parentLagType

pending_calculation¶: Field for pendingCalculation

pending_predecessors¶: Field for pendingPredecessors

pending_update_methods¶: Field for pendingUpdateMethods

percent_complete¶: Field for percentComplete

personal¶: Field for personal

planned_completion_date¶: Field for plannedCompletionDate

planned_cost¶: Field for plannedCost

planned_date_alignment¶: Field for plannedDateAlignment

planned_duration¶: Field for plannedDuration

planned_duration_minutes¶: Field for plannedDurationMinutes

planned_expense_cost¶: Field for plannedExpenseCost

planned_hours_alignment¶: Field for plannedHoursAlignment

planned_labor_cost¶: Field for plannedLaborCost

planned_revenue¶: Field for plannedRevenue

planned_start_date¶: Field for plannedStartDate

predecessor_expression¶: Field for predecessorExpression

predecessors¶: Collection for predecessors

previous_status¶: Field for previousStatus

primary_assignment¶: Reference for primaryAssignment

priority¶: Field for priority

progress_status¶: Field for progressStatus

project¶: Reference for project

project_id¶: Field for projectID

projected_completion_date¶: Field for projectedCompletionDate

projected_duration_minutes¶: Field for projectedDurationMinutes

projected_start_date¶: Field for projectedStartDate

queue_topic¶: Reference for queueTopic

queue_topic_breadcrumb¶: Field for queueTopicBreadcrumb

queue_topic_id¶: Field for queueTopicID

recurrence_number¶: Field for recurrenceNumber

recurrence_rule¶: Reference for recurrenceRule

recurrence_rule_id¶: Field for recurrenceRuleID

reference_number¶: Field for referenceNumber

reference_obj_code¶: Field for referenceObjCode

reference_obj_id¶: Field for referenceObjID

rejection_issue¶: Reference for rejectionIssue

rejection_issue_id¶: Field for rejectionIssueID

remaining_duration_minutes¶: Field for remainingDurationMinutes

reserved_time¶: Reference for reservedTime

reserved_time_id¶: Field for reservedTimeID

resolution_time¶: Field for resolutionTime

resolvables¶: Collection for resolvables

resolve_op_task¶: Reference for resolveOpTask

resolve_op_task_id¶: Field for resolveOpTaskID

resolve_project¶: Reference for resolveProject

resolve_project_id¶: Field for resolveProjectID

resolve_task¶: Reference for resolveTask

resolve_task_id¶: Field for resolveTaskID

resolving_obj_code¶: Field for resolvingObjCode

resolving_obj_id¶: Field for resolvingObjID

resource_scope¶: Field for resourceScope

revenue_type¶: Field for revenueType

role¶: Reference for role

role_id¶: Field for roleID

security_ancestors¶: Collection for securityAncestors

security_ancestors_disabled¶: Field for securityAncestorsDisabled

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

severity¶: Field for severity

show_commit_date¶: Field for showCommitDate

show_condition¶: Field for showCondition

show_status¶: Field for showStatus

slack_date¶: Field for slackDate

source_obj_code¶: Field for sourceObjCode

source_obj_id¶: Field for sourceObjID

source_task¶: Reference for sourceTask

source_task_id¶: Field for sourceTaskID

spi¶: Field for spi

status¶: Field for status

status_equates_with¶: Field for statusEquatesWith

status_update¶: Field for statusUpdate

submitted_by¶: Reference for submittedBy

submitted_by_id¶: Field for submittedByID

successors¶: Collection for successors

task_constraint¶: Field for taskConstraint

task_number¶: Field for taskNumber

task_number_predecessor_string¶: Field for taskNumberPredecessorString

team¶: Reference for team

team_assignment¶: Reference for teamAssignment

team_id¶: Field for teamID

team_request_count(filters=None)¶

The teamRequestCount action.

Parameters:	filters – filters (type: `map`)
Returns:	`java.lang.Integer`

team_requests_count()¶

The teamRequestsCount action.

Returns:	`map`

template_task¶: Reference for templateTask

template_task_id¶: Field for templateTaskID

tracking_mode¶: Field for trackingMode

updates¶: Collection for updates

url¶: Field for URL

url_¶: Field for url

version¶: Field for version

wbs¶: Field for wbs

work¶: Field for work

work_item¶: Reference for workItem

work_required¶: Field for workRequired

work_required_expression¶: Field for workRequiredExpression

work_unit¶: Field for workUnit

class workfront.versions.unsupported.WorkItem(session=None, **fields)¶

Object for WRKITM

accessor_ids¶: Field for accessorIDs

assignment¶: Reference for assignment

assignment_id¶: Field for assignmentID

customer¶: Reference for customer

customer_id¶: Field for customerID

done_date¶: Field for doneDate

ext_ref_id¶: Field for extRefID

is_dead¶: Field for isDead

is_done¶: Field for isDone

last_viewed_date¶: Field for lastViewedDate

make_top_priority(obj_code=None, assignable_id=None, user_id=None)¶

The makeTopPriority action.

Parameters:	obj_code – objCode (type: `string`) assignable_id – assignableID (type: `string`) user_id – userID (type: `string`)

mark_viewed()¶: The markViewed action.

obj_id¶: Field for objID

obj_obj_code¶: Field for objObjCode

op_task¶: Reference for opTask

op_task_id¶: Field for opTaskID

priority¶: Field for priority

project¶: Reference for project

project_id¶: Field for projectID

reference_object_commit_date¶: Field for referenceObjectCommitDate

reference_object_name¶: Field for referenceObjectName

security_root_id¶: Field for securityRootID

security_root_obj_code¶: Field for securityRootObjCode

snooze_date¶: Field for snoozeDate

task¶: Reference for task

task_id¶: Field for taskID

user¶: Reference for user

user_id¶: Field for userID

“unsupported” API Reference¶

Previous topic

Next topic

This Page