v4.0 API Reference

class workfront.versions.v40.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.v40.Approval(session=None, **fields)

Object for APPROVAL

access_rules

Collection for accessRules

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

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

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

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

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

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_leveling_excluded

Field for isLevelingExcluded

is_ready

Field for isReady

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

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

number_of_children

Field for numberOfChildren

number_open_op_tasks

Field for numberOpenOpTasks

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

parent

Reference for parent

parent_id

Field for parentID

parent_lag

Field for parentLag

parent_lag_type

Field for parentLagType

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_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_id

Field for queueTopicID

rates

Collection for rates

recurrence_number

Field for recurrenceNumber

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_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

selected_on_portfolio_optimizer

Field for selectedOnPortfolioOptimizer

severity

Field for severity

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

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.v40.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.v40.ApprovalProcess(session=None, **fields)

Object for ARVPRC

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.v40.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.v40.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

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.v40.Assignment(session=None, **fields)

Object for ASSGN

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

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

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.v40.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

handle

Field for handle

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

Object for BKGJOB

access_count

Field for accessCount

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

handler_class_name

Field for handlerClassName

start_date

Field for startDate

status

Field for status

class workfront.versions.v40.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.v40.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.v40.BillingRecord(session=None, **fields)

Object for BILL

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.v40.Category(session=None, **fields)

Object for CTGY

cat_obj_code

Field for catObjCode

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

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

class workfront.versions.v40.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_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

view_security_level

Field for viewSecurityLevel

class workfront.versions.v40.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.v40.Company(session=None, **fields)

Object for CMPY

calculate_data_extension()

The calculateDataExtension action.

category

Reference for category

category_id

Field for categoryID

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

has_rate_override

Field for hasRateOverride

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

name

Field for name

rates

Collection for rates

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

Object for CSTEM

color

Field for color

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
is_primary

Field for isPrimary

label

Field for label

value

Field for value

value_as_int

Field for valueAsInt

value_as_string

Field for valueAsString

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

Object for CUST

account_rep_id

Field for accountRepID

address

Field for address

address2

Field for address2

admin_acct_name

Field for adminAcctName

admin_acct_password

Field for adminAcctPassword

api_concurrency_limit

Field for apiConcurrencyLimit

approval_processes

Collection for approvalProcesses

biz_rule_exclusions

Field for bizRuleExclusions

categories

Collection for categories

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

customer_config_map_id

Field for customerConfigMapID

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_size

Field for documentSize

documents

Collection for documents

domain

Field for domain

email_addr

Field for emailAddr

entry_date

Field for entryDate

eval_exp_date

Field for evalExpDate

exp_date

Field for expDate

expense_types

Collection for expenseTypes

ext_ref_id

Field for extRefID

external_document_storage

Field for externalDocumentStorage

external_users_enabled

Field for externalUsersEnabled

extra_document_storage

Field for extraDocumentStorage

firstname

Field for firstname

full_users

Field for fullUsers

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_id

Field for helpDeskConfigMapID

hour_types

Collection for hourTypes

inline_java_script_config_map_id

Field for inlineJavaScriptConfigMapID

is_apienabled

Field for isAPIEnabled

is_disabled

Field for isDisabled

is_enterprise

Field for isEnterprise

is_marketing_solutions_enabled

Field for isMarketingSolutionsEnabled

is_migrated_to_anaconda

Field for isMigratedToAnaconda

is_portal_profile_migrated

Field for isPortalProfileMigrated

is_soapenabled

Field for isSOAPEnabled

is_warning_disabled

Field for isWarningDisabled

journal_field_limit

Field for journalFieldLimit

last_remind_date

Field for lastRemindDate

last_usage_report_date

Field for lastUsageReportDate

lastname

Field for lastname

layout_templates

Collection for layoutTemplates

limited_users

Field for limitedUsers

locale

Field for locale

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_id

Field for notificationConfigMapID

on_demand_options

Field for onDemandOptions

op_task_count_limit

Field for opTaskCountLimit

overdraft_exp_date

Field for overdraftExpDate

parameter_groups

Collection for parameterGroups

parameters

Collection for parameters

password_config_map_id

Field for passwordConfigMapID

phone_number

Field for phoneNumber

portfolio_management_config_map_id

Field for portfolioManagementConfigMapID

postal_code

Field for postalCode

project_management_config_map_id

Field for projectManagementConfigMapID

proof_account_id

Field for proofAccountID

record_limit

Field for recordLimit

requestor_users

Field for requestorUsers

reseller_id

Field for resellerID

resource_pools

Collection for resourcePools

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

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

timesheet_config_map_id

Field for timesheetConfigMapID

trial

Field for trial

ui_config_map_id

Field for uiConfigMapID

ui_filters

Collection for uiFilters

ui_group_bys

Collection for uiGroupBys

ui_views

Collection for uiViews

usage_report_attempts

Field for usageReportAttempts

use_external_document_storage

Field for useExternalDocumentStorage

user_invite_config_map_id

Field for userInviteConfigMapID

welcome_email_addresses

Field for welcomeEmailAddresses

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

Object for CUSTPR

name

Field for name

obj_code

Field for objCode

possible_values

Field for possibleValues

value

Field for value

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

Object for DOCU

access_rules

Collection for accessRules

approvals

Collection for approvals

calculate_data_extension()

The calculateDataExtension action.

category

Reference for category

category_id

Field for categoryID

checked_out_by

Reference for checkedOutBy

checked_out_by_id

Field for checkedOutByID

current_version

Reference for currentVersion

current_version_id

Field for currentVersionID

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

doc_obj_code

Field for docObjCode

document_request_id

Field for documentRequestID

download_url

Field for downloadURL

ext_ref_id

Field for extRefID

external_integration_type

Field for externalIntegrationType

folders

Collection for folders

groups

Collection for groups

handle

Field for handle

has_notes

Field for hasNotes

is_dir

Field for isDir

is_private

Field for isPrivate

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_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

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

op_task

Reference for opTask

op_task_id

Field for opTaskID

owner

Reference for owner

owner_id

Field for ownerID

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

public_token

Field for publicToken

reference_obj_code

Field for referenceObjCode

reference_obj_id

Field for referenceObjID

reference_object_name

Field for referenceObjectName

release_version

Reference for releaseVersion

release_version_id

Field for releaseVersionID

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

user

Reference for user

user_id

Field for userID

versions

Collection for versions

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

Object for DOCAPL

approval_date

Field for approvalDate

approver

Reference for approver

approver_id

Field for approverID

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

request_date

Field for requestDate

requestor

Reference for requestor

requestor_id

Field for requestorID

status

Field for status

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

Object for DOCFDR

children

Collection for children

customer

Reference for customer

customer_id

Field for customerID

documents

Collection for documents

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

issue

Reference for issue

issue_id

Field for issueID

iteration

Reference for iteration

iteration_id

Field for iterationID

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

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

user

Reference for user

user_id

Field for userID

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

Object for DOCV

customer

Reference for customer

customer_id

Field for customerID

doc_size

Field for docSize

document

Reference for document

document_id

Field for documentID

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_name

Field for fileName

format_doc_size

Field for formatDocSize

format_entry_date

Field for formatEntryDate

handle

Field for handle

is_proofable

Field for isProofable

proof_id

Field for proofID

proof_status

Field for proofStatus

version

Field for version

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

Object for EXRATE

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

template

Reference for template

template_id

Field for templateID

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

Object for EXPNS

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_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

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.v40.ExpenseType(session=None, **fields)

Object for EXPTYP

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

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.v40.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

user

Reference for user

user_id

Field for userID

class workfront.versions.v40.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.v40.Group(session=None, **fields)

Object for GROUP

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

name

Field for name

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

Object for HOUR

actual_cost

Field for actualCost

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

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

Object for HOURT

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

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

users

Collection for users

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

Object for OPTASK

accept_work()

The acceptWork action.

access_rules

Collection for accessRules

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

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_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

documents

Collection for documents

done_statuses

Collection for doneStatuses

due_date

Field for dueDate

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

number_of_children

Field for numberOfChildren

op_task_type

Field for opTaskType

op_task_type_label

Field for opTaskTypeLabel

owner

Reference for owner

owner_id

Field for ownerID

parent

Reference for parent

planned_completion_date

Field for plannedCompletionDate

planned_date_alignment

Field for plannedDateAlignment

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_duration_minutes

Field for projectedDurationMinutes

projected_start_date

Field for projectedStartDate

queue_topic

Reference for queueTopic

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_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

severity

Field for severity

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

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

work_item

Reference for workItem

work_required

Field for workRequired

work_required_expression

Field for workRequiredExpression

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

Object for ITRN

capacity

Field for capacity

category

Reference for category

category_id

Field for categoryID

customer

Reference for customer

customer_id

Field for customerID

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

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

name

Field for name

owner

Reference for owner

owner_id

Field for ownerID

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.v40.JournalEntry(session=None, **fields)

Object for JRNLE

assignment

Reference for assignment

assignment_id

Field for assignmentID

aux1

Field for aux1

aux2

Field for aux2

aux3

Field for aux3

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_id

Field for documentShareID

duration_minutes

Field for durationMinutes

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

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

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

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

unlike()

The unlike action.

user

Reference for user

user_id

Field for userID

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

Object for LYTMPL

app_global_id

Field for appGlobalID

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

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

license_type

Field for licenseType

linked_roles

Collection for linkedRoles

linked_teams

Collection for linkedTeams

linked_users

Collection for linkedUsers

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.v40.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.v40.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.v40.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.v40.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.v40.Note(session=None, **fields)

Object for NOTE

add_comment(text)

Add a comment to this comment.

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

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

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

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_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.v40.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.v40.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.v40.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.v40.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.v40.Portfolio(session=None, **fields)

Object for PORT

access_rules

Collection for accessRules

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

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

on_budget

Field for onBudget

on_time

Field for onTime

owner

Reference for owner

owner_id

Field for ownerID

programs

Collection for programs

projects

Collection for projects

roi

Field for roi

class workfront.versions.v40.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.v40.Program(session=None, **fields)

Object for PRGM

access_rules

Collection for accessRules

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

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

owner

Reference for owner

owner_id

Field for ownerID

portfolio

Reference for portfolio

portfolio_id

Field for portfolioID

projects

Collection for projects

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

Object for PROJ

access_rules

Collection for accessRules

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

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

audit_types

Field for auditTypes

auto_baseline_recur_on

Field for autoBaselineRecurOn

auto_baseline_recurrence_type

Field for autoBaselineRecurrenceType

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_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

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

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

documents

Collection for documents

duration_expression

Field for durationExpression

duration_minutes

Field for durationMinutes

eac

Field for eac

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

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

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

hour_types

Collection for hourTypes

hours

Collection for hours

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

milestone_path

Reference for milestonePath

milestone_path_id

Field for milestonePathID

name

Field for name

next_auto_baseline_date

Field for nextAutoBaselineDate

number_open_op_tasks

Field for numberOpenOpTasks

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

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_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

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

schedule

Reference for schedule

schedule_id

Field for scheduleID

schedule_mode

Field for scheduleMode

selected_on_portfolio_optimizer

Field for selectedOnPortfolioOptimizer

set_budget_to_schedule()

The setBudgetToSchedule action.

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

template

Reference for template

template_id

Field for templateID

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.v40.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.v40.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.v40.QueueDef(session=None, **fields)

Object for QUED

add_op_task_style

Field for addOpTaskStyle

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

ext_ref_id

Field for extRefID

has_queue_topics

Field for hasQueueTopics

is_public

Field for isPublic

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

template

Reference for template

template_id

Field for templateID

visible_op_task_fields

Field for visibleOpTaskFields

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

Object for QUET

allowed_op_task_types

Field for allowedOpTaskTypes

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

parent_topic

Reference for parentTopic

parent_topic_id

Field for parentTopicID

queue_def

Reference for queueDef

queue_def_id

Field for queueDefID

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

Object for RATE

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

class workfront.versions.v40.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.v40.ResourceAllocation(session=None, **fields)

Object for RSALLO

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

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.v40.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.v40.Risk(session=None, **fields)

Object for RISK

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.v40.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

name

Field for name

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

Object for ROLE

billing_per_hour

Field for billingPerHour

cost_per_hour

Field for costPerHour

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

layout_template

Reference for layoutTemplate

layout_template_id

Field for layoutTemplateID

max_users

Field for maxUsers

name

Field for name

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

Object for RRUL

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.v40.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

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.v40.ScoreCard(session=None, **fields)

Object for SCORE

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.v40.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.v40.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.v40.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.v40.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.v40.Task(session=None, **fields)

Object for TASK

accept_work()

The acceptWork action.

access_rules

Collection for accessRules

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

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.

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

customer

Reference for customer

customer_id

Field for customerID

days_late

Field for daysLate

default_baseline_task

Reference for defaultBaselineTask

description

Field for description

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_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_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

number_of_children

Field for numberOfChildren

number_open_op_tasks

Field for numberOpenOpTasks

op_tasks

Collection for opTasks

open_op_tasks

Collection for openOpTasks

original_duration

Field for originalDuration

original_work_required

Field for originalWorkRequired

parent

Reference for parent

parent_id

Field for parentID

parent_lag

Field for parentLag

parent_lag_type

Field for parentLagType

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_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_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

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

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.v40.Team(session=None, **fields)

Object for TEAMOB

backlog_tasks

Collection for backlogTasks

customer

Reference for customer

customer_id

Field for customerID

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

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

task_statuses

Field for taskStatuses

team_members

Collection for teamMembers

team_story_board_statuses

Field for teamStoryBoardStatuses

updates

Collection for updates

users

Collection for users

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

Object for TEAMMB

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.v40.Template(session=None, **fields)

Object for TMPL

access_rules

Collection for accessRules

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

calculate_data_extension()

The calculateDataExtension action.

category

Reference for category

category_id

Field for categoryID

completion_day

Field for completionDay

completion_type

Field for completionType

currency

Field for currency

customer

Reference for customer

customer_id

Field for customerID

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

documents

Collection for documents

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

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

milestone_path

Reference for milestonePath

milestone_path_id

Field for milestonePathID

name

Field for name

olv

Field for olv

owner_privileges

Field for ownerPrivileges

performance_index_method

Field for performanceIndexMethod

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

queue_def

Reference for queueDef

queue_def_id

Field for queueDefID

reference_number

Field for referenceNumber

risks

Collection for risks

roles

Collection for roles

routing_rules

Collection for routingRules

schedule_mode

Field for scheduleMode

start_day

Field for startDay

summary_completion_type

Field for summaryCompletionType

template_tasks

Collection for templateTasks

template_user_roles

Collection for templateUserRoles

template_users

Collection for templateUsers

version

Field for version

work_required

Field for workRequired

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

Object for TASSGN

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_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_required

Field for workRequired

work_unit

Field for workUnit

class workfront.versions.v40.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.v40.TemplateTask(session=None, **fields)

Object for TTSK

approval_process

Reference for approvalProcess

approval_process_id

Field for approvalProcessID

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

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

documents

Collection for documents

duration

Field for duration

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_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

number_of_children

Field for numberOfChildren

original_duration

Field for originalDuration

original_work_required

Field for originalWorkRequired

parent

Reference for parent

parent_id

Field for parentID

parent_lag

Field for parentLag

parent_lag_type

Field for parentLagType

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

predecessors

Collection for predecessors

priority

Field for priority

recurrence_number

Field for recurrenceNumber

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

team

Reference for team

team_assignment

Reference for teamAssignment

team_id

Field for teamID

template

Reference for template

template_id

Field for templateID

tracking_mode

Field for trackingMode

url

Field for URL

work

Field for work

work_required

Field for workRequired

work_unit

Field for workUnit

class workfront.versions.v40.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.v40.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.v40.Timesheet(session=None, **fields)

Object for TSHET

approver

Reference for approver

approver_id

Field for approverID

available_actions

Field for availableActions

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

overtime_hours

Field for overtimeHours

regular_hours

Field for regularHours

start_date

Field for startDate

status

Field for status

timesheet_profile_id

Field for timesheetProfileID

total_hours

Field for totalHours

user

Reference for user

user_id

Field for userID

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

Object for UIFT

access_rules

Collection for accessRules

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

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_id

Field for preferenceID

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

ui_obj_code

Field for uiObjCode

users

Collection for users

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

Object for UIGB

access_rules

Collection for accessRules

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_id

Field for preferenceID

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

ui_obj_code

Field for uiObjCode

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

Object for UIVW

access_rules

Collection for accessRules

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_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

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_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

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

Object for UPDATE

allowed_actions

Field for allowedActions

combined_updates

Collection for combinedUpdates

entered_by_id

Field for enteredByID

entered_by_name

Field for enteredByName

entry_date

Field for entryDate

icon_name

Field for iconName

icon_path

Field for iconPath

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_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.v40.User(session=None, **fields)

Object for USER

access_level_id

Field for accessLevelID

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

city

Field for city

company

Reference for company

company_id

Field for companyID

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

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

direct_reports

Collection for directReports

documents

Collection for documents

email_addr

Field for emailAddr

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

ext_ref_id

Field for extRefID

favorites

Collection for favorites

first_name

Field for firstName

fte

Field for fte

has_apiaccess

Field for hasAPIAccess

has_documents

Field for hasDocuments

has_messages

Field for hasMessages

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_share_point_authenticated

Field for isSharePointAuthenticated

is_web_damauthenticated

Field for isWebDAMAuthenticated

last_announcement

Field for lastAnnouncement

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

locale

Field for locale

login_count

Field for loginCount

manager

Reference for manager

manager_id

Field for managerID

messages

Collection for messages

mobile_phone_number

Field for mobilePhoneNumber

my_info

Field for myInfo

name

Field for name

other_groups

Collection for otherGroups

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_id

Field for portalProfileID

postal_code

Field for postalCode

proof_account_password

Field for proofAccountPassword

registration_expire_date

Field for registrationExpireDate

reserved_times

Collection for reservedTimes

reset_password_expire_date

Field for resetPasswordExpireDate

resource_pool

Reference for resourcePool

resource_pool_id

Field for resourcePoolID

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.

sso_access_only

Field for ssoAccessOnly

sso_username

Field for ssoUsername

state

Field for state

status_update

Field for statusUpdate

teams

Collection for teams

time_zone

Field for timeZone

timesheet_profile_id

Field for timesheetProfileID

title

Field for title

ui_filters

Collection for uiFilters

ui_group_bys

Collection for uiGroupBys

ui_views

Collection for uiViews

updates

Collection for updates

user_activities

Collection for userActivities

user_notes

Collection for userNotes

user_pref_values

Collection for userPrefValues

username

Field for username

web_davprofile

Field for webDAVProfile

work_items

Collection for workItems

class workfront.versions.v40.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.v40.UserNote(session=None, **fields)

Object for USRNOT

customer

Reference for customer

customer_id

Field for customerID

document_approval

Reference for documentApproval

document_approval_id

Field for documentApprovalID

document_request_id

Field for documentRequestID

document_share_id

Field for documentShareID

endorsement_id

Field for endorsementID

entry_date

Field for entryDate

event_type

Field for eventType

journal_entry

Reference for journalEntry

journal_entry_id

Field for journalEntryID

like_id

Field for likeID

note

Reference for note

note_id

Field for noteID

user

Reference for user

user_id

Field for userID

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

Object for USERPF

customer

Reference for customer

customer_id

Field for customerID

name

Field for name

user

Reference for user

user_id

Field for userID

value

Field for value

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

Object for WORK

access_rules

Collection for accessRules

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

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

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

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_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_id

Field for masterTaskID

milestone

Reference for milestone

milestone_id

Field for milestoneID

name

Field for name

number_of_children

Field for numberOfChildren

number_open_op_tasks

Field for numberOpenOpTasks

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

parent

Reference for parent

parent_id

Field for parentID

parent_lag

Field for parentLag

parent_lag_type

Field for parentLagType

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_id

Field for queueTopicID

recurrence_number

Field for recurrenceNumber

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_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

severity

Field for severity

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_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

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.v40.WorkItem(session=None, **fields)

Object for WRKITM

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

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