“unsupported” API Reference¶
-
class
workfront.versions.unsupported.
AccessLevel
(session=None, **fields)¶ Object
forACSLVL
-
access_level_permissions
¶ Collection
foraccessLevelPermissions
-
access_rule_preferences
¶ Collection
foraccessRulePreferences
-
access_scope_actions
¶ Collection
foraccessScopeActions
-
calculate_sharing
(obj_code=None, obj_id=None)¶ The
calculateSharing
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- obj_code – objCode (type:
-
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.
-
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[]
- obj_code – objCode (type:
-
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[]
- user_id – userID (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
legacy_diagnostics
()¶ The
legacyDiagnostics
action.Returns: map
-
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
forALVPER
-
class
workfront.versions.unsupported.
AccessRequest
(session=None, **fields)¶ Object
forACSREQ
Field
forautoShareAction
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
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[]
)
- access_request_id – accessRequestID (type:
-
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[]
)
- obj_code – objCode (type:
-
ignore
(access_request_id=None)¶ The
ignore
action.Parameters: access_request_id – accessRequestID (type: string
)
-
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
)
- obj_code – objCode (type:
-
class
workfront.versions.unsupported.
AccessRulePreference
(session=None, **fields)¶ Object
forARPREF
-
class
workfront.versions.unsupported.
Acknowledgement
(session=None, **fields)¶ Object
forACK
-
acknowledge
(obj_code=None, obj_id=None)¶ The
acknowledge
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
Returns: string
- obj_code – objCode (type:
-
acknowledge_many
(obj_code_ids=None)¶ The
acknowledgeMany
action.Parameters: obj_code_ids – objCodeIDs (type: map
)Returns: string[]
-
unacknowledge
(obj_code=None, obj_id=None)¶ The
unacknowledge
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- obj_code – objCode (type:
-
-
class
workfront.versions.unsupported.
Announcement
(session=None, **fields)¶ Object
forANCMNT
-
announcement_recipients
¶ Collection
forannouncementRecipients
-
attachments
¶ Collection
forattachments
-
file_handle
(attachment_id=None)¶ The
fileHandle
action.Parameters: attachment_id – attachmentID (type: string
)Returns: string
-
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
forANMATT
-
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
)
- announcement_id – announcementID (type:
-
upload_attachments
(announcement_id=None, attachments=None)¶ The
uploadAttachments
action.Parameters: - announcement_id – announcementID (type:
string
) - attachments – attachments (type:
map
)
- announcement_id – announcementID (type:
-
-
class
workfront.versions.unsupported.
AnnouncementOptOut
(session=None, **fields)¶ Object
forAMNTO
-
announcement_opt_out
(announcement_opt_out_types=None)¶ The
announcementOptOut
action.Parameters: announcement_opt_out_types – announcementOptOutTypes (type: string[]
)
-
-
class
workfront.versions.unsupported.
AnnouncementRecipient
(session=None, **fields)¶ Object
forANCREC
-
class
workfront.versions.unsupported.
AppGlobal
(session=None, **fields)¶ Object
forAPGLOB
-
access_levels
¶ Collection
foraccessLevels
-
access_scopes
¶ Collection
foraccessScopes
-
app_events
¶ Collection
forappEvents
-
expense_types
¶ Collection
forexpenseTypes
-
external_sections
¶ Collection
forexternalSections
-
features_mapping
¶ Collection
forfeaturesMapping
-
hour_types
¶ Collection
forhourTypes
-
layout_templates
¶ Collection
forlayoutTemplates
-
meta_records
¶ Collection
formetaRecords
-
portal_profiles
¶ Collection
forportalProfiles
-
portal_sections
¶ Collection
forportalSections
-
ui_filters
¶ Collection
foruiFilters
-
ui_group_bys
¶ Collection
foruiGroupBys
-
ui_views
¶ Collection
foruiViews
-
-
class
workfront.versions.unsupported.
Approval
(session=None, **fields)¶ Object
forAPPROVAL
-
access_rules
¶ Collection
foraccessRules
-
alignment_values
¶ Collection
foralignmentValues
-
all_hours
¶ Collection
forallHours
-
all_priorities
¶ Collection
forallPriorities
-
all_severities
¶ Collection
forallSeverities
-
all_statuses
¶ Collection
forallStatuses
-
approver_statuses
¶ Collection
forapproverStatuses
-
assignments
¶ Collection
forassignments
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
baselines
¶ Collection
forbaselines
-
billing_records
¶ Collection
forbillingRecords
-
children
¶ Collection
forchildren
-
deliverable_values
¶ Collection
fordeliverableValues
Field
fordisplayQueueBreadcrumb
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
done_statuses
¶ Collection
fordoneStatuses
-
exchange_rates
¶ Collection
forexchangeRates
-
expenses
¶ Collection
forexpenses
-
hour_types
¶ Collection
forhourTypes
-
hours
¶ Collection
forhours
-
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
- object_type – objectType (type:
-
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
- object_type – objectType (type:
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
op_tasks
¶ Collection
foropTasks
-
open_op_tasks
¶ Collection
foropenOpTasks
-
parameter_values
¶ Collection
forparameterValues
-
predecessors
¶ Collection
forpredecessors
-
project_user_roles
¶ Collection
forprojectUserRoles
-
project_users
¶ Collection
forprojectUsers
Field
forqueueTopicBreadcrumb
-
rates
¶ Collection
forrates
-
resolvables
¶ Collection
forresolvables
-
resource_allocations
¶ Collection
forresourceAllocations
-
risks
¶ Collection
forrisks
-
roles
¶ Collection
forroles
-
routing_rules
¶ Collection
forroutingRules
-
security_ancestors
¶ Collection
forsecurityAncestors
-
successors
¶ Collection
forsuccessors
-
tasks
¶ Collection
fortasks
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
ApprovalPath
(session=None, **fields)¶ Object
forARVPTH
-
approval_steps
¶ Collection
forapprovalSteps
-
-
class
workfront.versions.unsupported.
ApprovalProcess
(session=None, **fields)¶ Object
forARVPRC
-
approval_paths
¶ Collection
forapprovalPaths
-
-
class
workfront.versions.unsupported.
ApprovalProcessAttachable
(session=None, **fields)¶ Object
forAPRPROCATCH
-
approver_statuses
¶ Collection
forapproverStatuses
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
-
class
workfront.versions.unsupported.
ApprovalStep
(session=None, **fields)¶ Object
forARVSTP
-
step_approvers
¶ Collection
forstepApprovers
-
-
class
workfront.versions.unsupported.
AuditLoginAsSession
(session=None, **fields)¶ Object
forAUDS
-
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
- user_id – userID (type:
-
end_audit
(session_id=None)¶ The
endAudit
action.Parameters: session_id – sessionID (type: string
)
-
get_accessed_users
(user_id=None)¶ The
getAccessedUsers
action.Parameters: user_id – userID (type: string
)Returns: map
-
journal_entries
¶ Collection
forjournalEntries
-
notes
¶ Collection
fornotes
-
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
forAUTH
-
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
- session_id – sessionID (type:
-
login_with_user_name_and_password
(username=None, password=None)¶ The
loginWithUserNameAndPassword
action.Parameters: - username – username (type:
string
) - password – password (type:
string
)
Returns: map
- username – username (type:
-
logout
(sso_user=None, is_mobile=None)¶ The
logout
action.Parameters: - sso_user – ssoUser (type:
boolean
) - is_mobile – isMobile (type:
boolean
)
- sso_user – ssoUser (type:
-
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
)
- user_name – userName (type:
-
reset_password_by_token
(token=None, new_password=None)¶ The
resetPasswordByToken
action.Parameters: - token – token (type:
string
) - new_password – newPassword (type:
string
)
Returns: string
- token – token (type:
-
upgrade_progress
()¶ The
upgradeProgress
action.Returns: map
-
-
class
workfront.versions.unsupported.
Avatar
(session=None, **fields)¶ Object
forAVATAR
-
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
- handle – handle (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
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
- obj_code – objCode (type:
-
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
)
- handle – handle (type:
-
-
class
workfront.versions.unsupported.
AwaitingApproval
(session=None, **fields)¶ Object
forAWAPVL
-
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
-
-
class
workfront.versions.unsupported.
BackgroundJob
(session=None, **fields)¶ Object
forBKGJOB
-
can_enqueue_export
()¶ The
canEnqueueExport
action.Returns: java.lang.Boolean
-
file_for_completed_job
(increase_access_count=None)¶ The
fileForCompletedJob
action.Parameters: increase_access_count – increaseAccessCount (type: boolean
)Returns: string
-
migrate_journal_field_wild_card
()¶ The
migrateJournalFieldWildCard
action.Returns: string
-
migrate_ppmto_anaconda
()¶ The
migratePPMToAnaconda
action.Returns: string
-
running_jobs_count
(handler_class_name=None)¶ The
runningJobsCount
action.Parameters: handler_class_name – handlerClassName (type: string
)Returns: java.lang.Integer
-
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
- export_object_map – exportObjectMap (type:
-
-
class
workfront.versions.unsupported.
Baseline
(session=None, **fields)¶ Object
forBLIN
-
baseline_tasks
¶ Collection
forbaselineTasks
-
-
class
workfront.versions.unsupported.
BillingRecord
(session=None, **fields)¶ Object
forBILL
-
billable_tasks
¶ Collection
forbillableTasks
-
expenses
¶ Collection
forexpenses
-
hours
¶ Collection
forhours
-
-
class
workfront.versions.unsupported.
CalendarInfo
(session=None, **fields)¶ Object
forCALEND
-
access_rules
¶ Collection
foraccessRules
-
calendar_sections
¶ Collection
forcalendarSections
-
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
- project_id – projectID (type:
-
security_ancestors
¶ Collection
forsecurityAncestors
-
-
class
workfront.versions.unsupported.
CalendarPortalSection
(session=None, **fields)¶ Object
forCALPTL
-
class
workfront.versions.unsupported.
CalendarSection
(session=None, **fields)¶ Object
forCALSEC
-
calendar_events
¶ Collection
forcalendarEvents
-
callable_expressions
¶ Collection
forcallableExpressions
-
filters
¶ Collection
forfilters
-
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
-
-
class
workfront.versions.unsupported.
CallableExpression
(session=None, **fields)¶ Object
forCALEXP
-
validate_callable_expression
(custom_expression=None)¶ The
validateCallableExpression
action.Parameters: custom_expression – customExpression (type: string
)
-
-
class
workfront.versions.unsupported.
Category
(session=None, **fields)¶ Object
forCTGY
-
access_rules
¶ Collection
foraccessRules
-
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[]
)
- obj_id – objID (type:
-
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
)
- obj_id – objID (type:
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
category_access_rules
¶ Collection
forcategoryAccessRules
-
category_cascade_rules
¶ Collection
forcategoryCascadeRules
-
category_parameters
¶ Collection
forcategoryParameters
-
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[]
- obj_code – objCode (type:
-
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
-
other_groups
¶ Collection
forotherGroups
-
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[]
)
- obj_id – objID (type:
-
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[]
)
- obj_id – objID (type:
-
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
)
- obj_id – objID (type:
-
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
)
- category_id – categoryID (type:
-
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
)
- cat_obj_code – catObjCode (type:
-
-
class
workfront.versions.unsupported.
CategoryCascadeRule
(session=None, **fields)¶ Object
forCTCSRL
-
category_cascade_rule_matches
¶ Collection
forcategoryCascadeRuleMatches
-
-
class
workfront.versions.unsupported.
CategoryCascadeRuleMatch
(session=None, **fields)¶ Object
forCTCSRM
-
class
workfront.versions.unsupported.
CategoryParameter
(session=None, **fields)¶ Object
forCTGYPA
Field
forrowShared
-
class
workfront.versions.unsupported.
CategoryParameterExpression
(session=None, **fields)¶ Object
forCTGPEX
-
class
workfront.versions.unsupported.
Company
(session=None, **fields)¶ Object
forCMPY
-
add_early_access
(ids=None)¶ The
addEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
delete_early_access
(ids=None)¶ The
deleteEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
rates
¶ Collection
forrates
-
-
class
workfront.versions.unsupported.
CustomEnum
(session=None, **fields)¶ Object
forCSTEM
-
custom_enum_orders
¶ Collection
forcustomEnumOrders
-
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
- enum_class – enumClass (type:
-
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
- type – type (type:
-
-
class
workfront.versions.unsupported.
CustomEnumOrder
(session=None, **fields)¶ Object
forCSTEMO
Field
forisHidden
-
class
workfront.versions.unsupported.
CustomMenu
(session=None, **fields)¶ Object
forCSTMNU
Collection
forchildrenMenus
Field
formenuObjCode
-
class
workfront.versions.unsupported.
CustomMenuCustomMenu
(session=None, **fields)¶ Object
forCMSCMS
-
class
workfront.versions.unsupported.
Customer
(session=None, **fields)¶ Object
forCUST
-
accept_license_agreement
()¶ The
acceptLicenseAgreement
action.
-
access_levels
¶ Collection
foraccessLevels
-
access_scopes
¶ Collection
foraccessScopes
-
app_events
¶ Collection
forappEvents
-
approval_processes
¶ Collection
forapprovalProcesses
-
categories
¶ Collection
forcategories
-
check_license_expiration
()¶ The
checkLicenseExpiration
action.Returns: java.lang.Integer
-
custom_enums
¶ Collection
forcustomEnums
Collection
forcustomMenus
-
custom_quarters
¶ Collection
forcustomQuarters
-
custom_tabs
¶ Collection
forcustomTabs
-
customer_prefs
¶ Collection
forcustomerPrefs
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
email_templates
¶ Collection
foremailTemplates
-
event_handlers
¶ Collection
foreventHandlers
-
expense_types
¶ Collection
forexpenseTypes
-
external_sections
¶ Collection
forexternalSections
-
get_license_info
()¶ The
getLicenseInfo
action.Returns: map
-
groups
¶ Collection
forgroups
-
hour_types
¶ Collection
forhourTypes
-
import_templates
¶ Collection
forimportTemplates
-
installed_dditems
¶ Collection
forinstalledDDItems
-
ip_ranges
¶ Collection
foripRanges
-
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
- biz_rule – bizRule (type:
-
is_ssoenabled
()¶ The
isSSOEnabled
action.Returns: java.lang.Boolean
-
journal_fields
¶ Collection
forjournalFields
-
layout_templates
¶ Collection
forlayoutTemplates
-
license_orders
¶ Collection
forlicenseOrders
-
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
- migration_mode – migrationMode (type:
-
milestone_paths
¶ Collection
formilestonePaths
-
parameter_groups
¶ Collection
forparameterGroups
-
parameters
¶ Collection
forparameters
-
portal_profiles
¶ Collection
forportalProfiles
-
portal_sections
¶ Collection
forportalSections
-
reset_lucid_security_migration_progress
()¶ The
resetLucidSecurityMigrationProgress
action.
-
resource_pools
¶ Collection
forresourcePools
-
revert_lucid_security_migration
()¶ The
revertLucidSecurityMigration
action.
-
risk_types
¶ Collection
forriskTypes
-
roles
¶ Collection
forroles
-
schedules
¶ Collection
forschedules
-
score_cards
¶ Collection
forscoreCards
-
set_exclusions
(exclusions=None, state=None)¶ The
setExclusions
action.Parameters: - exclusions – exclusions (type:
string
) - state – state (type:
boolean
)
- exclusions – exclusions (type:
-
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
)
-
timed_notifications
¶ Collection
fortimedNotifications
-
ui_filters
¶ Collection
foruiFilters
-
ui_group_bys
¶ Collection
foruiGroupBys
-
ui_views
¶ Collection
foruiViews
-
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
)
- time_zone – timeZone (type:
-
update_proofing_billing_plan
(plan_id=None)¶ The
updateProofingBillingPlan
action.Parameters: plan_id – planID (type: string
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
CustomerPreferences
(session=None, **fields)¶ Object
forCUSTPR
-
set_preference
(name=None, value=None)¶ The
setPreference
action.Parameters: - name – name (type:
string
) - value – value (type:
string
)
- name – name (type:
-
-
class
workfront.versions.unsupported.
Document
(session=None, **fields)¶ Object
forDOCU
-
access_rules
¶ Collection
foraccessRules
-
approvals
¶ Collection
forapprovals
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
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
)
-
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
)
-
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
- name – name (type:
-
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
)
- document_version_id – documentVersionID (type:
-
delete_document_proofs
(document_id=None)¶ The
deleteDocumentProofs
action.Parameters: document_id – documentID (type: string
)
-
folders
¶ Collection
forfolders
-
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
- document_version_id – documentVersionID (type:
-
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
- document_version_id – documentVersionID (type:
-
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
- content_disposition – contentDisposition (type:
-
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
- document_version_id – documentVersionID (type:
-
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
- document_version_id – documentVersionID (type:
-
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
- document_ids – documentIDs (type:
-
groups
¶ Collection
forgroups
-
handle_proof_callback
(callback_xml=None)¶ The
handleProofCallback
action.Parameters: callback_xml – callbackXML (type: string
)
-
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_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
-
move
(obj_id=None, doc_obj_code=None)¶ The
move
action.Parameters: - obj_id – objID (type:
string
) - doc_obj_code – docObjCode (type:
string
)
- obj_id – objID (type:
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
process_google_drive_change_notification
(push_notification=None)¶ The
processGoogleDriveChangeNotification
action.Parameters: push_notification – pushNotification (type: string
)
-
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
)
-
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
forsecurityAncestors
-
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
)
- document_ids – documentIDs (type:
-
setup_google_drive_push_notifications
()¶ The
setupGoogleDrivePushNotifications
action.Returns: string
Collection
forshares
-
subscribers
¶ Collection
forsubscribers
-
unlink_documents
(ids=None)¶ The
unlinkDocuments
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
upload_documents
(document_request_id=None, documents=None)¶ The
uploadDocuments
action.Parameters: - document_request_id – documentRequestID (type:
string
) - documents – documents (type:
string[]
)
Returns: string[]
- document_request_id – documentRequestID (type:
-
versions
¶ Collection
forversions
-
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
- obj_code – objCode (type:
-
zip_documents_versions
(ids=None)¶ The
zipDocumentsVersions
action.Parameters: ids – ids (type: string[]
)Returns: string
-
-
class
workfront.versions.unsupported.
DocumentApproval
(session=None, **fields)¶ Object
forDOCAPL
Reference
forautoDocumentShare
Field
forautoDocumentShareID
-
notify_approver
(id=None)¶ The
notifyApprover
action.Parameters: id – ID (type: string
)
-
class
workfront.versions.unsupported.
DocumentFolder
(session=None, **fields)¶ Object
forDOCFDR
-
children
¶ Collection
forchildren
-
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
- document_folder_id – documentFolderID (type:
-
documents
¶ Collection
fordocuments
-
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
- folder_id – folderID (type:
-
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
-
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
)
- linked_folder_id – linkedFolderID (type:
-
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
)
- linked_folder_id – linkedFolderID (type:
-
refresh_linked_folder_meta_data
(linked_folder_id=None)¶ The
refreshLinkedFolderMetaData
action.Parameters: linked_folder_id – linkedFolderID (type: string
)
-
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
- folder_id – folderID (type:
-
unlink_folders
(ids=None)¶ The
unlinkFolders
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
DocumentProvider
(session=None, **fields)¶ Object
forDOCPRO
-
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[]
- external_integration_type – externalIntegrationType (type:
-
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
- external_integration_type – externalIntegrationType (type:
-
-
class
workfront.versions.unsupported.
DocumentProviderConfig
(session=None, **fields)¶ Object
forDOCCFG
-
class
workfront.versions.unsupported.
DocumentProviderMetadata
(session=None, **fields)¶ Object
forDOCMET
-
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
- document_id – documentID (type:
-
Object
forDOCSHR
Field
foraccessorIDs
Field
foraccessorObjCode
Field
foraccessorObjID
Reference
forcustomer
Field
forcustomerID
Field
fordescription
Reference
fordocument
Field
fordocumentID
Reference
forenteredBy
Field
forenteredByID
Field
forentryDate
Field
forisApprover
Field
forisDownload
Field
forisProofer
Field
forlastUpdateDate
Reference
forlastUpdatedBy
Field
forlastUpdatedByID
The
notifyShare
action.Parameters: id – ID (type: string
)
Reference
forpendingApproval
Reference
forrole
Field
forroleID
Reference
forteam
Field
forteamID
Reference
foruser
Field
foruserID
-
class
workfront.versions.unsupported.
DocumentVersion
(session=None, **fields)¶ Object
forDOCV
-
add_document_version
(document_version_bean=None)¶ The
addDocumentVersion
action.Parameters: document_version_bean – documentVersionBean (type: DocumentVersion
)Returns: string
-
file_handle
()¶ The
fileHandle
action.Returns: string
-
public_file_handle
(version_id=None, public_token=None)¶ The
publicFileHandle
action.Parameters: - version_id – versionID (type:
string
) - public_token – publicToken (type:
string
)
Returns: string
- version_id – versionID (type:
-
remove_document_version
(document_version=None)¶ The
removeDocumentVersion
action.Parameters: document_version – documentVersion (type: DocumentVersion
)
-
-
class
workfront.versions.unsupported.
Email
(session=None, **fields)¶ Object
forEMAILC
-
send_test_email
(email_address=None, username=None, password=None, host=None, port=None, usessl=None)¶ The
sendTestEmail
action.Parameters: - email_address – emailAddress (type:
string
) - username – username (type:
string
) - password – password (type:
string
) - host – host (type:
string
) - port – port (type:
string
) - usessl – usessl (type:
java.lang.Boolean
)
Returns: string
- email_address – emailAddress (type:
-
test_pop_account_settings
(username=None, password=None, host=None, port=None, usessl=None)¶ The
testPopAccountSettings
action.Parameters: - username – username (type:
string
) - password – password (type:
string
) - host – host (type:
string
) - port – port (type:
string
) - usessl – usessl (type:
boolean
)
Returns: string
- username – username (type:
-
-
class
workfront.versions.unsupported.
EmailTemplate
(session=None, **fields)¶ Object
forEMLTPL
-
get_email_subjects
(customer_id=None, handler_name_map=None, obj_code=None, obj_id=None, event_type=None)¶ The
getEmailSubjects
action.Parameters: - customer_id – customerID (type:
string
) - handler_name_map – handlerNameMap (type:
map
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
) - event_type – eventType (type:
string
)
Returns: map
- customer_id – customerID (type:
-
get_help_desk_registration_email
(user_id=None)¶ The
getHelpDeskRegistrationEmail
action.Parameters: user_id – userID (type: string
)Returns: string
-
get_user_invitation_email
(user_id=None)¶ The
getUserInvitationEmail
action.Parameters: user_id – userID (type: string
)Returns: string
-
-
class
workfront.versions.unsupported.
Endorsement
(session=None, **fields)¶ Object
forENDR
-
get_liked_endorsement_ids
(endorsement_ids=None)¶ The
getLikedEndorsementIDs
action.Parameters: endorsement_ids – endorsementIDs (type: string[]
)Returns: string[]
-
like
()¶ The
like
action.
-
replies
¶ Collection
forreplies
Collection
forshares
-
unlike
()¶ The
unlike
action.
-
Object
forENDSHR
Field
foraccessorObjCode
Field
foraccessorObjID
Reference
forcustomer
Field
forcustomerID
Reference
forendorsement
Field
forendorsementID
Reference
forenteredBy
Field
forenteredByID
Field
forentryDate
Field
forlastUpdateDate
Reference
forlastUpdatedBy
Field
forlastUpdatedByID
Reference
forteam
Field
forteamID
Reference
foruser
Field
foruserID
-
class
workfront.versions.unsupported.
EventHandler
(session=None, **fields)¶ Object
forEVNTH
-
app_events
¶ Collection
forappEvents
Field
forisHidden
-
reset_subjects_to_default
(event_handler_ids=None)¶ The
resetSubjectsToDefault
action.Parameters: event_handler_ids – eventHandlerIDs (type: string[]
)Returns: string[]
-
set_custom_subject
(custom_subjects=None, custom_subject_properties=None)¶ The
setCustomSubject
action.Parameters: - custom_subjects – customSubjects (type:
string[]
) - custom_subject_properties – customSubjectProperties (type:
string[]
)
Returns: string
- custom_subjects – customSubjects (type:
-
-
class
workfront.versions.unsupported.
ExchangeRate
(session=None, **fields)¶ Object
forEXRATE
-
suggest_exchange_rate
(base_currency=None, to_currency_code=None)¶ The
suggestExchangeRate
action.Parameters: - base_currency – baseCurrency (type:
string
) - to_currency_code – toCurrencyCode (type:
string
)
Returns: java.lang.Double
- base_currency – baseCurrency (type:
-
-
class
workfront.versions.unsupported.
Expense
(session=None, **fields)¶ Object
forEXPNS
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
move
(obj_id=None, exp_obj_code=None)¶ The
move
action.Parameters: - obj_id – objID (type:
string
) - exp_obj_code – expObjCode (type:
string
)
- obj_id – objID (type:
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
-
class
workfront.versions.unsupported.
ExpenseType
(session=None, **fields)¶ Object
forEXPTYP
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
ExternalDocument
(session=None, **fields)¶ Object
forEXTDOC
-
browse_list_with_link_action
(provider_type=None, document_provider_id=None, search_params=None, link_action=None)¶ The
browseListWithLinkAction
action.Parameters: - provider_type – providerType (type:
string
) - document_provider_id – documentProviderID (type:
string
) - search_params – searchParams (type:
map
) - link_action – linkAction (type:
string
)
Returns: map
- provider_type – providerType (type:
-
get_authentication_url_for_provider
(provider_type=None, document_provider_id=None, document_provider_config_id=None)¶ The
getAuthenticationUrlForProvider
action.Parameters: - provider_type – providerType (type:
string
) - document_provider_id – documentProviderID (type:
string
) - document_provider_config_id – documentProviderConfigID (type:
string
)
Returns: string
- provider_type – providerType (type:
-
get_thumbnail_path
(provider_type=None, provider_id=None, last_modified_date=None, id=None)¶ The
getThumbnailPath
action.Parameters: - provider_type – providerType (type:
string
) - provider_id – providerID (type:
string
) - last_modified_date – lastModifiedDate (type:
string
) - id – id (type:
string
)
Returns: string
- provider_type – providerType (type:
-
load_external_browse_location
(provider_type=None, document_provider_id=None, link_action=None)¶ The
loadExternalBrowseLocation
action.Parameters: - provider_type – providerType (type:
string
) - document_provider_id – documentProviderID (type:
string
) - link_action – linkAction (type:
string
)
Returns: string[]
- provider_type – providerType (type:
-
save_external_browse_location
(provider_type=None, document_provider_id=None, link_action=None, breadcrumb=None)¶ The
saveExternalBrowseLocation
action.Parameters: - provider_type – providerType (type:
string
) - document_provider_id – documentProviderID (type:
string
) - link_action – linkAction (type:
string
) - breadcrumb – breadcrumb (type:
string
)
- provider_type – providerType (type:
-
show_external_thumbnails
()¶ The
showExternalThumbnails
action.Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
ExternalSection
(session=None, **fields)¶ Object
forEXTSEC
-
calculate_url
(external_section_id=None, obj_code=None, obj_id=None)¶ The
calculateURL
action.Parameters: - external_section_id – externalSectionID (type:
string
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
Returns: string
- external_section_id – externalSectionID (type:
-
calculate_urls
(external_section_ids=None, obj_code=None, obj_id=None)¶ The
calculateURLS
action.Parameters: - external_section_ids – externalSectionIDs (type:
java.util.Collection
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
Returns: map
- external_section_ids – externalSectionIDs (type:
-
-
class
workfront.versions.unsupported.
Favorite
(session=None, **fields)¶ Object
forFVRITE
-
update_favorite_name
(name=None, favorite_id=None)¶ The
updateFavoriteName
action.Parameters: - name – name (type:
string
) - favorite_id – favoriteID (type:
string
)
- name – name (type:
-
-
class
workfront.versions.unsupported.
Feature
(session=None, **fields)¶ Object
forFEATR
-
export
()¶ The
export
action.Returns: string
-
is_enabled
(name=None)¶ The
isEnabled
action.Parameters: name – name (type: string
)Returns: java.lang.Boolean
-
override_for_session
(name=None, value=None)¶ The
overrideForSession
action.Parameters: - name – name (type:
string
) - value – value (type:
boolean
)
- name – name (type:
-
-
class
workfront.versions.unsupported.
Group
(session=None, **fields)¶ Object
forGROUP
-
add_early_access
(ids=None)¶ The
addEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
check_delete
(ids=None)¶ The
checkDelete
action.Parameters: ids – ids (type: string[]
)
-
children
¶ Collection
forchildren
-
delete_early_access
(ids=None)¶ The
deleteEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
replace_delete_groups
(ids=None, replace_group_id=None)¶ The
replaceDeleteGroups
action.Parameters: - ids – ids (type:
string[]
) - replace_group_id – replaceGroupID (type:
string
)
- ids – ids (type:
-
user_groups
¶ Collection
foruserGroups
-
-
class
workfront.versions.unsupported.
Hour
(session=None, **fields)¶ Object
forHOUR
-
approve
()¶ The
approve
action.
-
unapprove
()¶ The
unapprove
action.
-
-
class
workfront.versions.unsupported.
HourType
(session=None, **fields)¶ Object
forHOURT
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
timesheetprofiles
¶ Collection
fortimesheetprofiles
-
users
¶ Collection
forusers
-
-
class
workfront.versions.unsupported.
ImportTemplate
(session=None, **fields)¶ Object
forITMPL
-
import_rows
¶ Collection
forimportRows
-
-
class
workfront.versions.unsupported.
Issue
(session=None, **fields)¶ Object
forOPTASK
-
accept_work
()¶ The
acceptWork
action.
-
access_rules
¶ Collection
foraccessRules
-
add_comment
(text)¶ Add a comment to the current object containing the supplied text.
The new
Comment
instance is returned, it does not need to be saved.
-
all_priorities
¶ Collection
forallPriorities
-
all_severities
¶ Collection
forallSeverities
-
all_statuses
¶ Collection
forallStatuses
-
approve_approval
(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApproval
action.Parameters: - user_id – userID (type:
string
) - username – username (type:
string
) - password – password (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
approver_statuses
¶ Collection
forapproverStatuses
-
assign
(obj_id=None, obj_code=None)¶ The
assign
action.Parameters: - obj_id – objID (type:
string
) - obj_code – objCode (type:
string
)
- obj_id – objID (type:
-
assign_multiple
(user_ids=None, role_ids=None, team_id=None)¶ The
assignMultiple
action.Parameters: - user_ids – userIDs (type:
string[]
) - role_ids – roleIDs (type:
string[]
) - team_id – teamID (type:
string
)
- user_ids – userIDs (type:
-
assignments
¶ Collection
forassignments
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
convert_to_project
(project=None, exchange_rate=None, options=None)¶ The
convertToProject
action.Parameters: - project – project (type:
Project
) - exchange_rate – exchangeRate (type:
ExchangeRate
) - options – options (type:
string[]
)
Returns: string
- project – project (type:
-
convert_to_task
()¶ Convert this issue to a task. The newly converted task will be returned, it does not need to be saved.
Field
fordisplayQueueBreadcrumb
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
done_statuses
¶ Collection
fordoneStatuses
-
hours
¶ Collection
forhours
-
mark_done
(status=None)¶ The
markDone
action.Parameters: status – status (type: string
)
-
mark_not_done
(assignment_id=None)¶ The
markNotDone
action.Parameters: assignment_id – assignmentID (type: string
)
-
move
(project_id=None)¶ The
move
action.Parameters: project_id – projectID (type: string
)
-
move_to_task
(project_id=None, parent_id=None)¶ The
moveToTask
action.Parameters: - project_id – projectID (type:
string
) - parent_id – parentID (type:
string
)
- project_id – projectID (type:
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
Field
forqueueTopicBreadcrumb
-
recall_approval
()¶ The
recallApproval
action.
-
reject_approval
(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApproval
action.Parameters: - user_id – userID (type:
string
) - username – username (type:
string
) - password – password (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
reply_to_assignment
(note_text=None, commit_date=None)¶ The
replyToAssignment
action.Parameters: - note_text – noteText (type:
string
) - commit_date – commitDate (type:
dateTime
)
- note_text – noteText (type:
-
resolvables
¶ Collection
forresolvables
-
security_ancestors
¶ Collection
forsecurityAncestors
-
timed_notifications
(notification_ids=None)¶ The
timedNotifications
action.Parameters: notification_ids – notificationIDs (type: string[]
)
-
unaccept_work
()¶ The
unacceptWork
action.
-
unassign
(user_id=None)¶ The
unassign
action.Parameters: user_id – userID (type: string
)
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
Iteration
(session=None, **fields)¶ Object
forITRN
-
assign_iteration_to_descendants
(task_ids=None, iteration_id=None)¶ The
assignIterationToDescendants
action.Parameters: - task_ids – taskIDs (type:
string[]
) - iteration_id – iterationID (type:
string
)
- task_ids – taskIDs (type:
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
legacy_burndown_info_with_percentage
(iteration_id=None)¶ The
legacyBurndownInfoWithPercentage
action.Parameters: iteration_id – iterationID (type: string
)Returns: map
-
legacy_burndown_info_with_points
(iteration_id=None)¶ The
legacyBurndownInfoWithPoints
action.Parameters: iteration_id – iterationID (type: string
)Returns: map
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
-
class
workfront.versions.unsupported.
JournalEntry
(session=None, **fields)¶ Object
forJRNLE
Reference
fordocumentShare
Field
fordocumentShareID
-
edit_field_names
(parameter_id=None, field_name=None)¶ The
editFieldNames
action.Parameters: - parameter_id – parameterID (type:
string
) - field_name – fieldName (type:
string
)
Returns: string[]
- parameter_id – parameterID (type:
-
get_liked_journal_entry_ids
(journal_entry_ids=None)¶ The
getLikedJournalEntryIDs
action.Parameters: journal_entry_ids – journalEntryIDs (type: string[]
)Returns: string[]
-
like
()¶ The
like
action.
-
replies
¶ Collection
forreplies
-
unlike
()¶ The
unlike
action.
-
class
workfront.versions.unsupported.
JournalField
(session=None, **fields)¶ Object
forJRNLF
-
migrate_wild_card_journal_fields
()¶ The
migrateWildCardJournalFields
action.
-
set_journal_fields_for_obj_code
(obj_code=None, messages=None)¶ The
setJournalFieldsForObjCode
action.Parameters: - obj_code – objCode (type:
string
) - messages – messages (type:
com.attask.model.RKJournalField[]
)
Returns: string[]
- obj_code – objCode (type:
-
-
class
workfront.versions.unsupported.
KickStart
(session=None, **fields)¶ Object
forKSS
-
import_kick_start
(file_handle=None, file_type=None)¶ The
importKickStart
action.Parameters: - file_handle – fileHandle (type:
string
) - file_type – fileType (type:
string
)
Returns: map
- file_handle – fileHandle (type:
-
-
class
workfront.versions.unsupported.
LayoutTemplate
(session=None, **fields)¶ Object
forLYTMPL
-
clear_all_custom_tabs
(reset_default_nav=None, reset_nav_items=None)¶ The
clearAllCustomTabs
action.Parameters: - reset_default_nav – resetDefaultNav (type:
boolean
) - reset_nav_items – resetNavItems (type:
boolean
)
- reset_default_nav – resetDefaultNav (type:
-
clear_all_user_custom_tabs
(user_ids=None, reset_default_nav=None, reset_nav_items=None)¶ The
clearAllUserCustomTabs
action.Parameters: - user_ids – userIDs (type:
java.util.Set
) - reset_default_nav – resetDefaultNav (type:
boolean
) - reset_nav_items – resetNavItems (type:
boolean
)
- user_ids – userIDs (type:
-
clear_ppmigration_flag
()¶ The
clearPPMigrationFlag
action.
-
clear_user_custom_tabs
(user_ids=None, reset_default_nav=None, reset_nav_items=None, layout_page_types=None)¶ The
clearUserCustomTabs
action.Parameters: - user_ids – userIDs (type:
java.util.Set
) - reset_default_nav – resetDefaultNav (type:
boolean
) - reset_nav_items – resetNavItems (type:
boolean
) - layout_page_types – layoutPageTypes (type:
java.util.Set
)
- user_ids – userIDs (type:
Field
fordefaultNavItem
-
get_layout_template_cards_by_card_location
(layout_template_id=None, card_location=None)¶ The
getLayoutTemplateCardsByCardLocation
action.Parameters: - layout_template_id – layoutTemplateID (type:
string
) - card_location – cardLocation (type:
string
)
Returns: string[]
- layout_template_id – layoutTemplateID (type:
-
get_layout_template_users
(layout_template_ids=None)¶ The
getLayoutTemplateUsers
action.Parameters: layout_template_ids – layoutTemplateIDs (type: string[]
)Returns: string[]
-
layout_template_cards
¶ Collection
forlayoutTemplateCards
-
layout_template_date_preferences
¶ Collection
forlayoutTemplateDatePreferences
-
layout_template_pages
¶ Collection
forlayoutTemplatePages
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
migrate_portal_profile
(portal_profile_ids=None)¶ The
migratePortalProfile
action.Parameters: portal_profile_ids – portalProfileIDs (type: string[]
)Returns: map
Field
fornavBar
Field
fornavItems
-
ui_filters
¶ Collection
foruiFilters
-
ui_group_bys
¶ Collection
foruiGroupBys
-
ui_views
¶ Collection
foruiViews
-
-
class
workfront.versions.unsupported.
LayoutTemplateDatePreference
(session=None, **fields)¶ Object
forLTMPDP
-
class
workfront.versions.unsupported.
MasterTask
(session=None, **fields)¶ Object
forMTSK
-
assignments
¶ Collection
forassignments
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
expenses
¶ Collection
forexpenses
-
groups
¶ Collection
forgroups
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
-
class
workfront.versions.unsupported.
MilestonePath
(session=None, **fields)¶ Object
forMPATH
-
groups
¶ Collection
forgroups
-
milestones
¶ Collection
formilestones
-
-
class
workfront.versions.unsupported.
Note
(session=None, **fields)¶ Object
forNOTE
-
add_comment
(text)¶ Add a comment to this comment.
The new
Comment
instance is returned, it does not need to be saved.
-
add_note_to_objects
(obj_ids=None, note_obj_code=None, note_text=None, is_private=None, email_users=None, tags=None)¶ The
addNoteToObjects
action.Parameters: - obj_ids – objIDs (type:
string[]
) - note_obj_code – noteObjCode (type:
string
) - note_text – noteText (type:
string
) - is_private – isPrivate (type:
boolean
) - email_users – emailUsers (type:
boolean
) - tags – tags (type:
java.lang.Object
)
Returns: string[]
- obj_ids – objIDs (type:
-
get_liked_note_ids
(note_ids=None)¶ The
getLikedNoteIDs
action.Parameters: note_ids – noteIDs (type: string[]
)Returns: string[]
-
like
()¶ The
like
action.
-
replies
¶ Collection
forreplies
Collection
fortags
-
unlike
()¶ The
unlike
action.
-
-
class
workfront.versions.unsupported.
Parameter
(session=None, **fields)¶ Object
forPARAM
-
parameter_options
¶ Collection
forparameterOptions
-
-
class
workfront.versions.unsupported.
ParameterOption
(session=None, **fields)¶ Object
forPOPT
Field
forisHidden
-
class
workfront.versions.unsupported.
PortalProfile
(session=None, **fields)¶ Object
forPTLPFL
Collection
forcustomMenus
-
custom_tabs
¶ Collection
forcustomTabs
-
portal_sections
¶ Collection
forportalSections
-
portal_tabs
¶ Collection
forportalTabs
-
ui_filters
¶ Collection
foruiFilters
-
ui_group_bys
¶ Collection
foruiGroupBys
-
ui_views
¶ Collection
foruiViews
-
class
workfront.versions.unsupported.
PortalSection
(session=None, **fields)¶ Object
forPTLSEC
-
access_rules
¶ Collection
foraccessRules
-
get_pk
(obj_code=None)¶ The
getPK
action.Parameters: obj_code – objCode (type: string
)Returns: string
-
get_report_from_cache
(background_job_id=None)¶ The
getReportFromCache
action.Parameters: background_job_id – backgroundJobID (type: string
)Returns: map
-
is_report_filterable
(query_class_obj_code=None, obj_code=None, obj_id=None)¶ The
isReportFilterable
action.Parameters: - query_class_obj_code – queryClassObjCode (type:
string
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
Returns: java.lang.Boolean
- query_class_obj_code – queryClassObjCode (type:
-
link_customer
()¶ The
linkCustomer
action.
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
migrate_portal_sections_ppmto_anaconda
()¶ The
migratePortalSectionsPPMToAnaconda
action.
-
portal_tab_sections
¶ Collection
forportalTabSections
-
scheduled_reports
¶ Collection
forscheduledReports
-
security_ancestors
¶ Collection
forsecurityAncestors
-
send_now
()¶ The
sendNow
action.
-
unlink_customer
()¶ The
unlinkCustomer
action.
-
-
class
workfront.versions.unsupported.
PortalTab
(session=None, **fields)¶ Object
forPTLTAB
-
access_rules
¶ Collection
foraccessRules
-
advanced_copy
(new_name=None, advanced_copies=None)¶ The
advancedCopy
action.Parameters: - new_name – newName (type:
string
) - advanced_copies – advancedCopies (type:
map
)
Returns: string
- new_name – newName (type:
-
export_dashboard
(dashboard_exports=None, dashboard_export_options=None)¶ The
exportDashboard
action.Parameters: - dashboard_exports – dashboardExports (type:
string[]
) - dashboard_export_options – dashboardExportOptions (type:
map
)
Returns: map
- dashboard_exports – dashboardExports (type:
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
migrate_custom_tab_user_prefs
(user_ids=None)¶ The
migrateCustomTabUserPrefs
action.Parameters: user_ids – userIDs (type: string[]
)
-
portal_tab_sections
¶ Collection
forportalTabSections
-
-
class
workfront.versions.unsupported.
Portfolio
(session=None, **fields)¶ Object
forPORT
-
access_rules
¶ Collection
foraccessRules
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
groups
¶ Collection
forgroups
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
programs
¶ Collection
forprograms
-
projects
¶ Collection
forprojects
-
-
class
workfront.versions.unsupported.
Program
(session=None, **fields)¶ Object
forPRGM
-
access_rules
¶ Collection
foraccessRules
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
move
(portfolio_id=None, options=None)¶ The
move
action.Parameters: - portfolio_id – portfolioID (type:
string
) - options – options (type:
string[]
)
- portfolio_id – portfolioID (type:
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
projects
¶ Collection
forprojects
-
security_ancestors
¶ Collection
forsecurityAncestors
-
-
class
workfront.versions.unsupported.
Project
(session=None, **fields)¶ Object
forPROJ
-
access_rules
¶ Collection
foraccessRules
-
alignment_values
¶ Collection
foralignmentValues
-
all_hours
¶ Collection
forallHours
-
all_priorities
¶ Collection
forallPriorities
-
all_statuses
¶ Collection
forallStatuses
-
approve_approval
(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApproval
action.Parameters: - user_id – userID (type:
string
) - approval_username – approvalUsername (type:
string
) - approval_password – approvalPassword (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
approver_statuses
¶ Collection
forapproverStatuses
-
async_delete
(projects_to_delete=None, force=None)¶ The
asyncDelete
action.Parameters: - projects_to_delete – projectsToDelete (type:
string[]
) - force – force (type:
boolean
)
Returns: string
- projects_to_delete – projectsToDelete (type:
-
attach_template
(template_id=None, predecessor_task_id=None, parent_task_id=None, exclude_template_task_ids=None, options=None)¶ The
attachTemplate
action.Parameters: - template_id – templateID (type:
string
) - predecessor_task_id – predecessorTaskID (type:
string
) - parent_task_id – parentTaskID (type:
string
) - exclude_template_task_ids – excludeTemplateTaskIDs (type:
string[]
) - options – options (type:
string[]
)
Returns: string
- template_id – templateID (type:
-
attach_template_with_parameter_values
(project=None, template_id=None, predecessor_task_id=None, parent_task_id=None, exclude_template_task_ids=None, options=None)¶ The
attachTemplateWithParameterValues
action.Parameters: - project – project (type:
Project
) - template_id – templateID (type:
string
) - predecessor_task_id – predecessorTaskID (type:
string
) - parent_task_id – parentTaskID (type:
string
) - exclude_template_task_ids – excludeTemplateTaskIDs (type:
string[]
) - options – options (type:
string[]
)
Returns: string
- project – project (type:
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
baselines
¶ Collection
forbaselines
-
billing_records
¶ Collection
forbillingRecords
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
calculate_finance
()¶ The
calculateFinance
action.
-
calculate_project_score_values
(type=None)¶ The
calculateProjectScoreValues
action.Parameters: type – type (type: com.attask.common.constants.ScoreCardTypeEnum
)
-
calculate_timeline
()¶ The
calculateTimeline
action.
-
create_project_with_override
(project=None, exchange_rate=None)¶ The
createProjectWithOverride
action.Parameters: - project – project (type:
Project
) - exchange_rate – exchangeRate (type:
ExchangeRate
)
Returns: string
- project – project (type:
-
deliverable_values
¶ Collection
fordeliverableValues
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
exchange_rates
¶ Collection
forexchangeRates
-
expenses
¶ Collection
forexpenses
-
export_as_msproject_file
()¶ The
exportAsMSProjectFile
action.Returns: string
-
export_business_case
()¶ The
exportBusinessCase
action.Returns: string
-
get_help_desk_user_can_add_issue
()¶ The
getHelpDeskUserCanAddIssue
action.Returns: java.lang.Boolean
-
get_project_currency
()¶ The
getProjectCurrency
action.Returns: string
-
hour_types
¶ Collection
forhourTypes
-
hours
¶ Collection
forhours
-
import_msproject_file
(file_handle=None, project_name=None)¶ The
importMSProjectFile
action.Parameters: - file_handle – fileHandle (type:
string
) - project_name – projectName (type:
string
)
Returns: string
- file_handle – fileHandle (type:
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
open_op_tasks
¶ Collection
foropenOpTasks
-
parameter_values
¶ Collection
forparameterValues
-
project_user_roles
¶ Collection
forprojectUserRoles
-
project_users
¶ Collection
forprojectUsers
-
rates
¶ Collection
forrates
-
recall_approval
()¶ The
recallApproval
action.
-
reject_approval
(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApproval
action.Parameters: - user_id – userID (type:
string
) - approval_username – approvalUsername (type:
string
) - approval_password – approvalPassword (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
remove_users_from_project
(user_ids=None)¶ The
removeUsersFromProject
action.Parameters: user_ids – userIDs (type: string[]
)
-
resolvables
¶ Collection
forresolvables
-
resource_allocations
¶ Collection
forresourceAllocations
-
risks
¶ Collection
forrisks
-
roles
¶ Collection
forroles
-
routing_rules
¶ Collection
forroutingRules
-
save_project_as_template
(template_name=None, exclude_ids=None, options=None)¶ The
saveProjectAsTemplate
action.Parameters: - template_name – templateName (type:
string
) - exclude_ids – excludeIDs (type:
string[]
) - options – options (type:
string[]
)
Returns: string
- template_name – templateName (type:
-
security_ancestors
¶ Collection
forsecurityAncestors
-
set_budget_to_schedule
()¶ The
setBudgetToSchedule
action.
-
tasks
¶ Collection
fortasks
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
QueueDef
(session=None, **fields)¶ Object
forQUED
-
object_categories
¶ Collection
forobjectCategories
-
queue_topics
¶ Collection
forqueueTopics
Field
forshareMode
-
-
class
workfront.versions.unsupported.
QueueTopic
(session=None, **fields)¶ Object
forQUET
-
object_categories
¶ Collection
forobjectCategories
-
-
class
workfront.versions.unsupported.
QueueTopicGroup
(session=None, **fields)¶ Object
forQUETGP
-
queue_topic_groups
¶ Collection
forqueueTopicGroups
-
queue_topics
¶ Collection
forqueueTopics
-
-
class
workfront.versions.unsupported.
Recent
(session=None, **fields)¶ Object
forRECENT
-
update_last_viewed_object
()¶ The
updateLastViewedObject
action.Returns: string
-
-
class
workfront.versions.unsupported.
RecentMenuItem
(session=None, **fields)¶ Object
forRECENTMENUITEM
-
bulk_delete_recent
(obj_code=None, obj_ids=None)¶ The
bulkDeleteRecent
action.Parameters: - obj_code – objCode (type:
string
) - obj_ids – objIDs (type:
string[]
)
- obj_code – objCode (type:
-
delete_recent
(obj_code=None, obj_id=None)¶ The
deleteRecent
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- obj_code – objCode (type:
The
rotateRecentMenu
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- obj_code – objCode (type:
-
-
class
workfront.versions.unsupported.
RecentUpdate
(session=None, **fields)¶ Object
forRUPDTE
Field
forauthorID
Field
forauthorName
Field
forlatestCommentAuthorID
Field
forlatestCommentAuthorName
-
class
workfront.versions.unsupported.
Reseller
(session=None, **fields)¶ Object
forRSELR
-
account_reps
¶ Collection
foraccountReps
-
-
class
workfront.versions.unsupported.
ResourcePool
(session=None, **fields)¶ Object
forRSPOOL
-
resource_allocations
¶ Collection
forresourceAllocations
-
roles
¶ Collection
forroles
-
users
¶ Collection
forusers
-
-
class
workfront.versions.unsupported.
RiskType
(session=None, **fields)¶ Object
forRSKTYP
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
Role
(session=None, **fields)¶ Object
forROLE
-
add_early_access
(ids=None)¶ The
addEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
delete_early_access
(ids=None)¶ The
deleteEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
SSOMapping
(session=None, **fields)¶ Object
forSSOMAP
-
mapping_rules
¶ Collection
formappingRules
-
-
class
workfront.versions.unsupported.
SSOOption
(session=None, **fields)¶ Object
forSSOPT
-
sso_mappings
¶ Collection
forssoMappings
-
upload_saml2metadata
(handle=None)¶ The
uploadSAML2Metadata
action.Parameters: handle – handle (type: string
)Returns: string
-
upload_ssocertificate
(handle=None)¶ The
uploadSSOCertificate
action.Parameters: handle – handle (type: string
)
-
-
class
workfront.versions.unsupported.
SandboxMigration
(session=None, **fields)¶ Object
forSNDMG
-
cancel_scheduled_migration
()¶ The
cancelScheduledMigration
action.
-
migrate_now
()¶ The
migrateNow
action.
-
migration_estimate
()¶ The
migrationEstimate
action.Returns: map
-
migration_queue_duration
()¶ The
migrationQueueDuration
action.Returns: java.lang.Integer
-
schedule_migration
(schedule_date=None)¶ The
scheduleMigration
action.Parameters: schedule_date – scheduleDate (type: dateTime
)
-
-
class
workfront.versions.unsupported.
Schedule
(session=None, **fields)¶ Object
forSCHED
-
get_earliest_work_time_of_day
(date=None)¶ The
getEarliestWorkTimeOfDay
action.Parameters: date – date (type: dateTime
)Returns: dateTime
-
get_latest_work_time_of_day
(date=None)¶ The
getLatestWorkTimeOfDay
action.Parameters: date – date (type: dateTime
)Returns: dateTime
-
get_next_completion_date
(date=None, cost_in_minutes=None)¶ The
getNextCompletionDate
action.Parameters: - date – date (type:
dateTime
) - cost_in_minutes – costInMinutes (type:
int
)
Returns: dateTime
- date – date (type:
-
get_next_start_date
(date=None)¶ The
getNextStartDate
action.Parameters: date – date (type: dateTime
)Returns: dateTime
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
non_work_days
¶ Collection
fornonWorkDays
-
other_groups
¶ Collection
forotherGroups
-
-
class
workfront.versions.unsupported.
ScheduledReport
(session=None, **fields)¶ Object
forSCHREP
-
groups
¶ Collection
forgroups
-
roles
¶ Collection
forroles
-
send_report_delivery_now
(user_ids=None, team_ids=None, group_ids=None, role_ids=None, external_emails=None, delivery_options=None)¶ The
sendReportDeliveryNow
action.Parameters: - user_ids – userIDs (type:
string[]
) - team_ids – teamIDs (type:
string[]
) - group_ids – groupIDs (type:
string[]
) - role_ids – roleIDs (type:
string[]
) - external_emails – externalEmails (type:
string
) - delivery_options – deliveryOptions (type:
map
)
Returns: java.lang.Integer
- user_ids – userIDs (type:
-
teams
¶ Collection
forteams
-
users
¶ Collection
forusers
-
-
class
workfront.versions.unsupported.
ScoreCard
(session=None, **fields)¶ Object
forSCORE
-
score_card_questions
¶ Collection
forscoreCardQuestions
-
-
class
workfront.versions.unsupported.
ScoreCardOption
(session=None, **fields)¶ Object
forSCOPT
Field
forisHidden
-
class
workfront.versions.unsupported.
ScoreCardQuestion
(session=None, **fields)¶ Object
forSCOREQ
-
score_card_options
¶ Collection
forscoreCardOptions
-
-
class
workfront.versions.unsupported.
Task
(session=None, **fields)¶ Object
forTASK
-
accept_work
()¶ The
acceptWork
action.
-
access_rules
¶ Collection
foraccessRules
-
add_comment
(text)¶ Add a comment to the current object containing the supplied text.
The new
Comment
instance is returned, it does not need to be saved.
-
all_priorities
¶ Collection
forallPriorities
-
all_statuses
¶ Collection
forallStatuses
-
approve_approval
(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApproval
action.Parameters: - user_id – userID (type:
string
) - username – username (type:
string
) - password – password (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
approver_statuses
¶ Collection
forapproverStatuses
-
assign
(obj_id=None, obj_code=None)¶ The
assign
action.Parameters: - obj_id – objID (type:
string
) - obj_code – objCode (type:
string
)
- obj_id – objID (type:
-
assign_multiple
(user_ids=None, role_ids=None, team_id=None)¶ The
assignMultiple
action.Parameters: - user_ids – userIDs (type:
string[]
) - role_ids – roleIDs (type:
string[]
) - team_id – teamID (type:
string
)
- user_ids – userIDs (type:
-
assignments
¶ Collection
forassignments
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
bulk_copy
(task_ids=None, project_id=None, parent_id=None, options=None)¶ The
bulkCopy
action.Parameters: - task_ids – taskIDs (type:
string[]
) - project_id – projectID (type:
string
) - parent_id – parentID (type:
string
) - options – options (type:
string[]
)
Returns: string[]
- task_ids – taskIDs (type:
-
bulk_move
(task_ids=None, project_id=None, parent_id=None, options=None)¶ The
bulkMove
action.Parameters: - task_ids – taskIDs (type:
string[]
) - project_id – projectID (type:
string
) - parent_id – parentID (type:
string
) - options – options (type:
string[]
)
- task_ids – taskIDs (type:
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
calculate_data_extensions
(ids=None)¶ The
calculateDataExtensions
action.Parameters: ids – ids (type: string[]
)
-
children
¶ Collection
forchildren
-
convert_to_project
(project=None, exchange_rate=None)¶ The
convertToProject
action.Parameters: - project – project (type:
Project
) - exchange_rate – exchangeRate (type:
ExchangeRate
)
Returns: string
- project – project (type:
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
done_statuses
¶ Collection
fordoneStatuses
-
expenses
¶ Collection
forexpenses
-
hours
¶ Collection
forhours
-
mark_done
(status=None)¶ The
markDone
action.Parameters: status – status (type: string
)
-
mark_not_done
(assignment_id=None)¶ The
markNotDone
action.Parameters: assignment_id – assignmentID (type: string
)
-
move
(project_id=None, parent_id=None, options=None)¶ The
move
action.Parameters: - project_id – projectID (type:
string
) - parent_id – parentID (type:
string
) - options – options (type:
string[]
)
- project_id – projectID (type:
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
op_tasks
¶ Collection
foropTasks
-
open_op_tasks
¶ Collection
foropenOpTasks
-
parameter_values
¶ Collection
forparameterValues
-
predecessors
¶ Collection
forpredecessors
-
recall_approval
()¶ The
recallApproval
action.
-
reject_approval
(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApproval
action.Parameters: - user_id – userID (type:
string
) - username – username (type:
string
) - password – password (type:
string
) - audit_note – auditNote (type:
string
) - audit_user_ids – auditUserIDs (type:
string[]
) - send_note_as_email – sendNoteAsEmail (type:
boolean
)
- user_id – userID (type:
-
reply_to_assignment
(note_text=None, commit_date=None)¶ The
replyToAssignment
action.Parameters: - note_text – noteText (type:
string
) - commit_date – commitDate (type:
dateTime
)
- note_text – noteText (type:
-
resolvables
¶ Collection
forresolvables
-
security_ancestors
¶ Collection
forsecurityAncestors
-
successors
¶ Collection
forsuccessors
-
timed_notifications
(notification_ids=None)¶ The
timedNotifications
action.Parameters: notification_ids – notificationIDs (type: string[]
)
-
unaccept_work
()¶ The
unacceptWork
action.
-
unassign
(user_id=None)¶ The
unassign
action.Parameters: user_id – userID (type: string
)
-
unassign_occurrences
(user_id=None)¶ The
unassignOccurrences
action.Parameters: user_id – userID (type: string
)Returns: string[]
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
Team
(session=None, **fields)¶ Object
forTEAMOB
-
add_early_access
(ids=None)¶ The
addEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
backlog_tasks
¶ Collection
forbacklogTasks
-
delete_early_access
(ids=None)¶ The
deleteEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
move_tasks_on_team_backlog
(team_id=None, start_number=None, end_number=None, move_to_number=None, moving_task_ids=None)¶ The
moveTasksOnTeamBacklog
action.Parameters: - team_id – teamID (type:
string
) - start_number – startNumber (type:
int
) - end_number – endNumber (type:
int
) - move_to_number – moveToNumber (type:
int
) - moving_task_ids – movingTaskIDs (type:
string[]
)
- team_id – teamID (type:
-
team_member_roles
¶ Collection
forteamMemberRoles
-
team_members
¶ Collection
forteamMembers
-
updates
¶ Collection
forupdates
-
users
¶ Collection
forusers
-
-
class
workfront.versions.unsupported.
Template
(session=None, **fields)¶ Object
forTMPL
-
access_rule_preferences
¶ Collection
foraccessRulePreferences
-
access_rules
¶ Collection
foraccessRules
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
calculate_timeline
()¶ The
calculateTimeline
action.Returns: string
-
deliverable_values
¶ Collection
fordeliverableValues
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
expenses
¶ Collection
forexpenses
-
get_template_currency
()¶ The
getTemplateCurrency
action.Returns: string
-
groups
¶ Collection
forgroups
-
hour_types
¶ Collection
forhourTypes
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
rates
¶ Collection
forrates
-
remove_users_from_template
(user_ids=None)¶ The
removeUsersFromTemplate
action.Parameters: user_ids – userIDs (type: string[]
)
-
risks
¶ Collection
forrisks
-
roles
¶ Collection
forroles
-
routing_rules
¶ Collection
forroutingRules
-
set_access_rule_preferences
(access_rule_preferences=None)¶ The
setAccessRulePreferences
action.Parameters: access_rule_preferences – accessRulePreferences (type: string[]
)
-
template_tasks
¶ Collection
fortemplateTasks
-
template_user_roles
¶ Collection
fortemplateUserRoles
-
template_users
¶ Collection
fortemplateUsers
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
TemplateTask
(session=None, **fields)¶ Object
forTTSK
-
assign_multiple
(user_ids=None, role_ids=None, team_id=None)¶ The
assignMultiple
action.Parameters: - user_ids – userIDs (type:
string[]
) - role_ids – roleIDs (type:
string[]
) - team_id – teamID (type:
string
)
- user_ids – userIDs (type:
-
assignments
¶ Collection
forassignments
-
bulk_copy
(template_id=None, template_task_ids=None, parent_template_task_id=None, options=None)¶ The
bulkCopy
action.Parameters: - template_id – templateID (type:
string
) - template_task_ids – templateTaskIDs (type:
string[]
) - parent_template_task_id – parentTemplateTaskID (type:
string
) - options – options (type:
string[]
)
Returns: string[]
- template_id – templateID (type:
-
bulk_move
(template_task_ids=None, template_id=None, parent_id=None, options=None)¶ The
bulkMove
action.Parameters: - template_task_ids – templateTaskIDs (type:
string[]
) - template_id – templateID (type:
string
) - parent_id – parentID (type:
string
) - options – options (type:
string[]
)
Returns: string
- template_task_ids – templateTaskIDs (type:
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
children
¶ Collection
forchildren
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
expenses
¶ Collection
forexpenses
-
move
(template_id=None, parent_id=None, options=None)¶ The
move
action.Parameters: - template_id – templateID (type:
string
) - parent_id – parentID (type:
string
) - options – options (type:
string[]
)
- template_id – templateID (type:
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
predecessors
¶ Collection
forpredecessors
-
successors
¶ Collection
forsuccessors
-
timed_notifications
(notification_ids=None)¶ The
timedNotifications
action.Parameters: notification_ids – notificationIDs (type: string[]
)
-
-
class
workfront.versions.unsupported.
Timesheet
(session=None, **fields)¶ Object
forTSHET
-
approvers
¶ Collection
forapprovers
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
hours
¶ Collection
forhours
-
notification_records
¶ Collection
fornotificationRecords
-
pin_timesheet_object
(user_id=None, obj_code=None, obj_id=None)¶ The
pinTimesheetObject
action.Parameters: - user_id – userID (type:
string
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- user_id – userID (type:
-
unpin_timesheet_object
(user_id=None, obj_code=None, obj_id=None)¶ The
unpinTimesheetObject
action.Parameters: - user_id – userID (type:
string
) - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
)
- user_id – userID (type:
-
-
class
workfront.versions.unsupported.
TimesheetProfile
(session=None, **fields)¶ Object
forTSPRO
-
approvers
¶ Collection
forapprovers
-
generate_customer_timesheets
(obj_ids=None)¶ The
generateCustomerTimesheets
action.Parameters: obj_ids – objIDs (type: string[]
)
-
has_reference
(ids=None)¶ The
hasReference
action.Parameters: ids – ids (type: string[]
)Returns: java.lang.Boolean
-
hour_types
¶ Collection
forhourTypes
-
notification_records
¶ Collection
fornotificationRecords
-
-
class
workfront.versions.unsupported.
UIFilter
(session=None, **fields)¶ Object
forUIFT
-
access_rules
¶ Collection
foraccessRules
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
un_link_users
(filter_id=None, linked_user_ids=None)¶ The
unLinkUsers
action.Parameters: - filter_id – filterID (type:
string
) - linked_user_ids – linkedUserIDs (type:
string[]
)
- filter_id – filterID (type:
-
users
¶ Collection
forusers
-
-
class
workfront.versions.unsupported.
UIGroupBy
(session=None, **fields)¶ Object
forUIGB
-
access_rules
¶ Collection
foraccessRules
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
un_link_users
(group_id=None, linked_user_ids=None)¶ The
unLinkUsers
action.Parameters: - group_id – groupID (type:
string
) - linked_user_ids – linkedUserIDs (type:
string[]
)
- group_id – groupID (type:
-
-
class
workfront.versions.unsupported.
UIView
(session=None, **fields)¶ Object
forUIVW
-
access_rules
¶ Collection
foraccessRules
-
expand_view_aliases
(obj_code=None, definition=None)¶ The
expandViewAliases
action.Parameters: - obj_code – objCode (type:
string
) - definition – definition (type:
map
)
Returns: map
- obj_code – objCode (type:
-
get_view_fields
()¶ The
getViewFields
action.Returns: string[]
-
linked_roles
¶ Collection
forlinkedRoles
-
linked_teams
¶ Collection
forlinkedTeams
-
linked_users
¶ Collection
forlinkedUsers
-
migrate_uiviews_ppmto_anaconda
()¶ The
migrateUIViewsPPMToAnaconda
action.
-
un_link_users
(view_id=None, linked_user_ids=None)¶ The
unLinkUsers
action.Parameters: - view_id – viewID (type:
string
) - linked_user_ids – linkedUserIDs (type:
string[]
)
- view_id – viewID (type:
-
-
class
workfront.versions.unsupported.
Update
(session=None, **fields)¶ Object
forUPDATE
-
audit_session_count
(user_id=None, target_user_id=None, start_date=None, end_date=None)¶ The
auditSessionCount
action.Parameters: - user_id – userID (type:
string
) - target_user_id – targetUserID (type:
string
) - start_date – startDate (type:
dateTime
) - end_date – endDate (type:
dateTime
)
Returns: java.lang.Integer
- user_id – userID (type:
-
combined_updates
¶ Collection
forcombinedUpdates
-
get_update_types_for_stream
(stream_type=None)¶ The
getUpdateTypesForStream
action.Parameters: stream_type – streamType (type: string
)Returns: string[]
-
has_updates_before_date
(obj_code=None, obj_id=None, date=None)¶ The
hasUpdatesBeforeDate
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
) - date – date (type:
dateTime
)
Returns: java.lang.Boolean
- obj_code – objCode (type:
-
is_valid_update_note
(obj_code=None, obj_id=None, comment_id=None)¶ The
isValidUpdateNote
action.Parameters: - obj_code – objCode (type:
string
) - obj_id – objID (type:
string
) - comment_id – commentID (type:
string
)
Returns: java.lang.Boolean
- obj_code – objCode (type:
-
message_args
¶ Collection
formessageArgs
-
nested_updates
¶ Collection
fornestedUpdates
-
replies
¶ Collection
forreplies
-
sub_message_args
¶ Collection
forsubMessageArgs
-
update_obj
¶ The object referenced by this update.
-
-
class
workfront.versions.unsupported.
User
(session=None, **fields)¶ Object
forUSER
-
access_rule_preferences
¶ Collection
foraccessRulePreferences
-
add_customer_feedback_improvement
(is_better=None, comment=None)¶ The
addCustomerFeedbackImprovement
action.Parameters: - is_better – isBetter (type:
boolean
) - comment – comment (type:
string
)
- is_better – isBetter (type:
-
add_customer_feedback_score_rating
(score=None, comment=None)¶ The
addCustomerFeedbackScoreRating
action.Parameters: - score – score (type:
int
) - comment – comment (type:
string
)
- score – score (type:
-
add_early_access
(ids=None)¶ The
addEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
add_external_user
(email_addr=None)¶ The
addExternalUser
action.Parameters: email_addr – emailAddr (type: string
)Returns: string
-
add_mobile_device
(token=None, device_type=None)¶ The
addMobileDevice
action.Parameters: - token – token (type:
string
) - device_type – deviceType (type:
string
)
Returns: map
- token – token (type:
-
assign_user_token
()¶ The
assignUserToken
action.Returns: string
-
calculate_data_extension
()¶ The
calculateDataExtension
action.
-
check_other_user_early_access
()¶ The
checkOtherUserEarlyAccess
action.Returns: java.lang.Boolean
-
clear_access_rule_preferences
(obj_code=None)¶ The
clearAccessRulePreferences
action.Parameters: obj_code – objCode (type: string
)
-
clear_api_key
()¶ The
clearApiKey
action.Returns: string
-
complete_external_user_registration
(first_name=None, last_name=None, new_password=None)¶ The
completeExternalUserRegistration
action.Parameters: - first_name – firstName (type:
string
) - last_name – lastName (type:
string
) - new_password – newPassword (type:
string
)
- first_name – firstName (type:
-
complete_user_registration
(first_name=None, last_name=None, token=None, title=None, new_password=None)¶ The
completeUserRegistration
action.Parameters: - first_name – firstName (type:
string
) - last_name – lastName (type:
string
) - token – token (type:
string
) - title – title (type:
string
) - new_password – newPassword (type:
string
)
- first_name – firstName (type:
-
custom_tabs
¶ Collection
forcustomTabs
-
delegations_from
¶ Collection
fordelegationsFrom
-
delete_early_access
(ids=None)¶ The
deleteEarlyAccess
action.Parameters: ids – ids (type: string[]
)
-
direct_reports
¶ Collection
fordirectReports
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
expire_password
()¶ The
expirePassword
action.
-
external_sections
¶ Collection
forexternalSections
-
favorites
¶ Collection
forfavorites
-
get_api_key
()¶ The
getApiKey
action.Returns: string
-
get_next_customer_feedback_type
()¶ The
getNextCustomerFeedbackType
action.Returns: string
-
get_or_add_external_user
(email_addr=None)¶ The
getOrAddExternalUser
action.Parameters: email_addr – emailAddr (type: string
)Returns: string
-
get_reset_password_token_expired
(token=None)¶ The
getResetPasswordTokenExpired
action.Parameters: token – token (type: string
)Returns: java.lang.Boolean
-
has_early_access
()¶ The
hasEarlyAccess
action.Returns: java.lang.Boolean
-
hour_types
¶ Collection
forhourTypes
-
is_npssurvey_available
()¶ The
isNPSSurveyAvailable
action.Returns: java.lang.Boolean
Field
forisSharePointAuthenticated
-
is_username_re_captcha_required
()¶ The
isUsernameReCaptchaRequired
action.Returns: java.lang.Boolean
-
linked_portal_tabs
¶ Collection
forlinkedPortalTabs
-
messages
¶ Collection
formessages
-
migrate_users_ppmto_anaconda
()¶ The
migrateUsersPPMToAnaconda
action.
-
mobile_devices
¶ Collection
formobileDevices
-
object_categories
¶ Collection
forobjectCategories
-
parameter_values
¶ Collection
forparameterValues
-
portal_sections
¶ Collection
forportalSections
-
portal_tabs
¶ Collection
forportalTabs
-
remove_mobile_device
(token=None)¶ The
removeMobileDevice
action.Parameters: token – token (type: string
)Returns: map
-
reserved_times
¶ Collection
forreservedTimes
-
reset_password
(old_password=None, new_password=None)¶ The
resetPassword
action.Parameters: - old_password – oldPassword (type:
string
) - new_password – newPassword (type:
string
)
- old_password – oldPassword (type:
-
retrieve_and_store_oauth2tokens
(state=None, authorization_code=None)¶ The
retrieveAndStoreOAuth2Tokens
action.Parameters: - state – state (type:
string
) - authorization_code – authorizationCode (type:
string
)
- state – state (type:
-
retrieve_and_store_oauth_token
(oauth_token=None)¶ The
retrieveAndStoreOAuthToken
action.Parameters: oauth_token – oauth_token (type: string
)
-
roles
¶ Collection
forroles
-
send_invitation_email
()¶ The
sendInvitationEmail
action.
-
set_access_rule_preferences
(access_rule_preferences=None)¶ The
setAccessRulePreferences
action.Parameters: access_rule_preferences – accessRulePreferences (type: string[]
)
-
submit_npssurvey
(data_map=None)¶ The
submitNPSSurvey
action.Parameters: data_map – dataMap (type: map
)
-
teams
¶ Collection
forteams
-
timesheet_templates
¶ Collection
fortimesheetTemplates
-
ui_filters
¶ Collection
foruiFilters
-
ui_group_bys
¶ Collection
foruiGroupBys
-
ui_views
¶ Collection
foruiViews
-
update_next_survey_on_date
(next_suvey_date=None)¶ The
updateNextSurveyOnDate
action.Parameters: next_suvey_date – nextSuveyDate (type: dateTime
)
-
updates
¶ Collection
forupdates
-
user_activities
¶ Collection
foruserActivities
-
user_groups
¶ Collection
foruserGroups
-
user_pref_values
¶ Collection
foruserPrefValues
-
validate_re_captcha
(captcha_response=None)¶ The
validateReCaptcha
action.Parameters: captcha_response – captchaResponse (type: string
)Returns: java.lang.Boolean
-
watch_list
¶ Collection
forwatchList
-
work_items
¶ Collection
forworkItems
-
-
class
workfront.versions.unsupported.
UserAvailability
(session=None, **fields)¶ Object
forUSRAVL
-
delete_duplicate_availability
(duplicate_user_availability_ids=None)¶ The
deleteDuplicateAvailability
action.Parameters: duplicate_user_availability_ids – duplicateUserAvailabilityIDs (type: string[]
)
-
get_user_assignments
(user_id=None, start_date=None, end_date=None)¶ The
getUserAssignments
action.Parameters: - user_id – userID (type:
string
) - start_date – startDate (type:
string
) - end_date – endDate (type:
string
)
Returns: string[]
- user_id – userID (type:
-
-
class
workfront.versions.unsupported.
UserNote
(session=None, **fields)¶ Object
forUSRNOT
-
acknowledge
()¶ The
acknowledge
action.Returns: string
-
acknowledge_all
()¶ The
acknowledgeAll
action.Returns: string[]
-
acknowledge_many
(obj_ids=None)¶ The
acknowledgeMany
action.Parameters: obj_ids – objIDs (type: string[]
)Returns: string[]
-
add_team_note
(team_id=None, obj_code=None, target_id=None, type=None)¶ The
addTeamNote
action.Parameters: - team_id – teamID (type:
string
) - obj_code – objCode (type:
string
) - target_id – targetID (type:
string
) - type – type (type:
com.attask.common.constants.UserNoteEventEnum
)
Returns: java.util.Collection
- team_id – teamID (type:
-
add_teams_notes
(team_ids=None, obj_code=None, target_id=None, type=None)¶ The
addTeamsNotes
action.Parameters: - team_ids – teamIDs (type:
java.util.Collection
) - obj_code – objCode (type:
string
) - target_id – targetID (type:
string
) - type – type (type:
com.attask.common.constants.UserNoteEventEnum
)
Returns: java.util.Collection
- team_ids – teamIDs (type:
-
add_user_note
(user_id=None, obj_code=None, target_id=None, type=None)¶ The
addUserNote
action.Parameters: - user_id – userID (type:
string
) - obj_code – objCode (type:
string
) - target_id – targetID (type:
string
) - type – type (type:
com.attask.common.constants.UserNoteEventEnum
)
Returns: string
- user_id – userID (type:
-
add_users_notes
(user_ids=None, obj_code=None, target_id=None, type=None)¶ The
addUsersNotes
action.Parameters: - user_ids – userIDs (type:
java.util.Collection
) - obj_code – objCode (type:
string
) - target_id – targetID (type:
string
) - type – type (type:
com.attask.common.constants.UserNoteEventEnum
)
Returns: java.util.Collection
- user_ids – userIDs (type:
Reference
fordocumentShare
Field
fordocumentShareID
Reference
forendorsementShare
Field
forendorsementShareID
-
get_my_notification_last_view_date
()¶ The
getMyNotificationLastViewDate
action.Returns: dateTime
-
has_announcement_delete_access
()¶ The
hasAnnouncementDeleteAccess
action.Returns: java.lang.Boolean
-
mark_deleted
(note_id=None)¶ The
markDeleted
action.Parameters: note_id – noteID (type: string
)
-
unacknowledge
()¶ The
unacknowledge
action.
-
unacknowledged_announcement_count
()¶ The
unacknowledgedAnnouncementCount
action.Returns: java.lang.Integer
-
unacknowledged_count
()¶ The
unacknowledgedCount
action.Returns: java.lang.Integer
-
unmark_deleted
(note_id=None)¶ The
unmarkDeleted
action.Parameters: note_id – noteID (type: string
)
-
-
class
workfront.versions.unsupported.
UserObjectPref
(session=None, **fields)¶ Object
forUSOP
-
set
(user_id=None, ref_obj_code=None, ref_obj_id=None, name=None, value=None)¶ The
set
action.Parameters: - user_id – userID (type:
string
) - ref_obj_code – refObjCode (type:
string
) - ref_obj_id – refObjID (type:
string
) - name – name (type:
string
) - value – value (type:
string
)
Returns: string
- user_id – userID (type:
-
-
class
workfront.versions.unsupported.
UserPrefValue
(session=None, **fields)¶ Object
forUSERPF
-
get_inactive_notifications_value
(user_id=None)¶ The
getInactiveNotificationsValue
action.Parameters: user_id – userID (type: string
)Returns: string
-
set_inactive_notifications_value
(user_id=None, value=None)¶ The
setInactiveNotificationsValue
action.Parameters: - user_id – userID (type:
string
) - value – value (type:
string
)
- user_id – userID (type:
-
-
class
workfront.versions.unsupported.
UserResource
(session=None, **fields)¶ Object
forUSERRS
-
assignments
¶ Collection
forassignments
-
-
class
workfront.versions.unsupported.
WhatsNew
(session=None, **fields)¶ Object
forWTSN
-
is_whats_new_available
(product_toggle=None)¶ The
isWhatsNewAvailable
action.Parameters: product_toggle – productToggle (type: int
)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.
Work
(session=None, **fields)¶ Object
forWORK
-
access_rules
¶ Collection
foraccessRules
-
all_priorities
¶ Collection
forallPriorities
-
all_severities
¶ Collection
forallSeverities
-
all_statuses
¶ Collection
forallStatuses
-
approver_statuses
¶ Collection
forapproverStatuses
-
assignments
¶ Collection
forassignments
-
awaiting_approvals
¶ Collection
forawaitingApprovals
-
children
¶ Collection
forchildren
Field
fordisplayQueueBreadcrumb
-
document_requests
¶ Collection
fordocumentRequests
-
documents
¶ Collection
fordocuments
-
done_statuses
¶ Collection
fordoneStatuses
-
expenses
¶ Collection
forexpenses
-
get_my_accomplishments_count
()¶ The
getMyAccomplishmentsCount
action.Returns: java.lang.Integer
-
get_my_work_count
()¶ The
getMyWorkCount
action.Returns: java.lang.Integer
-
get_work_requests_count
(filters=None)¶ The
getWorkRequestsCount
action.Parameters: filters – filters (type: map
)Returns: java.lang.Integer
-
hours
¶ Collection
forhours
-
notification_records
¶ Collection
fornotificationRecords
-
object_categories
¶ Collection
forobjectCategories
-
op_tasks
¶ Collection
foropTasks
-
open_op_tasks
¶ Collection
foropenOpTasks
-
parameter_values
¶ Collection
forparameterValues
-
predecessors
¶ Collection
forpredecessors
Field
forqueueTopicBreadcrumb
-
resolvables
¶ Collection
forresolvables
-
security_ancestors
¶ Collection
forsecurityAncestors
-
successors
¶ Collection
forsuccessors
-
team_request_count
(filters=None)¶ The
teamRequestCount
action.Parameters: filters – filters (type: map
)Returns: java.lang.Integer
-
team_requests_count
()¶ The
teamRequestsCount
action.Returns: map
-
updates
¶ Collection
forupdates
-
-
class
workfront.versions.unsupported.
WorkItem
(session=None, **fields)¶ Object
forWRKITM
-
make_top_priority
(obj_code=None, assignable_id=None, user_id=None)¶ The
makeTopPriority
action.Parameters: - obj_code – objCode (type:
string
) - assignable_id – assignableID (type:
string
) - user_id – userID (type:
string
)
- obj_code – objCode (type:
-
mark_viewed
()¶ The
markViewed
action.
-