“unsupported” API Reference

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

Object for ACSLVL

access_level_permissions

Collection for accessLevelPermissions

access_restrictions

Field for accessRestrictions

access_rule_preferences

Collection for accessRulePreferences

access_scope_actions

Collection for accessScopeActions

app_global

Reference for appGlobal

app_global_id

Field for appGlobalID

calculate_sharing(obj_code=None, obj_id=None)

The calculateSharing action.

Parameters:
  • obj_code – objCode (type: string)
  • obj_id – objID (type: string)
clear_access_rule_preferences(obj_code=None)

The clearAccessRulePreferences action.

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

The createUnsupportedWorkerAccessLevelForTesting action.

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

description_key

Field for descriptionKey

display_access_type

Field for displayAccessType

ext_ref_id

Field for extRefID

field_access_privileges

Field for fieldAccessPrivileges

filter_actions_for_external(obj_code=None, action_types=None)

The filterActionsForExternal action.

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

string[]

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

The filterAvailableActions action.

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

string[]

get_access_level_permissions_for_obj_code(obj_code=None, access_level_ids=None)

The getAccessLevelPermissionsForObjCode action.

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

map

get_default_access_permissions(license_type=None)

The getDefaultAccessPermissions action.

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

The getDefaultAccessRulePreferences action.

Returns:map
get_default_forbidden_actions(obj_code=None, obj_id=None)

The getDefaultForbiddenActions action.

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

map

get_maximum_access_permissions(license_type=None)

The getMaximumAccessPermissions action.

Parameters:license_type – licenseType (type: com.attask.common.constants.LicenseTypeEnum)
Returns:map
get_security_parent_ids(obj_code=None, obj_id=None)

The getSecurityParentIDs action.

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

map

get_security_parent_obj_code(obj_code=None, obj_id=None)

The getSecurityParentObjCode action.

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

string

get_user_accessor_ids(user_id=None)

The getUserAccessorIDs action.

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

The getViewableObjectObjCodes action.

Returns:string[]
has_any_access(obj_code=None, action_type=None)

The hasAnyAccess action.

Parameters:
  • obj_code – objCode (type: string)
  • action_type – actionType (type: com.attask.common.constants.ActionTypeEnum)
Returns:

java.lang.Boolean

has_reference(ids=None)

The hasReference action.

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

Field for isAdmin

is_unsupported_worker_license

Field for isUnsupportedWorkerLicense

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

last_updated_date

Field for lastUpdatedDate

legacy_access_level_id

Field for legacyAccessLevelID

legacy_diagnostics()

The legacyDiagnostics action.

Returns:map
license_type

Field for licenseType

name

Field for name

name_key

Field for nameKey

obj_id

Field for objID

obj_obj_code

Field for objObjCode

rank

Field for rank

security_model_type

Field for securityModelType

set_access_rule_preferences(access_rule_preferences=None)

The setAccessRulePreferences action.

Parameters:access_rule_preferences – accessRulePreferences (type: string[])
class workfront.versions.unsupported.AccessLevelPermissions(session=None, **fields)

Object for ALVPER

access_level

Reference for accessLevel

access_level_id

Field for accessLevelID

core_action

Field for coreAction

customer

Reference for customer

customer_id

Field for customerID

forbidden_actions

Field for forbiddenActions

is_admin

Field for isAdmin

obj_obj_code

Field for objObjCode

secondary_actions

Field for secondaryActions

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

Object for ACSREQ

action

Field for action

auto_generated

Field for autoGenerated

auto_share_action

Field for autoShareAction

awaiting_approvals

Collection for awaitingApprovals

customer

Reference for customer

customer_id

Field for customerID

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

The grantAccess action.

Parameters:
  • access_request_id – accessRequestID (type: string)
  • action_type – actionType (type: string)
  • forbidden_actions – forbiddenActions (type: string[])
grant_object_access(obj_code=None, id=None, accessor_id=None, action_type=None, forbidden_actions=None)

The grantObjectAccess action.

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

Reference for granter

granter_id

Field for granterID

ignore(access_request_id=None)

The ignore action.

Parameters:access_request_id – accessRequestID (type: string)
last_remind_date

Field for lastRemindDate

last_update_date

Field for lastUpdateDate

message

Field for message

recall(access_request_id=None)

The recall action.

Parameters:access_request_id – accessRequestID (type: string)
remind(access_request_id=None)

The remind action.

Parameters:access_request_id – accessRequestID (type: string)
request_access(obj_code=None, obj_id=None, requestee_id=None, core_action=None, message=None)

The requestAccess action.

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

Field for requestDate

requested_obj_code

Field for requestedObjCode

requested_obj_id

Field for requestedObjID

requested_object_name

Field for requestedObjectName

requestor

Reference for requestor

requestor_id

Field for requestorID

status

Field for status

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

Object for ACSRUL

accessor_id

Field for accessorID

accessor_obj_code

Field for accessorObjCode

ancestor_id

Field for ancestorID

ancestor_obj_code

Field for ancestorObjCode

core_action

Field for coreAction

customer

Reference for customer

customer_id

Field for customerID

forbidden_actions

Field for forbiddenActions

is_inherited

Field for isInherited

secondary_actions

Field for secondaryActions

security_obj_code

Field for securityObjCode

security_obj_id

Field for securityObjID

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

Object for ARPREF

access_level

Reference for accessLevel

access_level_id

Field for accessLevelID

accessor_id

Field for accessorID

accessor_obj_code

Field for accessorObjCode

core_action

Field for coreAction

customer

Reference for customer

customer_id

Field for customerID

forbidden_actions

Field for forbiddenActions

secondary_actions

Field for secondaryActions

security_obj_code

Field for securityObjCode

template

Reference for template

template_id

Field for templateID

user

Reference for user

user_id

Field for userID

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

Object for ACSCP

allow_non_view_external

Field for allowNonViewExternal

allow_non_view_hd

Field for allowNonViewHD

allow_non_view_review

Field for allowNonViewReview

allow_non_view_team

Field for allowNonViewTeam

allow_non_view_ts

Field for allowNonViewTS

app_global

Reference for appGlobal

app_global_id

Field for appGlobalID

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

description_key

Field for descriptionKey

display_order

Field for displayOrder

name

Field for name

name_key

Field for nameKey

obj_id

Field for objID

obj_obj_code

Field for objObjCode

scope_expression

Field for scopeExpression

scope_obj_code

Field for scopeObjCode

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

Object for ASCPAT

access_level

Reference for accessLevel

access_level_id

Field for accessLevelID

access_scope

Reference for accessScope

access_scope_id

Field for accessScopeID

actions

Field for actions

customer

Reference for customer

customer_id

Field for customerID

scope_obj_code

Field for scopeObjCode

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

Object for ACSTOK

action

Field for action

calendar

Reference for calendar

calendar_id

Field for calendarID

customer

Reference for customer

customer_id

Field for customerID

document

Reference for document

document_id

Field for documentID

document_request

Reference for documentRequest

document_request_id

Field for documentRequestID

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

expire_date

Field for expireDate

ref_obj_code

Field for refObjCode

ref_obj_id

Field for refObjID

token_type

Field for tokenType

user

Reference for user

user_id

Field for userID

value

Field for value

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

Object for ACNTRP

admin_level

Field for adminLevel

description

Field for description

email_addr

Field for emailAddr

ext_ref_id

Field for extRefID

first_name

Field for firstName

is_active

Field for isActive

last_name

Field for lastName

password

Field for password

phone_number

Field for phoneNumber

reseller

Reference for reseller

reseller_id

Field for resellerID

ui_code

Field for uiCode

username

Field for username

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

Object for ACK

acknowledge(obj_code=None, obj_id=None)

The acknowledge action.

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

string

acknowledge_many(obj_code_ids=None)

The acknowledgeMany action.

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

Field for acknowledgementType

customer

Reference for customer

customer_id

Field for customerID

entry_date

Field for entryDate

owner

Reference for owner

owner_id

Field for ownerID

reference_object_name

Field for referenceObjectName

target

Reference for target

target_id

Field for targetID

unacknowledge(obj_code=None, obj_id=None)

The unacknowledge action.

Parameters:
  • obj_code – objCode (type: string)
  • obj_id – objID (type: string)
class workfront.versions.unsupported.Announcement(session=None, **fields)

Object for ANCMNT

actual_subject

Field for actualSubject

announcement_recipients

Collection for announcementRecipients

announcement_type

Field for announcementType

attachments

Collection for attachments

content

Field for content

customer_recipients

Field for customerRecipients

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

file_handle(attachment_id=None)

The fileHandle action.

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

Field for formattedRecipients

has_attachments

Field for hasAttachments

is_draft

Field for isDraft

last_sent_date

Field for lastSentDate

other_recipient_names

Field for otherRecipientNames

preview_user_id

Field for previewUserID

recipient_types

Field for recipientTypes

send_draft

Field for sendDraft

subject

Field for subject

summary

Field for summary

type

Field for type

zip_announcement_attachments(announcement_id=None)

The zipAnnouncementAttachments action.

Parameters:announcement_id – announcementID (type: string)
Returns:string
class workfront.versions.unsupported.AnnouncementAttachment(session=None, **fields)

Object for ANMATT

announcement

Reference for announcement

announcement_id

Field for announcementID

doc_size

Field for docSize

file_extension

Field for fileExtension

format_doc_size

Field for formatDocSize

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

The forwardAttachments action.

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

Field for name

upload_attachments(announcement_id=None, attachments=None)

The uploadAttachments action.

Parameters:
  • announcement_id – announcementID (type: string)
  • attachments – attachments (type: map)
class workfront.versions.unsupported.AnnouncementOptOut(session=None, **fields)

Object for AMNTO

announcement_opt_out(announcement_opt_out_types=None)

The announcementOptOut action.

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

Field for announcementType

customer

Reference for customer

customer_id

Field for customerID

customer_name

Field for customerName

opt_out_date

Field for optOutDate

type

Field for type

user

Reference for user

user_first_name

Field for userFirstName

user_id

Field for userID

user_last_name

Field for userLastName

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

Object for ANCREC

announcement

Reference for announcement

announcement_id

Field for announcementID

company

Reference for company

company_id

Field for companyID

customer

Reference for customer

customer_id

Field for customerID

group

Reference for group

group_id

Field for groupID

recipient_id

Field for recipientID

recipient_obj_code

Field for recipientObjCode

role

Reference for role

role_id

Field for roleID

team

Reference for team

team_id

Field for teamID

user

Reference for user

user_id

Field for userID

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

Object for APPBLD

build_id

Field for buildID

build_number

Field for buildNumber

entry_date

Field for entryDate

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

Object for APEVT

app_global

Reference for appGlobal

app_global_id

Field for appGlobalID

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

description_key

Field for descriptionKey

event_obj_code

Field for eventObjCode

event_type

Field for eventType

name

Field for name

name_key

Field for nameKey

obj_id

Field for objID

obj_obj_code

Field for objObjCode

query_expression

Field for queryExpression

script_expression

Field for scriptExpression

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

Object for APGLOB

access_levels

Collection for accessLevels

access_scopes

Collection for accessScopes

app_events

Collection for appEvents

expense_types

Collection for expenseTypes

external_sections

Collection for externalSections

features_mapping

Collection for featuresMapping

hour_types

Collection for hourTypes

layout_templates

Collection for layoutTemplates

meta_records

Collection for metaRecords

portal_profiles

Collection for portalProfiles

portal_sections

Collection for portalSections

ui_filters

Collection for uiFilters

ui_group_bys

Collection for uiGroupBys

ui_views

Collection for uiViews

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

Object for APPINF

attask_version

Field for attaskVersion

build_number

Field for buildNumber

has_upgrade_error

Field for hasUpgradeError

last_update

Field for lastUpdate

upgrade_build

Field for upgradeBuild

upgrade_step

Field for upgradeStep

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

Object for APPROVAL

access_rules

Collection for accessRules

accessor_ids

Field for accessorIDs

actual_benefit

Field for actualBenefit

actual_completion_date

Field for actualCompletionDate

actual_cost

Field for actualCost

actual_duration

Field for actualDuration

actual_duration_expression

Field for actualDurationExpression

actual_duration_minutes

Field for actualDurationMinutes

actual_expense_cost

Field for actualExpenseCost

actual_hours_last_month

Field for actualHoursLastMonth

actual_hours_last_three_months

Field for actualHoursLastThreeMonths

actual_hours_this_month

Field for actualHoursThisMonth

actual_hours_two_months_ago

Field for actualHoursTwoMonthsAgo

actual_labor_cost

Field for actualLaborCost

actual_revenue

Field for actualRevenue

actual_risk_cost

Field for actualRiskCost

actual_start_date

Field for actualStartDate

actual_value

Field for actualValue

actual_work

Field for actualWork

actual_work_required

Field for actualWorkRequired

actual_work_required_expression

Field for actualWorkRequiredExpression

age_range_as_string

Field for ageRangeAsString

alignment

Field for alignment

alignment_score_card

Reference for alignmentScoreCard

alignment_score_card_id

Field for alignmentScoreCardID

alignment_values

Collection for alignmentValues

all_approved_hours

Field for allApprovedHours

all_hours

Collection for allHours

all_priorities

Collection for allPriorities

all_severities

Collection for allSeverities

all_statuses

Collection for allStatuses

all_unapproved_hours

Field for allUnapprovedHours

approval_est_start_date

Field for approvalEstStartDate

approval_planned_start_date

Field for approvalPlannedStartDate

approval_planned_start_day

Field for approvalPlannedStartDay

approval_process

Reference for approvalProcess

approval_process_id

Field for approvalProcessID

approval_projected_start_date

Field for approvalProjectedStartDate

approver_statuses

Collection for approverStatuses

approvers_string

Field for approversString

assigned_to

Reference for assignedTo

assigned_to_id

Field for assignedToID

assignments

Collection for assignments

assignments_list_string

Field for assignmentsListString

audit_note

Field for auditNote

audit_types

Field for auditTypes

audit_user_ids

Field for auditUserIDs

auto_baseline_recur_on

Field for autoBaselineRecurOn

auto_baseline_recurrence_type

Field for autoBaselineRecurrenceType

auto_closure_date

Field for autoClosureDate

awaiting_approvals

Collection for awaitingApprovals

backlog_order

Field for backlogOrder

baselines

Collection for baselines

bccompletion_state

Field for BCCompletionState

billed_revenue

Field for billedRevenue

billing_amount

Field for billingAmount

billing_record

Reference for billingRecord

billing_record_id

Field for billingRecordID

billing_records

Collection for billingRecords

budget

Field for budget

budget_status

Field for budgetStatus

budgeted_completion_date

Field for budgetedCompletionDate

budgeted_cost

Field for budgetedCost

budgeted_hours

Field for budgetedHours

budgeted_labor_cost

Field for budgetedLaborCost

budgeted_start_date

Field for budgetedStartDate

business_case_status_label

Field for businessCaseStatusLabel

can_start

Field for canStart

category

Reference for category

category_id

Field for categoryID

children

Collection for children

color

Field for color

commit_date

Field for commitDate

commit_date_range

Field for commitDateRange

company

Reference for company

company_id

Field for companyID

completion_pending_date

Field for completionPendingDate

completion_type

Field for completionType

condition

Field for condition

condition_type

Field for conditionType

constraint_date

Field for constraintDate

converted_op_task_entry_date

Field for convertedOpTaskEntryDate

converted_op_task_name

Field for convertedOpTaskName

converted_op_task_originator

Reference for convertedOpTaskOriginator

converted_op_task_originator_id

Field for convertedOpTaskOriginatorID

cost_amount

Field for costAmount

cost_type

Field for costType

cpi

Field for cpi

csi

Field for csi

currency

Field for currency

current_approval_step

Reference for currentApprovalStep

current_approval_step_id

Field for currentApprovalStepID

current_status_duration

Field for currentStatusDuration

customer

Reference for customer

customer_id

Field for customerID

days_late

Field for daysLate

default_baseline

Reference for defaultBaseline

default_baseline_task

Reference for defaultBaselineTask

default_forbidden_contribute_actions

Field for defaultForbiddenContributeActions

default_forbidden_manage_actions

Field for defaultForbiddenManageActions

default_forbidden_view_actions

Field for defaultForbiddenViewActions

deliverable_score_card

Reference for deliverableScoreCard

deliverable_score_card_id

Field for deliverableScoreCardID

deliverable_success_score

Field for deliverableSuccessScore

deliverable_success_score_ratio

Field for deliverableSuccessScoreRatio

deliverable_values

Collection for deliverableValues

description

Field for description

display_order

Field for displayOrder

display_queue_breadcrumb

Field for displayQueueBreadcrumb

document_requests

Collection for documentRequests

documents

Collection for documents

done_statuses

Collection for doneStatuses

due_date

Field for dueDate

duration

Field for duration

duration_expression

Field for durationExpression

duration_minutes

Field for durationMinutes

duration_type

Field for durationType

duration_unit

Field for durationUnit

eac

Field for eac

eac_calculation_method

Field for eacCalculationMethod

enable_auto_baselines

Field for enableAutoBaselines

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

est_completion_date

Field for estCompletionDate

est_start_date

Field for estStartDate

estimate

Field for estimate

exchange_rate

Reference for exchangeRate

exchange_rates

Collection for exchangeRates

expenses

Collection for expenses

ext_ref_id

Field for extRefID

filter_hour_types

Field for filterHourTypes

finance_last_update_date

Field for financeLastUpdateDate

first_response

Field for firstResponse

fixed_cost

Field for fixedCost

fixed_end_date

Field for fixedEndDate

fixed_revenue

Field for fixedRevenue

fixed_start_date

Field for fixedStartDate

group

Reference for group

group_id

Field for groupID

handoff_date

Field for handoffDate

has_budget_conflict

Field for hasBudgetConflict

has_calc_error

Field for hasCalcError

has_completion_constraint

Field for hasCompletionConstraint

has_documents

Field for hasDocuments

has_expenses

Field for hasExpenses

has_messages

Field for hasMessages

has_notes

Field for hasNotes

has_rate_override

Field for hasRateOverride

has_resolvables

Field for hasResolvables

has_start_constraint

Field for hasStartConstraint

has_timed_notifications

Field for hasTimedNotifications

has_timeline_exception

Field for hasTimelineException

hour_types

Collection for hourTypes

hours

Collection for hours

hours_per_point

Field for hoursPerPoint

how_old

Field for howOld

indent

Field for indent

is_agile

Field for isAgile

is_complete

Field for isComplete

is_critical

Field for isCritical

is_duration_locked

Field for isDurationLocked

is_help_desk

Field for isHelpDesk

is_in_my_approvals(object_type=None, object_id=None)

The isInMyApprovals action.

Parameters:
  • object_type – objectType (type: string)
  • object_id – objectID (type: string)
Returns:

java.lang.Boolean

is_in_my_submitted_approvals(object_type=None, object_id=None)

The isInMySubmittedApprovals action.

Parameters:
  • object_type – objectType (type: string)
  • object_id – objectID (type: string)
Returns:

java.lang.Boolean

is_leveling_excluded

Field for isLevelingExcluded

is_project_dead

Field for isProjectDead

is_ready

Field for isReady

is_status_complete

Field for isStatusComplete

is_work_required_locked

Field for isWorkRequiredLocked

iteration

Reference for iteration

iteration_id

Field for iterationID

last_calc_date

Field for lastCalcDate

last_condition_note

Reference for lastConditionNote

last_condition_note_id

Field for lastConditionNoteID

last_note

Reference for lastNote

last_note_id

Field for lastNoteID

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

leveling_mode

Field for levelingMode

leveling_start_delay

Field for levelingStartDelay

leveling_start_delay_expression

Field for levelingStartDelayExpression

leveling_start_delay_minutes

Field for levelingStartDelayMinutes

lucid_migration_date

Field for lucidMigrationDate

master_task

Reference for masterTask

master_task_id

Field for masterTaskID

milestone

Reference for milestone

milestone_id

Field for milestoneID

milestone_path

Reference for milestonePath

milestone_path_id

Field for milestonePathID

name

Field for name

next_auto_baseline_date

Field for nextAutoBaselineDate

notification_records

Collection for notificationRecords

number_of_children

Field for numberOfChildren

number_open_op_tasks

Field for numberOpenOpTasks

object_categories

Collection for objectCategories

olv

Field for olv

op_task_type

Field for opTaskType

op_task_type_label

Field for opTaskTypeLabel

op_tasks

Collection for opTasks

open_op_tasks

Collection for openOpTasks

optimization_score

Field for optimizationScore

original_duration

Field for originalDuration

original_work_required

Field for originalWorkRequired

owner

Reference for owner

owner_id

Field for ownerID

owner_privileges

Field for ownerPrivileges

parameter_values

Collection for parameterValues

parent

Reference for parent

parent_id

Field for parentID

parent_lag

Field for parentLag

parent_lag_type

Field for parentLagType

pending_calculation

Field for pendingCalculation

pending_predecessors

Field for pendingPredecessors

pending_update_methods

Field for pendingUpdateMethods

percent_complete

Field for percentComplete

performance_index_method

Field for performanceIndexMethod

personal

Field for personal

planned_benefit

Field for plannedBenefit

planned_completion_date

Field for plannedCompletionDate

planned_cost

Field for plannedCost

planned_date_alignment

Field for plannedDateAlignment

planned_duration

Field for plannedDuration

planned_duration_minutes

Field for plannedDurationMinutes

planned_expense_cost

Field for plannedExpenseCost

planned_hours_alignment

Field for plannedHoursAlignment

planned_labor_cost

Field for plannedLaborCost

planned_revenue

Field for plannedRevenue

planned_risk_cost

Field for plannedRiskCost

planned_start_date

Field for plannedStartDate

planned_value

Field for plannedValue

pop_account

Reference for popAccount

pop_account_id

Field for popAccountID

portfolio

Reference for portfolio

portfolio_id

Field for portfolioID

portfolio_priority

Field for portfolioPriority

predecessor_expression

Field for predecessorExpression

predecessors

Collection for predecessors

previous_status

Field for previousStatus

primary_assignment

Reference for primaryAssignment

priority

Field for priority

program

Reference for program

program_id

Field for programID

progress_status

Field for progressStatus

project

Reference for project

project_id

Field for projectID

project_user_roles

Collection for projectUserRoles

project_users

Collection for projectUsers

projected_completion_date

Field for projectedCompletionDate

projected_duration_minutes

Field for projectedDurationMinutes

projected_start_date

Field for projectedStartDate

queue_def

Reference for queueDef

queue_def_id

Field for queueDefID

queue_topic

Reference for queueTopic

queue_topic_breadcrumb

Field for queueTopicBreadcrumb

queue_topic_id

Field for queueTopicID

rates

Collection for rates

recurrence_number

Field for recurrenceNumber

recurrence_rule

Reference for recurrenceRule

recurrence_rule_id

Field for recurrenceRuleID

reference_number

Field for referenceNumber

reference_obj_code

Field for referenceObjCode

reference_obj_id

Field for referenceObjID

rejection_issue

Reference for rejectionIssue

rejection_issue_id

Field for rejectionIssueID

remaining_cost

Field for remainingCost

remaining_duration_minutes

Field for remainingDurationMinutes

remaining_revenue

Field for remainingRevenue

remaining_risk_cost

Field for remainingRiskCost

reserved_time

Reference for reservedTime

reserved_time_id

Field for reservedTimeID

resolution_time

Field for resolutionTime

resolvables

Collection for resolvables

resolve_op_task

Reference for resolveOpTask

resolve_op_task_id

Field for resolveOpTaskID

resolve_project

Reference for resolveProject

resolve_project_id

Field for resolveProjectID

resolve_task

Reference for resolveTask

resolve_task_id

Field for resolveTaskID

resolving_obj_code

Field for resolvingObjCode

resolving_obj_id

Field for resolvingObjID

resource_allocations

Collection for resourceAllocations

resource_pool

Reference for resourcePool

resource_pool_id

Field for resourcePoolID

resource_scope

Field for resourceScope

revenue_type

Field for revenueType

risk

Field for risk

risk_performance_index

Field for riskPerformanceIndex

risks

Collection for risks

roi

Field for roi

role

Reference for role

role_id

Field for roleID

roles

Collection for roles

routing_rules

Collection for routingRules

schedule

Reference for schedule

schedule_id

Field for scheduleID

schedule_mode

Field for scheduleMode

security_ancestors

Collection for securityAncestors

security_ancestors_disabled

Field for securityAncestorsDisabled

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

selected_on_portfolio_optimizer

Field for selectedOnPortfolioOptimizer

severity

Field for severity

sharing_settings

Reference for sharingSettings

show_commit_date

Field for showCommitDate

show_condition

Field for showCondition

show_status

Field for showStatus

slack_date

Field for slackDate

source_obj_code

Field for sourceObjCode

source_obj_id

Field for sourceObjID

source_task

Reference for sourceTask

source_task_id

Field for sourceTaskID

spi

Field for spi

sponsor

Reference for sponsor

sponsor_id

Field for sponsorID

status

Field for status

status_equates_with

Field for statusEquatesWith

status_update

Field for statusUpdate

submitted_by

Reference for submittedBy

submitted_by_id

Field for submittedByID

successors

Collection for successors

summary_completion_type

Field for summaryCompletionType

task_constraint

Field for taskConstraint

task_number

Field for taskNumber

task_number_predecessor_string

Field for taskNumberPredecessorString

tasks

Collection for tasks

team

Reference for team

team_assignment

Reference for teamAssignment

team_id

Field for teamID

template

Reference for template

template_id

Field for templateID

template_task

Reference for templateTask

template_task_id

Field for templateTaskID

timeline_exception_info

Field for timelineExceptionInfo

total_hours

Field for totalHours

total_op_task_count

Field for totalOpTaskCount

total_task_count

Field for totalTaskCount

tracking_mode

Field for trackingMode

update_type

Field for updateType

updates

Collection for updates

url

Field for URL

url_

Field for url

version

Field for version

wbs

Field for wbs

work

Field for work

work_item

Reference for workItem

work_required

Field for workRequired

work_required_expression

Field for workRequiredExpression

work_unit

Field for workUnit

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

Object for ARVPTH

approval_process

Reference for approvalProcess

approval_process_id

Field for approvalProcessID

approval_steps

Collection for approvalSteps

customer

Reference for customer

customer_id

Field for customerID

duration_minutes

Field for durationMinutes

duration_unit

Field for durationUnit

rejected_status

Field for rejectedStatus

rejected_status_label

Field for rejectedStatusLabel

should_create_issue

Field for shouldCreateIssue

target_status

Field for targetStatus

target_status_label

Field for targetStatusLabel

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

Object for ARVPRC

accessor_ids

Field for accessorIDs

approval_obj_code

Field for approvalObjCode

approval_paths

Collection for approvalPaths

approval_statuses

Field for approvalStatuses

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

duration_minutes

Field for durationMinutes

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

ext_ref_id

Field for extRefID

is_private

Field for isPrivate

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

name

Field for name

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

Object for APRPROCATCH

allowed_actions

Field for allowedActions

approval_est_start_date

Field for approvalEstStartDate

approval_planned_start_date

Field for approvalPlannedStartDate

approval_planned_start_day

Field for approvalPlannedStartDay

approval_process

Reference for approvalProcess

approval_process_id

Field for approvalProcessID

approval_projected_start_date

Field for approvalProjectedStartDate

approver_statuses

Collection for approverStatuses

category

Reference for category

category_id

Field for categoryID

current_approval_step

Reference for currentApprovalStep

current_approval_step_id

Field for currentApprovalStepID

force_edit

Field for forceEdit

object_categories

Collection for objectCategories

parameter_values

Collection for parameterValues

previous_status

Field for previousStatus

rejection_issue

Reference for rejectionIssue

rejection_issue_id

Field for rejectionIssueID

submitted_by

Reference for submittedBy

submitted_by_id

Field for submittedByID

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

Object for ARVSTP

approval_path

Reference for approvalPath

approval_path_id

Field for approvalPathID

approval_type

Field for approvalType

customer

Reference for customer

customer_id

Field for customerID

name

Field for name

sequence_number

Field for sequenceNumber

step_approvers

Collection for stepApprovers

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

Object for ARVSTS

approvable_obj_code

Field for approvableObjCode

approvable_obj_id

Field for approvableObjID

approval_step

Reference for approvalStep

approval_step_id

Field for approvalStepID

approved_by

Reference for approvedBy

approved_by_id

Field for approvedByID

customer

Reference for customer

customer_id

Field for customerID

delegate_user

Reference for delegateUser

delegate_user_id

Field for delegateUserID

is_overridden

Field for isOverridden

op_task

Reference for opTask

op_task_id

Field for opTaskID

overridden_user

Reference for overriddenUser

overridden_user_id

Field for overriddenUserID

project

Reference for project

project_id

Field for projectID

status

Field for status

step_approver

Reference for stepApprover

step_approver_id

Field for stepApproverID

task

Reference for task

task_id

Field for taskID

wildcard_user

Reference for wildcardUser

wildcard_user_id

Field for wildcardUserID

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

Object for ASSGN

accessor_ids

Field for accessorIDs

actual_work_completed

Field for actualWorkCompleted

actual_work_per_day_start_date

Field for actualWorkPerDayStartDate

assigned_by

Reference for assignedBy

assigned_by_id

Field for assignedByID

assigned_to

Reference for assignedTo

assigned_to_id

Field for assignedToID

assignment_percent

Field for assignmentPercent

avg_work_per_day

Field for avgWorkPerDay

customer

Reference for customer

customer_id

Field for customerID

feedback_status

Field for feedbackStatus

is_primary

Field for isPrimary

is_team_assignment

Field for isTeamAssignment

olv

Field for olv

op_task

Reference for opTask

op_task_id

Field for opTaskID

planned_user_allocation_percentage

Field for plannedUserAllocationPercentage

project

Reference for project

project_id

Field for projectID

projected_avg_work_per_day

Field for projectedAvgWorkPerDay

projected_user_allocation_percentage

Field for projectedUserAllocationPercentage

role

Reference for role

role_id

Field for roleID

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

status

Field for status

task

Reference for task

task_id

Field for taskID

team

Reference for team

team_id

Field for teamID

work

Field for work

work_item

Reference for workItem

work_required

Field for workRequired

work_unit

Field for workUnit

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

Object for AUDS

action_count

Field for actionCount

all_accessed_users()

The allAccessedUsers action.

Returns:map
all_admins()

The allAdmins action.

Returns:map
audit_session(user_id=None, target_user_id=None)

The auditSession action.

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

string

customer

Reference for customer

customer_id

Field for customerID

end_audit(session_id=None)

The endAudit action.

Parameters:session_id – sessionID (type: string)
end_date

Field for endDate

get_accessed_users(user_id=None)

The getAccessedUsers action.

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

Collection for journalEntries

note_count

Field for noteCount

notes

Collection for notes

session_id

Field for sessionID

start_date

Field for startDate

target_user

Reference for targetUser

target_user_display

Field for targetUserDisplay

target_user_id

Field for targetUserID

user

Reference for user

user_display

Field for userDisplay

user_id

Field for userID

who_accessed_user(user_id=None)

The whoAccessedUser action.

Parameters:user_id – userID (type: string)
Returns:map
class workfront.versions.unsupported.Authentication(session=None, **fields)

Object for AUTH

create_public_session()

The createPublicSession action.

Returns:map
create_schema()

The createSchema action.

create_session()

The createSession action.

Returns:map
get_days_to_expiration_for_user()

The getDaysToExpirationForUser action.

Returns:java.lang.Integer
get_password_complexity_by_token(token=None)

The getPasswordComplexityByToken action.

Parameters:token – token (type: string)
Returns:string
get_password_complexity_by_username(username=None)

The getPasswordComplexityByUsername action.

Parameters:username – username (type: string)
Returns:string
get_ssooption_by_domain(domain=None)

The getSSOOptionByDomain action.

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

The getUpgradesInfo action.

Returns:map
login_with_user_name(session_id=None, username=None)

The loginWithUserName action.

Parameters:
  • session_id – sessionID (type: string)
  • username – username (type: string)
Returns:

map

login_with_user_name_and_password(username=None, password=None)

The loginWithUserNameAndPassword action.

Parameters:
  • username – username (type: string)
  • password – password (type: string)
Returns:

map

logout(sso_user=None, is_mobile=None)

The logout action.

Parameters:
  • sso_user – ssoUser (type: boolean)
  • is_mobile – isMobile (type: boolean)
obj_code

Field for objCode

perform_upgrade()

The performUpgrade action.

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

The resetPassword action.

Parameters:
  • user_name – userName (type: string)
  • old_password – oldPassword (type: string)
  • new_password – newPassword (type: string)
reset_password_by_token(token=None, new_password=None)

The resetPasswordByToken action.

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

string

upgrade_progress()

The upgradeProgress action.

Returns:map
class workfront.versions.unsupported.Avatar(session=None, **fields)

Object for AVATAR

allowed_actions

Field for allowedActions

avatar_date

Field for avatarDate

avatar_download_url

Field for avatarDownloadURL

avatar_size

Field for avatarSize

avatar_x

Field for avatarX

avatar_y

Field for avatarY

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

The cropUnsavedAvatarFile action.

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

string

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

The getAvatarData action.

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

string

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

The getAvatarDownloadURL action.

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

string

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

The getAvatarFile action.

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

string

handle

Field for handle

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

The resizeUnsavedAvatarFile action.

Parameters:
  • handle – handle (type: string)
  • width – width (type: int)
  • height – height (type: int)
class workfront.versions.unsupported.AwaitingApproval(session=None, **fields)

Object for AWAPVL

access_request

Reference for accessRequest

access_request_id

Field for accessRequestID

approvable_id

Field for approvableID

approver_id

Field for approverID

customer

Reference for customer

customer_id

Field for customerID

document

Reference for document

document_id

Field for documentID

entry_date

Field for entryDate

get_my_awaiting_approvals_count()

The getMyAwaitingApprovalsCount action.

Returns:java.lang.Integer
get_my_awaiting_approvals_filtered_count(object_type=None)

The getMyAwaitingApprovalsFilteredCount action.

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

The getMySubmittedAwaitingApprovalsCount action.

Returns:java.lang.Integer
op_task

Reference for opTask

op_task_id

Field for opTaskID

project

Reference for project

project_id

Field for projectID

role

Reference for role

role_id

Field for roleID

submitted_by

Reference for submittedBy

submitted_by_id

Field for submittedByID

task

Reference for task

task_id

Field for taskID

team

Reference for team

team_id

Field for teamID

timesheet

Reference for timesheet

timesheet_id

Field for timesheetID

user

Reference for user

user_id

Field for userID

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

Object for BKGJOB

access_count

Field for accessCount

cache_key

Field for cacheKey

can_enqueue_export()

The canEnqueueExport action.

Returns:java.lang.Boolean
changed_objects

Field for changedObjects

customer

Reference for customer

customer_id

Field for customerID

end_date

Field for endDate

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

error_message

Field for errorMessage

expiration_date

Field for expirationDate

file_for_completed_job(increase_access_count=None)

The fileForCompletedJob action.

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

Field for handlerClassName

max_progress

Field for maxProgress

migrate_journal_field_wild_card()

The migrateJournalFieldWildCard action.

Returns:string
migrate_ppmto_anaconda()

The migratePPMToAnaconda action.

Returns:string
percent_complete

Field for percentComplete

progress

Field for progress

progress_text

Field for progressText

running_jobs_count(handler_class_name=None)

The runningJobsCount action.

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

Field for startDate

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

The startKickStartDownload action.

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

string

status

Field for status

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

Object for BLIN

actual_completion_date

Field for actualCompletionDate

actual_cost

Field for actualCost

actual_duration_minutes

Field for actualDurationMinutes

actual_start_date

Field for actualStartDate

actual_work_required

Field for actualWorkRequired

auto_generated

Field for autoGenerated

baseline_tasks

Collection for baselineTasks

budget

Field for budget

condition

Field for condition

cpi

Field for cpi

csi

Field for csi

customer

Reference for customer

customer_id

Field for customerID

duration_minutes

Field for durationMinutes

eac

Field for eac

entry_date

Field for entryDate

est_completion_date

Field for estCompletionDate

est_start_date

Field for estStartDate

is_default

Field for isDefault

name

Field for name

percent_complete

Field for percentComplete

planned_completion_date

Field for plannedCompletionDate

planned_cost

Field for plannedCost

planned_start_date

Field for plannedStartDate

progress_status

Field for progressStatus

project

Reference for project

project_id

Field for projectID

projected_completion_date

Field for projectedCompletionDate

projected_start_date

Field for projectedStartDate

spi

Field for spi

work_required

Field for workRequired

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

Object for BSTSK

actual_completion_date

Field for actualCompletionDate

actual_cost

Field for actualCost

actual_duration_minutes

Field for actualDurationMinutes

actual_start_date

Field for actualStartDate

actual_work_required

Field for actualWorkRequired

baseline

Reference for baseline

baseline_id

Field for baselineID

cpi

Field for cpi

csi

Field for csi

customer

Reference for customer

customer_id

Field for customerID

duration_minutes

Field for durationMinutes

duration_unit

Field for durationUnit

eac

Field for eac

entry_date

Field for entryDate

est_completion_date

Field for estCompletionDate

est_start_date

Field for estStartDate

is_default

Field for isDefault

name

Field for name

percent_complete

Field for percentComplete

planned_completion_date

Field for plannedCompletionDate

planned_cost

Field for plannedCost

planned_start_date

Field for plannedStartDate

progress_status

Field for progressStatus

projected_completion_date

Field for projectedCompletionDate

projected_start_date

Field for projectedStartDate

spi

Field for spi

task

Reference for task

task_id

Field for taskID

work_required

Field for workRequired

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

Object for BILL

accessor_ids

Field for accessorIDs

amount

Field for amount

billable_tasks

Collection for billableTasks

billing_date

Field for billingDate

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

display_name

Field for displayName

expenses

Collection for expenses

ext_ref_id

Field for extRefID

hours

Collection for hours

invoice_id

Field for invoiceID

other_amount

Field for otherAmount

po_number

Field for poNumber

project

Reference for project

project_id

Field for projectID

status

Field for status

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

Object for BRND

customer

Reference for customer

customer_id

Field for customerID

details

Field for details

last_update_date

Field for lastUpdateDate

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

Object for BDNEVT

apply_date

Field for applyDate

burndown_obj_code

Field for burndownObjCode

burndown_obj_id

Field for burndownObjID

customer

Reference for customer

customer_id

Field for customerID

delta_points_complete

Field for deltaPointsComplete

delta_total_items

Field for deltaTotalItems

delta_total_points

Field for deltaTotalPoints

entry_date

Field for entryDate

event_obj_code

Field for eventObjCode

event_obj_id

Field for eventObjID

is_complete

Field for isComplete

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

Object for CALEVT

calendar_section

Reference for calendarSection

calendar_section_id

Field for calendarSectionID

color

Field for color

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

end_date

Field for endDate

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

ext_ref_id

Field for extRefID

name

Field for name

start_date

Field for startDate

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

Object for CALITM

allowed_actions

Field for allowedActions

assigned_to_id

Field for assignedToID

assigned_to_name

Field for assignedToName

assigned_to_title

Field for assignedToTitle

calendar_event

Reference for calendarEvent

calendar_event_id

Field for calendarEventID

calendar_section_ids

Field for calendarSectionIDs

color

Field for color

due_date

Field for dueDate

end_date

Field for endDate

obj_code

Field for objCode

op_task

Reference for opTask

op_task_id

Field for opTaskID

percent_complete

Field for percentComplete

project

Reference for project

project_display_name

Field for projectDisplayName

project_id

Field for projectID

ref_name

Field for refName

ref_obj_code

Field for refObjCode

ref_obj_id

Field for refObjID

start_date

Field for startDate

status

Field for status

task

Reference for task

task_id

Field for taskID

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

Object for CALEND

access_rules

Collection for accessRules

accessor_ids

Field for accessorIDs

calendar_sections

Collection for calendarSections

create_first_calendar()

The createFirstCalendar action.

Returns:string
create_project_section(project_id=None, color=None)

The createProjectSection action.

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

string

customer

Reference for customer

customer_id

Field for customerID

is_public

Field for isPublic

name

Field for name

public_token

Field for publicToken

run_as_user

Reference for runAsUser

run_as_user_id

Field for runAsUserID

security_ancestors

Collection for securityAncestors

security_ancestors_disabled

Field for securityAncestorsDisabled

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

user

Reference for user

user_id

Field for userID

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

Object for CALPTL

calendar_info

Reference for calendarInfo

calendar_info_id

Field for calendarInfoID

customer

Reference for customer

customer_id

Field for customerID

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

name

Field for name

obj_id

Field for objID

obj_obj_code

Field for objObjCode

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

Object for CALSEC

cal_events

Field for calEvents

calendar

Reference for calendar

calendar_events

Collection for calendarEvents

calendar_id

Field for calendarID

callable_expressions

Collection for callableExpressions

color

Field for color

customer

Reference for customer

customer_id

Field for customerID

duration

Field for duration

filters

Collection for filters

get_concatenated_expression_form(expression=None)

The getConcatenatedExpressionForm action.

Parameters:expression – expression (type: string)
Returns:string
get_pretty_expression_form(expression=None)

The getPrettyExpressionForm action.

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

Field for milestone

name

Field for name

planned_date

Field for plannedDate

start_date

Field for startDate

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

Object for CALEXP

customer

Reference for customer

customer_id

Field for customerID

expression

Field for expression

ui_obj_code

Field for uiObjCode

validate_callable_expression(custom_expression=None)

The validateCallableExpression action.

Parameters:custom_expression – customExpression (type: string)
class workfront.versions.unsupported.Category(session=None, **fields)

Object for CTGY

access_rules

Collection for accessRules

accessor_ids

Field for accessorIDs

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

The assignCategories action.

Parameters:
  • obj_id – objID (type: string)
  • obj_code – objCode (type: string)
  • category_ids – categoryIDs (type: string[])
assign_category(obj_id=None, obj_code=None, category_id=None)

The assignCategory action.

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

The calculateDataExtension action.

cat_obj_code

Field for catObjCode

category_access_rules

Collection for categoryAccessRules

category_cascade_rules

Collection for categoryCascadeRules

category_parameters

Collection for categoryParameters

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

ext_ref_id

Field for extRefID

get_expression_types()

The getExpressionTypes action.

Returns:map
get_filtered_categories(obj_code=None, object_id=None, object_map=None)

The getFilteredCategories action.

Parameters:
  • obj_code – objCode (type: string)
  • object_id – objectID (type: string)
  • object_map – objectMap (type: map)
Returns:

string[]

get_formula_calculated_expression(custom_expression=None)

The getFormulaCalculatedExpression action.

Parameters:custom_expression – customExpression (type: string)
Returns:string
get_friendly_calculated_expression(custom_expression=None)

The getFriendlyCalculatedExpression action.

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

Reference for group

group_id

Field for groupID

has_calculated_fields

Field for hasCalculatedFields

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

name

Field for name

other_groups

Collection for otherGroups

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

The reorderCategories action.

Parameters:
  • obj_id – objID (type: string)
  • obj_code – objCode (type: string)
  • category_ids – categoryIDs (type: string[])
unassign_categories(obj_id=None, obj_code=None, category_ids=None)

The unassignCategories action.

Parameters:
  • obj_id – objID (type: string)
  • obj_code – objCode (type: string)
  • category_ids – categoryIDs (type: string[])
unassign_category(obj_id=None, obj_code=None, category_id=None)

The unassignCategory action.

Parameters:
  • obj_id – objID (type: string)
  • obj_code – objCode (type: string)
  • category_id – categoryID (type: string)
update_calculated_parameter_values(category_id=None, parameter_ids=None, should_auto_commit=None)

The updateCalculatedParameterValues action.

Parameters:
  • category_id – categoryID (type: string)
  • parameter_ids – parameterIDs (type: string[])
  • should_auto_commit – shouldAutoCommit (type: boolean)
validate_custom_expression(cat_obj_code=None, custom_expression=None)

The validateCustomExpression action.

Parameters:
  • cat_obj_code – catObjCode (type: string)
  • custom_expression – customExpression (type: string)
class workfront.versions.unsupported.CategoryAccessRule(session=None, **fields)

Object for CATACR

accessor_id

Field for accessorID

accessor_obj_code

Field for accessorObjCode

category

Reference for category

category_id

Field for categoryID

customer

Reference for customer

customer_id

Field for customerID

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

Object for CTCSRL

category

Reference for category

category_cascade_rule_matches

Collection for categoryCascadeRuleMatches

category_id

Field for categoryID

customer

Reference for customer

customer_id

Field for customerID

next_parameter

Reference for nextParameter

next_parameter_group

Reference for nextParameterGroup

next_parameter_group_id

Field for nextParameterGroupID

next_parameter_id

Field for nextParameterID

otherwise_parameter

Reference for otherwiseParameter

otherwise_parameter_id

Field for otherwiseParameterID

rule_type

Field for ruleType

to_end_of_form

Field for toEndOfForm

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

Object for CTCSRM

category_cascade_rule

Reference for categoryCascadeRule

category_cascade_rule_id

Field for categoryCascadeRuleID

customer

Reference for customer

customer_id

Field for customerID

match_type

Field for matchType

parameter

Reference for parameter

parameter_id

Field for parameterID

value

Field for value

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

Object for CTGYPA

category

Reference for category

category_id

Field for categoryID

category_parameter_expression

Reference for categoryParameterExpression

custom_expression

Field for customExpression

customer

Reference for customer

customer_id

Field for customerID

display_order

Field for displayOrder

is_invalid_expression

Field for isInvalidExpression

is_journaled

Field for isJournaled

is_required

Field for isRequired

parameter

Reference for parameter

parameter_group

Reference for parameterGroup

parameter_group_id

Field for parameterGroupID

parameter_id

Field for parameterID

row_shared

Field for rowShared

security_level

Field for securityLevel

update_calculated_values

Field for updateCalculatedValues

view_security_level

Field for viewSecurityLevel

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

Object for CTGPEX

category_parameter

Reference for categoryParameter

custom_expression

Field for customExpression

customer

Reference for customer

customer_id

Field for customerID

has_finance_fields

Field for hasFinanceFields

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

Object for CMPY

add_early_access(ids=None)

The addEarlyAccess action.

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

The calculateDataExtension action.

category

Reference for category

category_id

Field for categoryID

customer

Reference for customer

customer_id

Field for customerID

default_interface

Field for defaultInterface

delete_early_access(ids=None)

The deleteEarlyAccess action.

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

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

ext_ref_id

Field for extRefID

has_rate_override

Field for hasRateOverride

has_reference(ids=None)

The hasReference action.

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

Field for isPrimary

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

name

Field for name

object_categories

Collection for objectCategories

parameter_values

Collection for parameterValues

rates

Collection for rates

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

Object for CMPSRV

component_key

Field for componentKey

name

Field for name

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

Object for CSTEM

color

Field for color

custom_enum_orders

Collection for customEnumOrders

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

enum_class

Field for enumClass

equates_with

Field for equatesWith

ext_ref_id

Field for extRefID

get_default_op_task_priority_enum()

The getDefaultOpTaskPriorityEnum action.

Returns:java.lang.Integer
get_default_project_status_enum()

The getDefaultProjectStatusEnum action.

Returns:string
get_default_severity_enum()

The getDefaultSeverityEnum action.

Returns:java.lang.Integer
get_default_task_priority_enum()

The getDefaultTaskPriorityEnum action.

Returns:java.lang.Integer
get_enum_color(enum_class=None, enum_obj_code=None, value=None)

The getEnumColor action.

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

string

is_primary

Field for isPrimary

label

Field for label

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

The setCustomEnums action.

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

map

value

Field for value

value_as_int

Field for valueAsInt

value_as_string

Field for valueAsString

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

Object for CSTEMO

custom_enum

Reference for customEnum

custom_enum_id

Field for customEnumID

customer

Reference for customer

customer_id

Field for customerID

display_order

Field for displayOrder

is_hidden

Field for isHidden

sub_obj_code

Field for subObjCode

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

Object for CSTMNU

children_menus

Collection for childrenMenus

customer

Reference for customer

customer_id

Field for customerID

display_order

Field for displayOrder

is_parent

Field for isParent

label

Field for label

menu_obj_code

Field for menuObjCode

obj_id

Field for objID

obj_interface

Field for objInterface

portal_profile

Reference for portalProfile

target_external_section

Reference for targetExternalSection

target_external_section_id

Field for targetExternalSectionID

target_obj_code

Field for targetObjCode

target_obj_id

Field for targetObjID

target_portal_section

Reference for targetPortalSection

target_portal_section_id

Field for targetPortalSectionID

target_portal_tab

Reference for targetPortalTab

target_portal_tab_id

Field for targetPortalTabID

window

Field for window

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

Object for CMSCMS

child

Reference for child

child_id

Field for childID

customer

Reference for customer

customer_id

Field for customerID

display_order

Field for displayOrder

parent

Reference for parent

parent_id

Field for parentID

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

Object for CSTQRT

customer

Reference for customer

customer_id

Field for customerID

end_date

Field for endDate

quarter_label

Field for quarterLabel

start_date

Field for startDate

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

Object for CUST

accept_license_agreement()

The acceptLicenseAgreement action.

access_levels

Collection for accessLevels

access_rules_per_object_limit

Field for accessRulesPerObjectLimit

access_scopes

Collection for accessScopes

account_rep

Reference for accountRep

account_rep_id

Field for accountRepID

account_representative

Field for accountRepresentative

address

Field for address

address2

Field for address2

admin_acct_name

Field for adminAcctName

admin_acct_password

Field for adminAcctPassword

admin_user

Reference for adminUser

admin_user_id

Field for adminUserID

api_concurrency_limit

Field for apiConcurrencyLimit

app_events

Collection for appEvents

approval_processes

Collection for approvalProcesses

biz_rule_exclusions

Field for bizRuleExclusions

categories

Collection for categories

check_license_expiration()

The checkLicenseExpiration action.

Returns:java.lang.Integer
city

Field for city

cloneable

Field for cloneable

country

Field for country

currency

Field for currency

custom_enum_types

Field for customEnumTypes

custom_enums

Collection for customEnums

custom_menus

Collection for customMenus

custom_quarters

Collection for customQuarters

custom_tabs

Collection for customTabs

customer_config_map

Reference for customerConfigMap

customer_config_map_id

Field for customerConfigMapID

customer_prefs

Collection for customerPrefs

customer_urlconfig_map

Reference for customerURLConfigMap

customer_urlconfig_map_id

Field for customerURLConfigMapID

dd_svnversion

Field for ddSVNVersion

demo_baseline_date

Field for demoBaselineDate

description

Field for description

disabled_date

Field for disabledDate

document_requests

Collection for documentRequests

document_size

Field for documentSize

documents

Collection for documents

domain

Field for domain

email_addr

Field for emailAddr

email_templates

Collection for emailTemplates

entry_date

Field for entryDate

eval_exp_date

Field for evalExpDate

event_handlers

Collection for eventHandlers

exp_date

Field for expDate

expense_types

Collection for expenseTypes

ext_ref_id

Field for extRefID

external_document_storage

Field for externalDocumentStorage

external_sections

Collection for externalSections

external_users_enabled

Field for externalUsersEnabled

external_users_group

Reference for externalUsersGroup

external_users_group_id

Field for externalUsersGroupID

extra_document_storage

Field for extraDocumentStorage

finance_representative

Field for financeRepresentative

firstname

Field for firstname

full_users

Field for fullUsers

get_license_info()

The getLicenseInfo action.

Returns:map
golden

Field for golden

groups

Collection for groups

has_documents

Field for hasDocuments

has_preview_access

Field for hasPreviewAccess

has_timed_notifications

Field for hasTimedNotifications

help_desk_config_map

Reference for helpDeskConfigMap

help_desk_config_map_id

Field for helpDeskConfigMapID

hour_types

Collection for hourTypes

import_templates

Collection for importTemplates

inline_java_script_config_map

Reference for inlineJavaScriptConfigMap

inline_java_script_config_map_id

Field for inlineJavaScriptConfigMapID

installed_dditems

Collection for installedDDItems

ip_ranges

Collection for ipRanges

is_advanced_doc_mgmt_enabled

Field for isAdvancedDocMgmtEnabled

is_apienabled

Field for isAPIEnabled

is_async_reporting_enabled

Field for isAsyncReportingEnabled

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

The isBizRuleExclusionEnabled action.

Parameters:
  • biz_rule – bizRule (type: string)
  • obj_code – objCode (type: string)
  • obj_id – objID (type: string)
Returns:

java.lang.Boolean

is_custom_quarter_enabled

Field for isCustomQuarterEnabled

is_dam_enabled

Field for isDamEnabled

is_disabled

Field for isDisabled

is_enterprise

Field for isEnterprise

is_migrated_to_anaconda

Field for isMigratedToAnaconda

is_portal_profile_migrated

Field for isPortalProfileMigrated

is_proofing_enabled

Field for isProofingEnabled

is_search_enabled

Field for isSearchEnabled

is_search_index_active

Field for isSearchIndexActive

is_soapenabled

Field for isSOAPEnabled

is_ssoenabled()

The isSSOEnabled action.

Returns:java.lang.Boolean
is_warning_disabled

Field for isWarningDisabled

is_white_list_ipenabled

Field for isWhiteListIPEnabled

is_workfront_dam_enabled

Field for isWorkfrontDamEnabled

journal_field_limit

Field for journalFieldLimit

journal_fields

Collection for journalFields

kick_start_expoert_dashboards_limit

Field for kickStartExpoertDashboardsLimit

kick_start_expoert_reports_limit

Field for kickStartExpoertReportsLimit

last_remind_date

Field for lastRemindDate

last_usage_report_date

Field for lastUsageReportDate

lastname

Field for lastname

layout_templates

Collection for layoutTemplates

license_orders

Collection for licenseOrders

limited_users

Field for limitedUsers

list_auto_refresh_interval_seconds

Field for listAutoRefreshIntervalSeconds

locale

Field for locale

lucid_migration_date

Field for lucidMigrationDate

lucid_migration_mode

Field for lucidMigrationMode

lucid_migration_options

Field for lucidMigrationOptions

lucid_migration_status

Field for lucidMigrationStatus

lucid_migration_step

Field for lucidMigrationStep

migrate_to_lucid_security(migration_mode=None, migration_options=None)

The migrateToLucidSecurity action.

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

string

milestone_paths

Collection for milestonePaths

name

Field for name

need_license_agreement

Field for needLicenseAgreement

next_usage_report_date

Field for nextUsageReportDate

notification_config_map

Reference for notificationConfigMap

notification_config_map_id

Field for notificationConfigMapID

on_demand_options

Field for onDemandOptions

op_task_count_limit

Field for opTaskCountLimit

parameter_groups

Collection for parameterGroups

parameters

Collection for parameters

password_config_map

Reference for passwordConfigMap

password_config_map_id

Field for passwordConfigMapID

phone_number

Field for phoneNumber

portal_profiles

Collection for portalProfiles

portal_sections

Collection for portalSections

portfolio_management_config_map

Reference for portfolioManagementConfigMap

portfolio_management_config_map_id

Field for portfolioManagementConfigMapID

postal_code

Field for postalCode

project_management_config_map

Reference for projectManagementConfigMap

project_management_config_map_id

Field for projectManagementConfigMapID

proof_account_id

Field for proofAccountID

query_limit

Field for queryLimit

record_limit

Field for recordLimit

requestor_users

Field for requestorUsers

reseller

Reference for reseller

reseller_id

Field for resellerID

reset_lucid_security_migration_progress()

The resetLucidSecurityMigrationProgress action.

resource_pools

Collection for resourcePools

revert_lucid_security_migration()

The revertLucidSecurityMigration action.

review_users

Field for reviewUsers

risk_types

Collection for riskTypes

roles

Collection for roles

sandbox_count

Field for sandboxCount

sandbox_refreshing

Field for sandboxRefreshing

schedules

Collection for schedules

score_cards

Collection for scoreCards

security_model_type

Field for securityModelType

set_exclusions(exclusions=None, state=None)

The setExclusions action.

Parameters:
  • exclusions – exclusions (type: string)
  • state – state (type: boolean)
set_is_custom_quarter_enabled(is_custom_quarter_enabled=None)

The setIsCustomQuarterEnabled action.

Parameters:is_custom_quarter_enabled – isCustomQuarterEnabled (type: boolean)
set_is_white_list_ipenabled(is_white_list_ipenabled=None)

The setIsWhiteListIPEnabled action.

Parameters:is_white_list_ipenabled – isWhiteListIPEnabled (type: boolean)
set_lucid_migration_enabled(enabled=None)

The setLucidMigrationEnabled action.

Parameters:enabled – enabled (type: boolean)
sso_option

Reference for ssoOption

sso_type

Field for ssoType

state

Field for state

status

Field for status

style_sheet

Field for styleSheet

task_count_limit

Field for taskCountLimit

team_users

Field for teamUsers

time_zone

Field for timeZone

timed_notifications

Collection for timedNotifications

timesheet_config_map

Reference for timesheetConfigMap

timesheet_config_map_id

Field for timesheetConfigMapID

trial

Field for trial

ui_config_map

Reference for uiConfigMap

ui_config_map_id

Field for uiConfigMapID

ui_filters

Collection for uiFilters

ui_group_bys

Collection for uiGroupBys

ui_views

Collection for uiViews

update_currency(base_currency=None)

The updateCurrency action.

Parameters:base_currency – baseCurrency (type: string)
update_customer_base(time_zone=None, locale=None, admin_acct_name=None)

The updateCustomerBase action.

Parameters:
  • time_zone – timeZone (type: string)
  • locale – locale (type: string)
  • admin_acct_name – adminAcctName (type: string)
update_proofing_billing_plan(plan_id=None)

The updateProofingBillingPlan action.

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

Field for usageReportAttempts

use_external_document_storage

Field for useExternalDocumentStorage

user_invite_config_map

Reference for userInviteConfigMap

user_invite_config_map_id

Field for userInviteConfigMapID

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

Object for CSFD

comment

Field for comment

customer_guid

Field for customerGUID

entry_date

Field for entryDate

feedback_type

Field for feedbackType

is_admin

Field for isAdmin

is_primary_admin

Field for isPrimaryAdmin

license_type

Field for licenseType

score

Field for score

user_guid

Field for userGUID

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

Object for CSTPRF

customer

Reference for customer

customer_id

Field for customerID

pref_name

Field for prefName

pref_value

Field for prefValue

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

Object for CUSTPR

name

Field for name

obj_code

Field for objCode

possible_values

Field for possibleValues

set_preference(name=None, value=None)

The setPreference action.

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

Field for value

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

Object for CPTC

customer

Reference for customer

customer_id

Field for customerID

olv

Field for olv

start_date

Field for startDate

timeline_calculation_status

Field for timelineCalculationStatus

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

Object for CSTSEC

customer

Reference for customer

customer_id

Field for customerID

section_id

Field for sectionID

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

Object for DOCFLD

customer

Reference for customer

customer_id

Field for customerID

document

Reference for document

document_id

Field for documentID

folder

Reference for folder

folder_id

Field for folderID

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

Object for DOCU

access_rules

Collection for accessRules

accessor_ids

Field for accessorIDs

advanced_proofing_options

Field for advancedProofingOptions

approvals

Collection for approvals

awaiting_approvals

Collection for awaitingApprovals

build_download_manifest(document_idmap=None)

The buildDownloadManifest action.

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

The calculateDataExtension action.

cancel_document_proof(document_version_id=None)

The cancelDocumentProof action.

Parameters:document_version_id – documentVersionID (type: string)
category

Reference for category

category_id

Field for categoryID

check_document_tasks()

The checkDocumentTasks action.

check_in(document_id=None)

The checkIn action.

Parameters:document_id – documentID (type: string)
check_out(document_id=None)

The checkOut action.

Parameters:document_id – documentID (type: string)
checked_out_by

Reference for checkedOutBy

checked_out_by_id

Field for checkedOutByID

copy_document_to_temp_dir(document_id=None)

The copyDocumentToTempDir action.

Parameters:document_id – documentID (type: string)
Returns:string
create_document(name=None, doc_obj_code=None, doc_obj_id=None, file_handle=None, file_type=None, folder_id=None, create_proof=None, advanced_proofing_options=None)

The createDocument action.

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

string

create_proof(document_version_id=None, advanced_proofing_options=None)

The createProof action.

Parameters:
  • document_version_id – documentVersionID (type: string)
  • advanced_proofing_options – advancedProofingOptions (type: string)
create_proof_flag

Field for createProof

current_version

Reference for currentVersion

current_version_id

Field for currentVersionID

customer

Reference for customer

customer_id

Field for customerID

delete_document_proofs(document_id=None)

The deleteDocumentProofs action.

Parameters:document_id – documentID (type: string)
description

Field for description

doc_obj_code

Field for docObjCode

document_provider_id

Field for documentProviderID

document_request

Reference for documentRequest

document_request_id

Field for documentRequestID

download_url

Field for downloadURL

ext_ref_id

Field for extRefID

external_integration_type

Field for externalIntegrationType

file_type

Field for fileType

folder_ids

Field for folderIDs

folders

Collection for folders

get_advanced_proof_options_url()

The getAdvancedProofOptionsURL action.

Returns:string
get_document_contents_in_zip()

The getDocumentContentsInZip action.

Returns:string
get_external_document_contents()

The getExternalDocumentContents action.

Returns:string
get_generic_thumbnail_url(document_version_id=None)

The getGenericThumbnailUrl action.

Parameters:document_version_id – documentVersionID (type: string)
Returns:string
get_proof_details(document_version_id=None)

The getProofDetails action.

Parameters:document_version_id – documentVersionID (type: string)
Returns:map
get_proof_details_url(proof_id=None)

The getProofDetailsURL action.

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

The getProofURL action.

Returns:string
get_proof_usage()

The getProofUsage action.

Returns:map
get_public_generic_thumbnail_url(document_version_id=None, public_token=None)

The getPublicGenericThumbnailUrl action.

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

string

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

The getPublicThumbnailFilePath action.

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

string

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

The getS3DocumentURL action.

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

string

get_thumbnail_data(document_version_id=None, size=None)

The getThumbnailData action.

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

string

get_thumbnail_file_path(document_version_id=None, size=None)

The getThumbnailFilePath action.

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

string

get_total_size_for_documents(document_ids=None, include_linked=None)

The getTotalSizeForDocuments action.

Parameters:
  • document_ids – documentIDs (type: string[])
  • include_linked – includeLinked (type: boolean)
Returns:

java.lang.Long

groups

Collection for groups

handle

Field for handle

handle_proof_callback(callback_xml=None)

The handleProofCallback action.

Parameters:callback_xml – callbackXML (type: string)
has_notes

Field for hasNotes

is_dir

Field for isDir

is_in_linked_folder(document_id=None)

The isInLinkedFolder action.

Parameters:document_id – documentID (type: string)
Returns:java.lang.Boolean
is_linked_document(document_id=None)

The isLinkedDocument action.

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

Field for isPrivate

is_proof_auto_genration_enabled()

The isProofAutoGenrationEnabled action.

Returns:java.lang.Boolean
is_proofable(document_version_id=None)

The isProofable action.

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

Field for isPublic

iteration

Reference for iteration

iteration_id

Field for iterationID

last_mod_date

Field for lastModDate

last_note

Reference for lastNote

last_note_id

Field for lastNoteID

last_sync_date

Field for lastSyncDate

last_update_date

Field for lastUpdateDate

last_updated_by

Reference for lastUpdatedBy

last_updated_by_id

Field for lastUpdatedByID

master_task

Reference for masterTask

master_task_id

Field for masterTaskID

move(obj_id=None, doc_obj_code=None)

The move action.

Parameters:
  • obj_id – objID (type: string)
  • doc_obj_code – docObjCode (type: string)
name

Field for name

obj_id

Field for objID

object_categories

Collection for objectCategories

op_task

Reference for opTask

op_task_id

Field for opTaskID

owner

Reference for owner

owner_id

Field for ownerID

parameter_values

Collection for parameterValues

portfolio

Reference for portfolio

portfolio_id

Field for portfolioID

preview_url

Field for previewURL

process_google_drive_change_notification(push_notification=None)

The processGoogleDriveChangeNotification action.

Parameters:push_notification – pushNotification (type: string)
program

Reference for program

program_id

Field for programID

project

Reference for project

project_id

Field for projectID

public_token

Field for publicToken

reference_number

Field for referenceNumber

reference_obj_code

Field for referenceObjCode

reference_obj_id

Field for referenceObjID

reference_object_closed

Field for referenceObjectClosed

reference_object_name

Field for referenceObjectName

refresh_external_document_info(document_id=None)

The refreshExternalDocumentInfo action.

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

The refreshExternalDocuments action.

The regenerateBoxSharedLink action.

Parameters:document_version_id – documentVersionID (type: string)
release_version

Reference for releaseVersion

release_version_id

Field for releaseVersionID

remind_requestee(document_request_id=None)

The remindRequestee action.

Parameters:document_request_id – documentRequestID (type: string)
Returns:string
save_document_metadata(document_id=None)

The saveDocumentMetadata action.

Parameters:document_id – documentID (type: string)
security_ancestors

Collection for securityAncestors

security_ancestors_disabled

Field for securityAncestorsDisabled

security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

The sendDocumentsToExternalProvider action.

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

The setupGoogleDrivePushNotifications action.

Returns:string
shares

Collection for shares

subscribers

Collection for subscribers

task

Reference for task

task_id

Field for taskID

template

Reference for template

template_id

Field for templateID

template_task

Reference for templateTask

template_task_id

Field for templateTaskID

top_doc_obj_code

Field for topDocObjCode

top_obj_id

Field for topObjID

The unlinkDocuments action.

Parameters:ids – ids (type: string[])
Returns:java.lang.Boolean
upload_documents(document_request_id=None, documents=None)

The uploadDocuments action.

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

string[]

user

Reference for user

user_id

Field for userID

versions

Collection for versions

zip_document_versions()

The zipDocumentVersions action.

Returns:string
zip_documents(obj_code=None, obj_id=None)

The zipDocuments action.

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

string

zip_documents_versions(ids=None)

The zipDocumentsVersions action.

Parameters:ids – ids (type: string[])
Returns:string
class workfront.versions.unsupported.DocumentApproval(session=None, **fields)

Object for DOCAPL

approval_date

Field for approvalDate

approver

Reference for approver

approver_id

Field for approverID

auto_document_share

Reference for autoDocumentShare

auto_document_share_id

Field for autoDocumentShareID

customer

Reference for customer

customer_id

Field for customerID

document

Reference for document

document_id

Field for documentID

note

Reference for note

note_id

Field for noteID

notify_approver(id=None)

The notifyApprover action.

Parameters:id – ID (type: string)
request_date

Field for requestDate

requestor

Reference for requestor

requestor_id

Field for requestorID

status

Field for status

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

Object for DOCFDR

accessor_ids

Field for accessorIDs

children

Collection for children

customer

Reference for customer

customer_id

Field for customerID

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

The deleteFoldersAndContents action.

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

string

documents

Collection for documents

entered_by

Reference for enteredBy

entered_by_id

Field for enteredByID

entry_date

Field for entryDate

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

The getFolderSizeInBytes action.

Parameters:
  • folder_id – folderID (type: string)
  • recursive – recursive (type: boolean)
  • include_linked – includeLinked (type: boolean)
Returns:

java.lang.Long

get_linked_folder_meta_data(linked_folder_id=None)

The getLinkedFolderMetaData action.

Parameters:linked_folder_id – linkedFolderID (type: string)
Returns:string
is_linked_folder(document_folder_id=None)

The isLinkedFolder action.

Parameters:document_folder_id – documentFolderID (type: string)
Returns:java.lang.Boolean
is_smart_folder(document_folder_id=None)

The isSmartFolder action.

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

Reference for issue

issue_id

Field for issueID

iteration

Reference for iteration

iteration_id

Field for iterationID

last_mod_date

Field for lastModDate

linked_folder

Reference for linkedFolder

linked_folder_id

Field for linkedFolderID

name

Field for name

parent

Reference for parent

parent_id

Field for parentID

portfolio

Reference for portfolio

portfolio_id

Field for portfolioID

program

Reference for program

program_id

Field for programID

project

Reference for project

project_id

Field for projectID

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

The refreshLinkedFolder action.

Parameters:
  • linked_folder_id – linkedFolderID (type: string)
  • obj_code – objCode (type: string)
  • object_id – objectID (type: string)
refresh_linked_folder_contents(linked_folder_id=None, obj_code=None, object_id=None)

The refreshLinkedFolderContents action.

Parameters:
  • linked_folder_id – linkedFolderID (type: string)
  • obj_code – objCode (type: string)
  • object_id – objectID (type: string)
refresh_linked_folder_meta_data(linked_folder_id=None)

The refreshLinkedFolderMetaData action.

Parameters:linked_folder_id – linkedFolderID (type: string)
security_root_id

Field for securityRootID

security_root_obj_code

Field for securityRootObjCode

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

The sendFolderToExternalProvider action.

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

string

task

Reference for task

task_id

Field for taskID

template

Reference for template

template_id

Field for templateID

template_task

Reference for templateTask

template_task_id

Field for templateTaskID

The unlinkFolders action.

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

Reference for user

user_id

Field for userID

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

Object for DOCPRO

configuration

Field for configuration

customer

Reference for customer

customer_id

Field for customerID

doc_provider_config

Reference for docProviderConfig

doc_provider_config_id

Field for docProviderConfigID

entry_date

Field for entryDate

external_integration_type

Field for externalIntegrationType

get_all_type_provider_ids(external_integration_type=None, doc_provider_config_id=None)

The getAllTypeProviderIDs action.

Parameters:
  • external_integration_type – externalIntegrationType (type: string)
  • doc_provider_config_id – docProviderConfigID (type: string)
Returns:

string[]

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

The getProviderWithWriteAccess action.

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

string

name

Field for name

owner

Reference for owner

owner_id

Field for ownerID

web_hook_expiration_date

Field for webHookExpirationDate

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

Object for DOCCFG

configuration

Field for configuration

customer

Reference for customer

customer_id

Field for customerID

external_integration_type

Field for externalIntegrationType

host

Field for host

is_active

Field for isActive

name

Field for name

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

Object for DOCMET

customer

Reference for customer

customer_id

Field for customerID

external_integration_type

Field for externalIntegrationType

get_metadata_map_for_provider_type(external_integration_type=None)

The getMetadataMapForProviderType action.

Parameters:external_integration_type – externalIntegrationType (type: string)
Returns:map
load_metadata_for_document(document_id=None, external_integration_type=None)

The loadMetadataForDocument action.

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

map

mapping

Field for mapping

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

Object for DOCREQ

accessor_ids

Field for accessorIDs

completion_date

Field for completionDate

customer

Reference for customer

customer_id

Field for customerID

description

Field for description

entry_date

Field for entryDate

ext_ref_id

Field for extRefID

format_entry_date

Field for formatEntryDate

iteration

Reference for iteration

iteration_id

Field for iterationID

master_task

Reference for masterTask

master_task_id

Field for masterTaskID

op_task

Reference for opTask

op_task_id

Field for opTaskID

portfolio

Reference for portfolio

portfolio_id

Field for portfolioID

program

Reference for program

program_id

Field for programID

project

Reference for project

project_id

Field for projectID

ref_obj_code

Field for refObjCode

ref_obj_id