python-workfront documentation¶
This is a Python client library for accessing the Workfront REST api.
Quickstart¶
Install the package:
$ pip install python-workfront
Generate an API key:
$ python -m workfront.get_api_key --domain ${your_domain}
username: your_user
Password:
Your API key is: '...'
Note
If you have SAML authentication enabled, you may well need to disable it for for the specified user in order to obtain an API key. Once you have an API key, you can re-enable SAML authentication.
Make a session:
from workfront import Session
session = Session('your domain', api_key='...')
api = session.api
Search for a project:
project = session.search(api.Project,
name='my project name',
name_Mod='cicontains')[0]
Create an issue in that project:
issue = api.Issue(session,
name='a test issue',
description='some text here',
project_id=project.id)
issue.save()
Add a comment to the issue just created:
issue.add_comment('a comment')
Detailed Documentation¶
Usage¶
Low-level requests¶
- Session.request, params
- get/post/put/delete
Finding objects¶
- search
- load
Working with objects¶
- FieldNotLoaded
- references / collections
- load (to get more fields)
- save (only saves changed)
- delete
API Reference¶
-
class
workfront.Session(domain, api_key=None, ssl_context=None, protocol='https', api_version='unsupported', url_template='{protocol}://{domain}.attask-ondemand.com/attask/api/{api_version}')¶ A session for communicating with the Workfront REST API.
Parameters: - domain – Your Workfront domain name.
- api_key – An optional API key to pass with requests made using this session.
- ssl_context – An optional
SSLContextto use when communicating with Workfront via SSL. - protocol – The protocol to use, defaults to
https. - api_version – The version of the Workfront API to use, defaults to
unsupported, which is the newest available. - url_template – The template for Workfront URLs into which
domain,protocol, andapi_versionwill be interpolated.
Warning
ssl_contextwill result in exceptions being raised when used under Python 3.4, support exists in Python 2.7 and Python 3.5 onwards.-
api_version= None¶ The
APIVersionfor theapi_versionspecified.
-
request(method, path, params=None)¶ The lowest level method for making a request to the Workfront REST API. You should only need to use this if you need a
methodthat isn’t supported below.Parameters: - method – The HTTP method to use, eg:
GET,POST,PUT. - path – The path element of the URL for the request, eg:
/user. - params – A
dictof parameters to include in the request.
Returns: The JSON-decoded data element of the response from Workfront.
- method – The HTTP method to use, eg:
-
get(path, params=None)¶ Perform a
method=GETrequest to the Workfront REST API.Parameters: - path – The path element of the URL for the request, eg:
/user. - params – A
dictof parameters to include in the request.
Returns: The JSON-decoded data element of the response from Workfront.
- path – The path element of the URL for the request, eg:
-
post(path, params=None)¶ Perform a
method=POSTrequest to the Workfront REST API.Parameters: - path – The path element of the URL for the request, eg:
/user. - params – A
dictof parameters to include in the request.
Returns: The JSON-decoded data element of the response from Workfront.
- path – The path element of the URL for the request, eg:
-
put(path, params=None)¶ Perform a
method=PUTrequest to the Workfront REST API.Parameters: - path – The path element of the URL for the request, eg:
/user. - params – A
dictof parameters to include in the request.
Returns: The JSON-decoded data element of the response from Workfront.
- path – The path element of the URL for the request, eg:
-
delete(path, params=None)¶ Perform a
method=DELETErequest to the Workfront REST API.Parameters: - path – The path element of the URL for the request, eg:
/user. - params – A
dictof parameters to include in the request.
Returns: The JSON-decoded data element of the response from Workfront.
- path – The path element of the URL for the request, eg:
-
login(username, password)¶ Start an ID-based session using the supplied username and password. The resulting
sessionIDwill be passed for all subsequence requests using thisSession.The session user’s UUID will be stored in
Session.user_id.
-
logout()¶ End the current ID-based session.
-
get_api_key(username, password)¶ Return the API key for the user with the username and password supplied.
Warning
If the
Sessionis created with anapi_key, then that key may always be returned, no matter what username or password are provided.
-
search(object_type, fields=None, **parameters)¶ Search for
Objectinstances of the specified type.Parameters: - object_type – The type of object to search for. Should be obtained
from the
workfront.Session.api. - fields – Additional fields to
load()on the returned objects. Nested Object field specifications are supported. - parameters – The search parameters. See the Workfront documentation for full details.
Returns: A list of objects of the
object_typespecified.- object_type – The type of object to search for. Should be obtained
from the
-
load(object_type, id_or_ids, fields=None)¶ Load one or more
Objectinstances by their UUID.Parameters: - object_type – The type of object to search for. Should be obtained
from the
workfront.Session.api. - id_or_ids – A string, when a single object is to be loaded, or a sequence of strings when multiple objects are to be loaded.
- fields – The fields to
load()on each object returned. If not specified, the default fields for that object type will be loaded.
Returns: If a single
idis specified, the loaded object will be returned. Ifid_or_idsis a sequence, a list of objects will be returned.- object_type – The type of object to search for. Should be obtained
from the
-
workfront.session.ONDEMAND_TEMPLATE= '{protocol}://{domain}.attask-ondemand.com/attask/api/{api_version}'¶ The default URL template used when creating a
Session.
-
workfront.session.SANDBOX_TEMPLATE= '{protocol}://{domain}.attasksandbox.com/attask/api/{api_version}'¶ An alternate URL template that can be used when creating a
Sessionto the Workfront Sandbox.
-
exception
workfront.session.WorkfrontAPIError(data, code)¶ An exception indicating that an error has been returned by Workfront, either in the form of the
errorkey being provided in the JSON response, or a non-200 HTTP status code being sent.-
code= None¶ The HTTP response code returned by Workfront.
-
data= None¶ The
errorreturned in the response from Workfront, decoded from JSON if possible, a string otherwise.
-
-
class
workfront.meta.APIVersion(version)¶ Receptacle for classes for a specific API version. The classes can be obtained from the
APIVersioninstance by attribute, eg:session = Session(...) api = session.api issue = api.Issue(session, ...)
To find the name of a class your require, consult the Module Index or use the Search Page in conjunction with the API Explorer.
-
exception
workfront.meta.FieldNotLoaded¶ Exception raised when a field is accessed but has not been loaded.
-
class
workfront.meta.Field(workfront_name)¶ The descriptor used for mapping Workfront fields to attributes of an
Object.When a
Fieldis obtained from anObject, it’s value will be returned, or aFieldNotLoadedexception will be raised if it has not yet been loaded.When set, a
Fieldwill store its value in theObject, to save values back to Workfront, useObject.save().
-
class
workfront.meta.Reference(workfront_name)¶ The descriptor used for mapping Workfront references to attributes of an
Object.When a
Referenceis obtained from anObject, a referenced object orNone, if there is no referenced object in this field, will be returned. If the referenced object has not yet been loaded, it will be loaded before being returned.A
Referencecannot be set, you should instead set the matching_idFieldto theidof the object you wish to reference.
-
class
workfront.meta.Collection(workfront_name)¶ The descriptor used for mapping Workfront collections to attributes of an
Object.When a
Collectionis obtained from anObject, atupleof objects, which may be empty, is returned. If the collection has not yet been loaded, it will be loaded before being returned.A
Collectioncannot be set or modified.
-
class
workfront.meta.Object(session=None, **fields)¶ The base class for objects reflected from the Workfront REST API.
Objects can be instantiated and then saved in order to create new objects, or retrieved from Workfront using
workfront.Session.search()orworkfront.Session.load().Wherever
fieldsare mentioned, they may be specified as either Workfront-style camel case names, or the Python-style attribute names they are mapped to.-
id¶ The UUID of this object in Workfront. It will be
Noneif this object has not yet been saved to Workfront.
-
api_url()¶ The URI of this object in Workfront, suitable for passing to any of the
Sessionmethods that generate requests.This method cannot be used until the object has been saved to Workfront.
-
load(*field_names)¶ Load additional fields for this object from Workfront.
Parameters: field_names – Either Workfront-style camel case names or the Python-style attribute names they are mapped to for the fields to be loaded.
-
save()¶ If this object has not yet been saved to Workfront, create it using all the current fields that have been set.
In other cases, save only the fields that have changed on this object to Workfront.
-
delete()¶ Delete this object from Workfront.
-
API versions¶
The versions listed have been reflected from the relevant Workfront API metadata. The documentation below primarily gives the mapping betwen the API name and the pythonic name. The API Explorer may be an easier way to find the things.
v4.0 API Reference¶
-
class
workfront.versions.v40.Approval(session=None, **fields)¶ ObjectforAPPROVAL-
access_rules¶ CollectionforaccessRules
-
alignment_values¶ CollectionforalignmentValues
-
all_hours¶ CollectionforallHours
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approver_statuses¶ CollectionforapproverStatuses
-
assignments¶ Collectionforassignments
-
baselines¶ Collectionforbaselines
-
billing_records¶ CollectionforbillingRecords
-
children¶ Collectionforchildren
-
deliverable_values¶ CollectionfordeliverableValues
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
exchange_rates¶ CollectionforexchangeRates
-
expenses¶ Collectionforexpenses
-
hour_types¶ CollectionforhourTypes
-
hours¶ Collectionforhours
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
predecessors¶ Collectionforpredecessors
-
project_user_roles¶ CollectionforprojectUserRoles
-
project_users¶ CollectionforprojectUsers
-
rates¶ Collectionforrates
-
resolvables¶ Collectionforresolvables
-
resource_allocations¶ CollectionforresourceAllocations
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
successors¶ Collectionforsuccessors
-
tasks¶ Collectionfortasks
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.v40.ApprovalPath(session=None, **fields)¶ ObjectforARVPTH-
approval_steps¶ CollectionforapprovalSteps
-
-
class
workfront.versions.v40.ApprovalProcess(session=None, **fields)¶ ObjectforARVPRC-
approval_paths¶ CollectionforapprovalPaths
-
-
class
workfront.versions.v40.ApprovalStep(session=None, **fields)¶ ObjectforARVSTP-
step_approvers¶ CollectionforstepApprovers
-
-
class
workfront.versions.v40.Baseline(session=None, **fields)¶ ObjectforBLIN-
baseline_tasks¶ CollectionforbaselineTasks
-
-
class
workfront.versions.v40.BillingRecord(session=None, **fields)¶ ObjectforBILL-
billable_tasks¶ CollectionforbillableTasks
-
expenses¶ Collectionforexpenses
-
hours¶ Collectionforhours
-
-
class
workfront.versions.v40.Category(session=None, **fields)¶ ObjectforCTGY-
category_parameters¶ CollectionforcategoryParameters
-
other_groups¶ CollectionforotherGroups
-
-
class
workfront.versions.v40.CategoryParameter(session=None, **fields)¶ ObjectforCTGYPAFieldforrowShared
-
class
workfront.versions.v40.Company(session=None, **fields)¶ ObjectforCMPY-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
rates¶ Collectionforrates
-
-
class
workfront.versions.v40.CustomEnum(session=None, **fields)¶ ObjectforCSTEM-
get_default_op_task_priority_enum()¶ The
getDefaultOpTaskPriorityEnumaction.Returns: java.lang.Integer
-
get_default_project_status_enum()¶ The
getDefaultProjectStatusEnumaction.Returns: string
-
get_default_severity_enum()¶ The
getDefaultSeverityEnumaction.Returns: java.lang.Integer
-
get_default_task_priority_enum()¶ The
getDefaultTaskPriorityEnumaction.Returns: java.lang.Integer
-
-
class
workfront.versions.v40.Customer(session=None, **fields)¶ ObjectforCUST-
approval_processes¶ CollectionforapprovalProcesses
-
categories¶ Collectionforcategories
-
custom_enums¶ CollectionforcustomEnums
-
documents¶ Collectionfordocuments
-
expense_types¶ CollectionforexpenseTypes
-
groups¶ Collectionforgroups
-
hour_types¶ CollectionforhourTypes
-
layout_templates¶ CollectionforlayoutTemplates
-
milestone_paths¶ CollectionformilestonePaths
-
parameter_groups¶ CollectionforparameterGroups
-
parameters¶ Collectionforparameters
-
resource_pools¶ CollectionforresourcePools
-
risk_types¶ CollectionforriskTypes
-
roles¶ Collectionforroles
-
schedules¶ Collectionforschedules
-
score_cards¶ CollectionforscoreCards
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
-
class
workfront.versions.v40.Document(session=None, **fields)¶ ObjectforDOCU-
access_rules¶ CollectionforaccessRules
-
approvals¶ Collectionforapprovals
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
folders¶ Collectionforfolders
-
groups¶ Collectionforgroups
-
move(obj_id=None, doc_obj_code=None)¶ The
moveaction.Parameters: - obj_id – objID (type:
string) - doc_obj_code – docObjCode (type:
string)
- obj_id – objID (type:
-
subscribers¶ Collectionforsubscribers
-
versions¶ Collectionforversions
-
-
class
workfront.versions.v40.DocumentApproval(session=None, **fields)¶ ObjectforDOCAPLFieldforautoDocumentShareID
-
class
workfront.versions.v40.DocumentFolder(session=None, **fields)¶ ObjectforDOCFDR-
children¶ Collectionforchildren
-
documents¶ Collectionfordocuments
-
-
class
workfront.versions.v40.Expense(session=None, **fields)¶ ObjectforEXPNS-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
move(obj_id=None, exp_obj_code=None)¶ The
moveaction.Parameters: - obj_id – objID (type:
string) - exp_obj_code – expObjCode (type:
string)
- obj_id – objID (type:
-
-
class
workfront.versions.v40.HourType(session=None, **fields)¶ ObjectforHOURT-
users¶ Collectionforusers
-
-
class
workfront.versions.v40.Issue(session=None, **fields)¶ ObjectforOPTASK-
accept_work()¶ The
acceptWorkaction.
-
access_rules¶ CollectionforaccessRules
-
add_comment(text)¶ Add a comment to the current object containing the supplied text.
The new
Commentinstance is returned, it does not need to be saved.
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
assign(obj_id=None, obj_code=None)¶ The
assignaction.Parameters: - obj_id – objID (type:
string) - obj_code – objCode (type:
string)
- obj_id – objID (type:
-
assignments¶ Collectionforassignments
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
convert_to_task()¶ Convert this issue to a task. The newly converted task will be returned, it does not need to be saved.
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
hours¶ Collectionforhours
-
mark_done(status=None)¶ The
markDoneaction.Parameters: status – status (type: string)
-
mark_not_done(assignment_id=None)¶ The
markNotDoneaction.Parameters: assignment_id – assignmentID (type: string)
-
move(project_id=None)¶ The
moveaction.Parameters: project_id – projectID (type: string)
-
move_to_task(project_id=None, parent_id=None)¶ The
moveToTaskaction.Parameters: - project_id – projectID (type:
string) - parent_id – parentID (type:
string)
- project_id – projectID (type:
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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
replyToAssignmentaction.Parameters: - note_text – noteText (type:
string) - commit_date – commitDate (type:
dateTime)
- note_text – noteText (type:
-
resolvables¶ Collectionforresolvables
-
unaccept_work()¶ The
unacceptWorkaction.
-
unassign(user_id=None)¶ The
unassignaction.Parameters: user_id – userID (type: string)
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.v40.Iteration(session=None, **fields)¶ ObjectforITRN-
documents¶ Collectionfordocuments
-
-
class
workfront.versions.v40.JournalEntry(session=None, **fields)¶ ObjectforJRNLEFieldfordocumentShareID
-
like()¶ The
likeaction.
-
replies¶ Collectionforreplies
-
unlike()¶ The
unlikeaction.
-
class
workfront.versions.v40.LayoutTemplate(session=None, **fields)¶ ObjectforLYTMPLFieldfordefaultNavItem
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
FieldfornavBar
FieldfornavItems
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
class
workfront.versions.v40.MilestonePath(session=None, **fields)¶ ObjectforMPATH-
groups¶ Collectionforgroups
-
milestones¶ Collectionformilestones
-
-
class
workfront.versions.v40.Note(session=None, **fields)¶ ObjectforNOTE-
add_comment(text)¶ Add a comment to this comment.
The new
Commentinstance is returned, it does not need to be saved.
-
like()¶ The
likeaction.
-
replies¶ Collectionforreplies
Collectionfortags
-
unlike()¶ The
unlikeaction.
-
-
class
workfront.versions.v40.Parameter(session=None, **fields)¶ ObjectforPARAM-
parameter_options¶ CollectionforparameterOptions
-
-
class
workfront.versions.v40.ParameterOption(session=None, **fields)¶ ObjectforPOPTFieldforisHidden
-
class
workfront.versions.v40.Portfolio(session=None, **fields)¶ ObjectforPORT-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
documents¶ Collectionfordocuments
-
groups¶ Collectionforgroups
-
programs¶ Collectionforprograms
-
projects¶ Collectionforprojects
-
-
class
workfront.versions.v40.Program(session=None, **fields)¶ ObjectforPRGM-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
documents¶ Collectionfordocuments
-
move(portfolio_id=None, options=None)¶ The
moveaction.Parameters: - portfolio_id – portfolioID (type:
string) - options – options (type:
string[])
- portfolio_id – portfolioID (type:
-
projects¶ Collectionforprojects
-
-
class
workfront.versions.v40.Project(session=None, **fields)¶ ObjectforPROJ-
access_rules¶ CollectionforaccessRules
-
alignment_values¶ CollectionforalignmentValues
-
all_hours¶ CollectionforallHours
-
all_priorities¶ CollectionforallPriorities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
attach_template(template_id=None, predecessor_task_id=None, parent_task_id=None, exclude_template_task_ids=None, options=None)¶ The
attachTemplateaction.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:
-
baselines¶ Collectionforbaselines
-
billing_records¶ CollectionforbillingRecords
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
calculate_finance()¶ The
calculateFinanceaction.
-
calculate_timeline()¶ The
calculateTimelineaction.
-
deliverable_values¶ CollectionfordeliverableValues
-
documents¶ Collectionfordocuments
-
exchange_rates¶ CollectionforexchangeRates
-
expenses¶ Collectionforexpenses
-
hour_types¶ CollectionforhourTypes
-
hours¶ Collectionforhours
-
open_op_tasks¶ CollectionforopenOpTasks
-
project_user_roles¶ CollectionforprojectUserRoles
-
project_users¶ CollectionforprojectUsers
-
rates¶ Collectionforrates
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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:
-
resolvables¶ Collectionforresolvables
-
resource_allocations¶ CollectionforresourceAllocations
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
set_budget_to_schedule()¶ The
setBudgetToScheduleaction.
-
tasks¶ Collectionfortasks
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.v40.QueueDef(session=None, **fields)¶ ObjectforQUED-
queue_topics¶ CollectionforqueueTopics
-
-
class
workfront.versions.v40.ResourcePool(session=None, **fields)¶ ObjectforRSPOOL-
resource_allocations¶ CollectionforresourceAllocations
-
roles¶ Collectionforroles
-
users¶ Collectionforusers
-
-
class
workfront.versions.v40.Schedule(session=None, **fields)¶ ObjectforSCHED-
get_earliest_work_time_of_day(date=None)¶ The
getEarliestWorkTimeOfDayaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
get_latest_work_time_of_day(date=None)¶ The
getLatestWorkTimeOfDayaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
get_next_completion_date(date=None, cost_in_minutes=None)¶ The
getNextCompletionDateaction.Parameters: - date – date (type:
dateTime) - cost_in_minutes – costInMinutes (type:
int)
Returns: dateTime- date – date (type:
-
get_next_start_date(date=None)¶ The
getNextStartDateaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
non_work_days¶ CollectionfornonWorkDays
-
other_groups¶ CollectionforotherGroups
-
-
class
workfront.versions.v40.ScoreCard(session=None, **fields)¶ ObjectforSCORE-
score_card_questions¶ CollectionforscoreCardQuestions
-
-
class
workfront.versions.v40.ScoreCardOption(session=None, **fields)¶ ObjectforSCOPTFieldforisHidden
-
class
workfront.versions.v40.ScoreCardQuestion(session=None, **fields)¶ ObjectforSCOREQ-
score_card_options¶ CollectionforscoreCardOptions
-
-
class
workfront.versions.v40.Task(session=None, **fields)¶ ObjectforTASK-
accept_work()¶ The
acceptWorkaction.
-
access_rules¶ CollectionforaccessRules
-
add_comment(text)¶ Add a comment to the current object containing the supplied text.
The new
Commentinstance is returned, it does not need to be saved.
-
all_priorities¶ CollectionforallPriorities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
assign(obj_id=None, obj_code=None)¶ The
assignaction.Parameters: - obj_id – objID (type:
string) - obj_code – objCode (type:
string)
- obj_id – objID (type:
-
assignments¶ Collectionforassignments
-
bulk_copy(task_ids=None, project_id=None, parent_id=None, options=None)¶ The
bulkCopyaction.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
bulkMoveaction.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
calculateDataExtensionaction.
-
children¶ Collectionforchildren
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
expenses¶ Collectionforexpenses
-
hours¶ Collectionforhours
-
mark_done(status=None)¶ The
markDoneaction.Parameters: status – status (type: string)
-
mark_not_done(assignment_id=None)¶ The
markNotDoneaction.Parameters: assignment_id – assignmentID (type: string)
-
move(project_id=None, parent_id=None, options=None)¶ The
moveaction.Parameters: - project_id – projectID (type:
string) - parent_id – parentID (type:
string) - options – options (type:
string[])
- project_id – projectID (type:
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
predecessors¶ Collectionforpredecessors
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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
replyToAssignmentaction.Parameters: - note_text – noteText (type:
string) - commit_date – commitDate (type:
dateTime)
- note_text – noteText (type:
-
resolvables¶ Collectionforresolvables
-
successors¶ Collectionforsuccessors
-
unaccept_work()¶ The
unacceptWorkaction.
-
unassign(user_id=None)¶ The
unassignaction.Parameters: user_id – userID (type: string)
-
unassign_occurrences(user_id=None)¶ The
unassignOccurrencesaction.Parameters: user_id – userID (type: string)Returns: string[]
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.v40.Team(session=None, **fields)¶ ObjectforTEAMOB-
backlog_tasks¶ CollectionforbacklogTasks
-
team_members¶ CollectionforteamMembers
-
updates¶ Collectionforupdates
-
users¶ Collectionforusers
-
-
class
workfront.versions.v40.Template(session=None, **fields)¶ ObjectforTMPL-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
deliverable_values¶ CollectionfordeliverableValues
-
documents¶ Collectionfordocuments
-
expenses¶ Collectionforexpenses
-
groups¶ Collectionforgroups
-
hour_types¶ CollectionforhourTypes
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
template_tasks¶ CollectionfortemplateTasks
-
template_user_roles¶ CollectionfortemplateUserRoles
-
template_users¶ CollectionfortemplateUsers
-
-
class
workfront.versions.v40.TemplateTask(session=None, **fields)¶ ObjectforTTSK-
assignments¶ Collectionforassignments
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
children¶ Collectionforchildren
-
documents¶ Collectionfordocuments
-
expenses¶ Collectionforexpenses
-
move(template_id=None, parent_id=None, options=None)¶ The
moveaction.Parameters: - template_id – templateID (type:
string) - parent_id – parentID (type:
string) - options – options (type:
string[])
- template_id – templateID (type:
-
predecessors¶ Collectionforpredecessors
-
successors¶ Collectionforsuccessors
-
-
class
workfront.versions.v40.Timesheet(session=None, **fields)¶ ObjectforTSHET-
hours¶ Collectionforhours
-
-
class
workfront.versions.v40.UIFilter(session=None, **fields)¶ ObjectforUIFT-
access_rules¶ CollectionforaccessRules
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
users¶ Collectionforusers
-
-
class
workfront.versions.v40.UIGroupBy(session=None, **fields)¶ ObjectforUIGB-
access_rules¶ CollectionforaccessRules
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
-
class
workfront.versions.v40.UIView(session=None, **fields)¶ ObjectforUIVW-
access_rules¶ CollectionforaccessRules
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
-
class
workfront.versions.v40.Update(session=None, **fields)¶ ObjectforUPDATE-
combined_updates¶ CollectionforcombinedUpdates
-
message_args¶ CollectionformessageArgs
-
nested_updates¶ CollectionfornestedUpdates
-
replies¶ Collectionforreplies
-
sub_message_args¶ CollectionforsubMessageArgs
-
update_obj¶ The object referenced by this update.
-
-
class
workfront.versions.v40.User(session=None, **fields)¶ ObjectforUSER-
assign_user_token()¶ The
assignUserTokenaction.Returns: string
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
complete_user_registration(first_name=None, last_name=None, token=None, title=None, new_password=None)¶ The
completeUserRegistrationaction.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:
-
direct_reports¶ CollectionfordirectReports
-
documents¶ Collectionfordocuments
-
favorites¶ Collectionforfavorites
-
hour_types¶ CollectionforhourTypes
FieldforisSharePointAuthenticated
-
messages¶ Collectionformessages
-
other_groups¶ CollectionforotherGroups
-
reserved_times¶ CollectionforreservedTimes
-
roles¶ Collectionforroles
-
send_invitation_email()¶ The
sendInvitationEmailaction.
-
teams¶ Collectionforteams
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
updates¶ Collectionforupdates
-
user_activities¶ CollectionforuserActivities
-
user_notes¶ CollectionforuserNotes
-
user_pref_values¶ CollectionforuserPrefValues
-
work_items¶ CollectionforworkItems
-
-
class
workfront.versions.v40.UserNote(session=None, **fields)¶ ObjectforUSRNOTFieldfordocumentShareID
-
class
workfront.versions.v40.Work(session=None, **fields)¶ ObjectforWORK-
access_rules¶ CollectionforaccessRules
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approver_statuses¶ CollectionforapproverStatuses
-
assignments¶ Collectionforassignments
-
children¶ Collectionforchildren
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
expenses¶ Collectionforexpenses
-
hours¶ Collectionforhours
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
predecessors¶ Collectionforpredecessors
-
resolvables¶ Collectionforresolvables
-
successors¶ Collectionforsuccessors
-
team_requests_count()¶ The
teamRequestsCountaction.Returns: map
-
updates¶ Collectionforupdates
-
“unsupported” API Reference¶
-
class
workfront.versions.unsupported.AccessLevel(session=None, **fields)¶ ObjectforACSLVL-
access_level_permissions¶ CollectionforaccessLevelPermissions
-
access_rule_preferences¶ CollectionforaccessRulePreferences
-
access_scope_actions¶ CollectionforaccessScopeActions
-
calculate_sharing(obj_code=None, obj_id=None)¶ The
calculateSharingaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
- obj_code – objCode (type:
-
clear_access_rule_preferences(obj_code=None)¶ The
clearAccessRulePreferencesaction.Parameters: obj_code – objCode (type: string)
-
create_unsupported_worker_access_level_for_testing()¶ The
createUnsupportedWorkerAccessLevelForTestingaction.
-
filter_actions_for_external(obj_code=None, action_types=None)¶ The
filterActionsForExternalaction.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
filterAvailableActionsaction.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
getAccessLevelPermissionsForObjCodeaction.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
getDefaultAccessPermissionsaction.Parameters: license_type – licenseType (type: com.attask.common.constants.LicenseTypeEnum)Returns: map
-
get_default_access_rule_preferences()¶ The
getDefaultAccessRulePreferencesaction.Returns: map
-
get_default_forbidden_actions(obj_code=None, obj_id=None)¶ The
getDefaultForbiddenActionsaction.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
getMaximumAccessPermissionsaction.Parameters: license_type – licenseType (type: com.attask.common.constants.LicenseTypeEnum)Returns: map
-
get_security_parent_ids(obj_code=None, obj_id=None)¶ The
getSecurityParentIDsaction.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
getSecurityParentObjCodeaction.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
getUserAccessorIDsaction.Parameters: user_id – userID (type: string)Returns: string[]
-
get_viewable_object_obj_codes()¶ The
getViewableObjectObjCodesaction.Returns: string[]
-
has_any_access(obj_code=None, action_type=None)¶ The
hasAnyAccessaction.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
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
legacy_diagnostics()¶ The
legacyDiagnosticsaction.Returns: map
-
set_access_rule_preferences(access_rule_preferences=None)¶ The
setAccessRulePreferencesaction.Parameters: access_rule_preferences – accessRulePreferences (type: string[])
-
-
class
workfront.versions.unsupported.AccessLevelPermissions(session=None, **fields)¶ ObjectforALVPER
-
class
workfront.versions.unsupported.AccessRequest(session=None, **fields)¶ ObjectforACSREQFieldforautoShareAction
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
grant_access(access_request_id=None, action_type=None, forbidden_actions=None)¶ The
grantAccessaction.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
grantObjectAccessaction.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
ignoreaction.Parameters: access_request_id – accessRequestID (type: string)
-
recall(access_request_id=None)¶ The
recallaction.Parameters: access_request_id – accessRequestID (type: string)
-
remind(access_request_id=None)¶ The
remindaction.Parameters: access_request_id – accessRequestID (type: string)
-
request_access(obj_code=None, obj_id=None, requestee_id=None, core_action=None, message=None)¶ The
requestAccessaction.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)¶ ObjectforARPREF
-
class
workfront.versions.unsupported.Acknowledgement(session=None, **fields)¶ ObjectforACK-
acknowledge(obj_code=None, obj_id=None)¶ The
acknowledgeaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
Returns: string- obj_code – objCode (type:
-
acknowledge_many(obj_code_ids=None)¶ The
acknowledgeManyaction.Parameters: obj_code_ids – objCodeIDs (type: map)Returns: string[]
-
unacknowledge(obj_code=None, obj_id=None)¶ The
unacknowledgeaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
- obj_code – objCode (type:
-
-
class
workfront.versions.unsupported.Announcement(session=None, **fields)¶ ObjectforANCMNT-
announcement_recipients¶ CollectionforannouncementRecipients
-
attachments¶ Collectionforattachments
-
file_handle(attachment_id=None)¶ The
fileHandleaction.Parameters: attachment_id – attachmentID (type: string)Returns: string
-
zip_announcement_attachments(announcement_id=None)¶ The
zipAnnouncementAttachmentsaction.Parameters: announcement_id – announcementID (type: string)Returns: string
-
-
class
workfront.versions.unsupported.AnnouncementAttachment(session=None, **fields)¶ ObjectforANMATT-
forward_attachments(announcement_id=None, old_attachment_ids=None, new_attachments=None)¶ The
forwardAttachmentsaction.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
uploadAttachmentsaction.Parameters: - announcement_id – announcementID (type:
string) - attachments – attachments (type:
map)
- announcement_id – announcementID (type:
-
-
class
workfront.versions.unsupported.AnnouncementOptOut(session=None, **fields)¶ ObjectforAMNTO-
announcement_opt_out(announcement_opt_out_types=None)¶ The
announcementOptOutaction.Parameters: announcement_opt_out_types – announcementOptOutTypes (type: string[])
-
-
class
workfront.versions.unsupported.AnnouncementRecipient(session=None, **fields)¶ ObjectforANCREC
-
class
workfront.versions.unsupported.AppGlobal(session=None, **fields)¶ ObjectforAPGLOB-
access_levels¶ CollectionforaccessLevels
-
access_scopes¶ CollectionforaccessScopes
-
app_events¶ CollectionforappEvents
-
expense_types¶ CollectionforexpenseTypes
-
external_sections¶ CollectionforexternalSections
-
features_mapping¶ CollectionforfeaturesMapping
-
hour_types¶ CollectionforhourTypes
-
layout_templates¶ CollectionforlayoutTemplates
-
meta_records¶ CollectionformetaRecords
-
portal_profiles¶ CollectionforportalProfiles
-
portal_sections¶ CollectionforportalSections
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
-
class
workfront.versions.unsupported.Approval(session=None, **fields)¶ ObjectforAPPROVAL-
access_rules¶ CollectionforaccessRules
-
alignment_values¶ CollectionforalignmentValues
-
all_hours¶ CollectionforallHours
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approver_statuses¶ CollectionforapproverStatuses
-
assignments¶ Collectionforassignments
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
baselines¶ Collectionforbaselines
-
billing_records¶ CollectionforbillingRecords
-
children¶ Collectionforchildren
-
deliverable_values¶ CollectionfordeliverableValues
FieldfordisplayQueueBreadcrumb
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
exchange_rates¶ CollectionforexchangeRates
-
expenses¶ Collectionforexpenses
-
hour_types¶ CollectionforhourTypes
-
hours¶ Collectionforhours
-
is_in_my_approvals(object_type=None, object_id=None)¶ The
isInMyApprovalsaction.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
isInMySubmittedApprovalsaction.Parameters: - object_type – objectType (type:
string) - object_id – objectID (type:
string)
Returns: java.lang.Boolean- object_type – objectType (type:
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
parameter_values¶ CollectionforparameterValues
-
predecessors¶ Collectionforpredecessors
-
project_user_roles¶ CollectionforprojectUserRoles
-
project_users¶ CollectionforprojectUsers
FieldforqueueTopicBreadcrumb
-
rates¶ Collectionforrates
-
resolvables¶ Collectionforresolvables
-
resource_allocations¶ CollectionforresourceAllocations
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
security_ancestors¶ CollectionforsecurityAncestors
-
successors¶ Collectionforsuccessors
-
tasks¶ Collectionfortasks
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.ApprovalPath(session=None, **fields)¶ ObjectforARVPTH-
approval_steps¶ CollectionforapprovalSteps
-
-
class
workfront.versions.unsupported.ApprovalProcess(session=None, **fields)¶ ObjectforARVPRC-
approval_paths¶ CollectionforapprovalPaths
-
-
class
workfront.versions.unsupported.ApprovalProcessAttachable(session=None, **fields)¶ ObjectforAPRPROCATCH-
approver_statuses¶ CollectionforapproverStatuses
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
-
class
workfront.versions.unsupported.ApprovalStep(session=None, **fields)¶ ObjectforARVSTP-
step_approvers¶ CollectionforstepApprovers
-
-
class
workfront.versions.unsupported.AuditLoginAsSession(session=None, **fields)¶ ObjectforAUDS-
all_accessed_users()¶ The
allAccessedUsersaction.Returns: map
-
all_admins()¶ The
allAdminsaction.Returns: map
-
audit_session(user_id=None, target_user_id=None)¶ The
auditSessionaction.Parameters: - user_id – userID (type:
string) - target_user_id – targetUserID (type:
string)
Returns: string- user_id – userID (type:
-
end_audit(session_id=None)¶ The
endAuditaction.Parameters: session_id – sessionID (type: string)
-
get_accessed_users(user_id=None)¶ The
getAccessedUsersaction.Parameters: user_id – userID (type: string)Returns: map
-
journal_entries¶ CollectionforjournalEntries
-
notes¶ Collectionfornotes
-
who_accessed_user(user_id=None)¶ The
whoAccessedUseraction.Parameters: user_id – userID (type: string)Returns: map
-
-
class
workfront.versions.unsupported.Authentication(session=None, **fields)¶ ObjectforAUTH-
create_public_session()¶ The
createPublicSessionaction.Returns: map
-
create_schema()¶ The
createSchemaaction.
-
create_session()¶ The
createSessionaction.Returns: map
-
get_days_to_expiration_for_user()¶ The
getDaysToExpirationForUseraction.Returns: java.lang.Integer
-
get_password_complexity_by_token(token=None)¶ The
getPasswordComplexityByTokenaction.Parameters: token – token (type: string)Returns: string
-
get_password_complexity_by_username(username=None)¶ The
getPasswordComplexityByUsernameaction.Parameters: username – username (type: string)Returns: string
-
get_ssooption_by_domain(domain=None)¶ The
getSSOOptionByDomainaction.Parameters: domain – domain (type: string)Returns: map
-
get_upgrades_info()¶ The
getUpgradesInfoaction.Returns: map
-
login_with_user_name(session_id=None, username=None)¶ The
loginWithUserNameaction.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
loginWithUserNameAndPasswordaction.Parameters: - username – username (type:
string) - password – password (type:
string)
Returns: map- username – username (type:
-
logout(sso_user=None, is_mobile=None)¶ The
logoutaction.Parameters: - sso_user – ssoUser (type:
boolean) - is_mobile – isMobile (type:
boolean)
- sso_user – ssoUser (type:
-
perform_upgrade()¶ The
performUpgradeaction.
-
reset_password(user_name=None, old_password=None, new_password=None)¶ The
resetPasswordaction.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
resetPasswordByTokenaction.Parameters: - token – token (type:
string) - new_password – newPassword (type:
string)
Returns: string- token – token (type:
-
upgrade_progress()¶ The
upgradeProgressaction.Returns: map
-
-
class
workfront.versions.unsupported.Avatar(session=None, **fields)¶ ObjectforAVATAR-
crop_unsaved_avatar_file(handle=None, width=None, height=None, avatar_x=None, avatar_y=None)¶ The
cropUnsavedAvatarFileaction.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
getAvatarDataaction.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
getAvatarDownloadURLaction.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
getAvatarFileaction.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
resizeUnsavedAvatarFileaction.Parameters: - handle – handle (type:
string) - width – width (type:
int) - height – height (type:
int)
- handle – handle (type:
-
-
class
workfront.versions.unsupported.AwaitingApproval(session=None, **fields)¶ ObjectforAWAPVL-
get_my_awaiting_approvals_count()¶ The
getMyAwaitingApprovalsCountaction.Returns: java.lang.Integer
-
get_my_awaiting_approvals_filtered_count(object_type=None)¶ The
getMyAwaitingApprovalsFilteredCountaction.Parameters: object_type – objectType (type: string)Returns: java.lang.Integer
-
get_my_submitted_awaiting_approvals_count()¶ The
getMySubmittedAwaitingApprovalsCountaction.Returns: java.lang.Integer
-
-
class
workfront.versions.unsupported.BackgroundJob(session=None, **fields)¶ ObjectforBKGJOB-
can_enqueue_export()¶ The
canEnqueueExportaction.Returns: java.lang.Boolean
-
file_for_completed_job(increase_access_count=None)¶ The
fileForCompletedJobaction.Parameters: increase_access_count – increaseAccessCount (type: boolean)Returns: string
-
migrate_journal_field_wild_card()¶ The
migrateJournalFieldWildCardaction.Returns: string
-
migrate_ppmto_anaconda()¶ The
migratePPMToAnacondaaction.Returns: string
-
running_jobs_count(handler_class_name=None)¶ The
runningJobsCountaction.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
startKickStartDownloadaction.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)¶ ObjectforBLIN-
baseline_tasks¶ CollectionforbaselineTasks
-
-
class
workfront.versions.unsupported.BillingRecord(session=None, **fields)¶ ObjectforBILL-
billable_tasks¶ CollectionforbillableTasks
-
expenses¶ Collectionforexpenses
-
hours¶ Collectionforhours
-
-
class
workfront.versions.unsupported.CalendarInfo(session=None, **fields)¶ ObjectforCALEND-
access_rules¶ CollectionforaccessRules
-
calendar_sections¶ CollectionforcalendarSections
-
create_first_calendar()¶ The
createFirstCalendaraction.Returns: string
-
create_project_section(project_id=None, color=None)¶ The
createProjectSectionaction.Parameters: - project_id – projectID (type:
string) - color – color (type:
string)
Returns: string- project_id – projectID (type:
-
security_ancestors¶ CollectionforsecurityAncestors
-
-
class
workfront.versions.unsupported.CalendarPortalSection(session=None, **fields)¶ ObjectforCALPTL
-
class
workfront.versions.unsupported.CalendarSection(session=None, **fields)¶ ObjectforCALSEC-
calendar_events¶ CollectionforcalendarEvents
-
callable_expressions¶ CollectionforcallableExpressions
-
filters¶ Collectionforfilters
-
get_concatenated_expression_form(expression=None)¶ The
getConcatenatedExpressionFormaction.Parameters: expression – expression (type: string)Returns: string
-
get_pretty_expression_form(expression=None)¶ The
getPrettyExpressionFormaction.Parameters: expression – expression (type: string)Returns: string
-
-
class
workfront.versions.unsupported.CallableExpression(session=None, **fields)¶ ObjectforCALEXP-
validate_callable_expression(custom_expression=None)¶ The
validateCallableExpressionaction.Parameters: custom_expression – customExpression (type: string)
-
-
class
workfront.versions.unsupported.Category(session=None, **fields)¶ ObjectforCTGY-
access_rules¶ CollectionforaccessRules
-
assign_categories(obj_id=None, obj_code=None, category_ids=None)¶ The
assignCategoriesaction.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
assignCategoryaction.Parameters: - obj_id – objID (type:
string) - obj_code – objCode (type:
string) - category_id – categoryID (type:
string)
- obj_id – objID (type:
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
category_access_rules¶ CollectionforcategoryAccessRules
-
category_cascade_rules¶ CollectionforcategoryCascadeRules
-
category_parameters¶ CollectionforcategoryParameters
-
get_expression_types()¶ The
getExpressionTypesaction.Returns: map
-
get_filtered_categories(obj_code=None, object_id=None, object_map=None)¶ The
getFilteredCategoriesaction.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
getFormulaCalculatedExpressionaction.Parameters: custom_expression – customExpression (type: string)Returns: string
-
get_friendly_calculated_expression(custom_expression=None)¶ The
getFriendlyCalculatedExpressionaction.Parameters: custom_expression – customExpression (type: string)Returns: string
-
other_groups¶ CollectionforotherGroups
-
reorder_categories(obj_id=None, obj_code=None, category_ids=None)¶ The
reorderCategoriesaction.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
unassignCategoriesaction.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
unassignCategoryaction.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
updateCalculatedParameterValuesaction.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
validateCustomExpressionaction.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)¶ ObjectforCTCSRL-
category_cascade_rule_matches¶ CollectionforcategoryCascadeRuleMatches
-
-
class
workfront.versions.unsupported.CategoryCascadeRuleMatch(session=None, **fields)¶ ObjectforCTCSRM
-
class
workfront.versions.unsupported.CategoryParameter(session=None, **fields)¶ ObjectforCTGYPAFieldforrowShared
-
class
workfront.versions.unsupported.CategoryParameterExpression(session=None, **fields)¶ ObjectforCTGPEX
-
class
workfront.versions.unsupported.Company(session=None, **fields)¶ ObjectforCMPY-
add_early_access(ids=None)¶ The
addEarlyAccessaction.Parameters: ids – ids (type: string[])
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
delete_early_access(ids=None)¶ The
deleteEarlyAccessaction.Parameters: ids – ids (type: string[])
-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
rates¶ Collectionforrates
-
-
class
workfront.versions.unsupported.CustomEnum(session=None, **fields)¶ ObjectforCSTEM-
custom_enum_orders¶ CollectionforcustomEnumOrders
-
get_default_op_task_priority_enum()¶ The
getDefaultOpTaskPriorityEnumaction.Returns: java.lang.Integer
-
get_default_project_status_enum()¶ The
getDefaultProjectStatusEnumaction.Returns: string
-
get_default_severity_enum()¶ The
getDefaultSeverityEnumaction.Returns: java.lang.Integer
-
get_default_task_priority_enum()¶ The
getDefaultTaskPriorityEnumaction.Returns: java.lang.Integer
-
get_enum_color(enum_class=None, enum_obj_code=None, value=None)¶ The
getEnumColoraction.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
setCustomEnumsaction.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)¶ ObjectforCSTEMOFieldforisHidden
-
class
workfront.versions.unsupported.CustomMenu(session=None, **fields)¶ ObjectforCSTMNUCollectionforchildrenMenus
FieldformenuObjCode
-
class
workfront.versions.unsupported.CustomMenuCustomMenu(session=None, **fields)¶ ObjectforCMSCMS
-
class
workfront.versions.unsupported.Customer(session=None, **fields)¶ ObjectforCUST-
accept_license_agreement()¶ The
acceptLicenseAgreementaction.
-
access_levels¶ CollectionforaccessLevels
-
access_scopes¶ CollectionforaccessScopes
-
app_events¶ CollectionforappEvents
-
approval_processes¶ CollectionforapprovalProcesses
-
categories¶ Collectionforcategories
-
check_license_expiration()¶ The
checkLicenseExpirationaction.Returns: java.lang.Integer
-
custom_enums¶ CollectionforcustomEnums
CollectionforcustomMenus
-
custom_quarters¶ CollectionforcustomQuarters
-
custom_tabs¶ CollectionforcustomTabs
-
customer_prefs¶ CollectionforcustomerPrefs
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
email_templates¶ CollectionforemailTemplates
-
event_handlers¶ CollectionforeventHandlers
-
expense_types¶ CollectionforexpenseTypes
-
external_sections¶ CollectionforexternalSections
-
get_license_info()¶ The
getLicenseInfoaction.Returns: map
-
groups¶ Collectionforgroups
-
hour_types¶ CollectionforhourTypes
-
import_templates¶ CollectionforimportTemplates
-
installed_dditems¶ CollectionforinstalledDDItems
-
ip_ranges¶ CollectionforipRanges
-
is_biz_rule_exclusion_enabled(biz_rule=None, obj_code=None, obj_id=None)¶ The
isBizRuleExclusionEnabledaction.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
isSSOEnabledaction.Returns: java.lang.Boolean
-
journal_fields¶ CollectionforjournalFields
-
layout_templates¶ CollectionforlayoutTemplates
-
license_orders¶ CollectionforlicenseOrders
-
migrate_to_lucid_security(migration_mode=None, migration_options=None)¶ The
migrateToLucidSecurityaction.Parameters: - migration_mode – migrationMode (type:
com.attask.common.constants.LucidMigrationModeEnum) - migration_options – migrationOptions (type:
map)
Returns: string- migration_mode – migrationMode (type:
-
milestone_paths¶ CollectionformilestonePaths
-
parameter_groups¶ CollectionforparameterGroups
-
parameters¶ Collectionforparameters
-
portal_profiles¶ CollectionforportalProfiles
-
portal_sections¶ CollectionforportalSections
-
reset_lucid_security_migration_progress()¶ The
resetLucidSecurityMigrationProgressaction.
-
resource_pools¶ CollectionforresourcePools
-
revert_lucid_security_migration()¶ The
revertLucidSecurityMigrationaction.
-
risk_types¶ CollectionforriskTypes
-
roles¶ Collectionforroles
-
schedules¶ Collectionforschedules
-
score_cards¶ CollectionforscoreCards
-
set_exclusions(exclusions=None, state=None)¶ The
setExclusionsaction.Parameters: - exclusions – exclusions (type:
string) - state – state (type:
boolean)
- exclusions – exclusions (type:
-
set_is_custom_quarter_enabled(is_custom_quarter_enabled=None)¶ The
setIsCustomQuarterEnabledaction.Parameters: is_custom_quarter_enabled – isCustomQuarterEnabled (type: boolean)
-
set_is_white_list_ipenabled(is_white_list_ipenabled=None)¶ The
setIsWhiteListIPEnabledaction.Parameters: is_white_list_ipenabled – isWhiteListIPEnabled (type: boolean)
-
set_lucid_migration_enabled(enabled=None)¶ The
setLucidMigrationEnabledaction.Parameters: enabled – enabled (type: boolean)
-
timed_notifications¶ CollectionfortimedNotifications
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
update_currency(base_currency=None)¶ The
updateCurrencyaction.Parameters: base_currency – baseCurrency (type: string)
-
update_customer_base(time_zone=None, locale=None, admin_acct_name=None)¶ The
updateCustomerBaseaction.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
updateProofingBillingPlanaction.Parameters: plan_id – planID (type: string)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.CustomerPreferences(session=None, **fields)¶ ObjectforCUSTPR-
set_preference(name=None, value=None)¶ The
setPreferenceaction.Parameters: - name – name (type:
string) - value – value (type:
string)
- name – name (type:
-
-
class
workfront.versions.unsupported.Document(session=None, **fields)¶ ObjectforDOCU-
access_rules¶ CollectionforaccessRules
-
approvals¶ Collectionforapprovals
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
build_download_manifest(document_idmap=None)¶ The
buildDownloadManifestaction.Parameters: document_idmap – documentIDMap (type: map)Returns: string
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
cancel_document_proof(document_version_id=None)¶ The
cancelDocumentProofaction.Parameters: document_version_id – documentVersionID (type: string)
-
check_document_tasks()¶ The
checkDocumentTasksaction.
-
check_in(document_id=None)¶ The
checkInaction.Parameters: document_id – documentID (type: string)
-
check_out(document_id=None)¶ The
checkOutaction.Parameters: document_id – documentID (type: string)
-
copy_document_to_temp_dir(document_id=None)¶ The
copyDocumentToTempDiraction.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
createDocumentaction.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
createProofaction.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
deleteDocumentProofsaction.Parameters: document_id – documentID (type: string)
-
folders¶ Collectionforfolders
-
get_advanced_proof_options_url()¶ The
getAdvancedProofOptionsURLaction.Returns: string
-
get_document_contents_in_zip()¶ The
getDocumentContentsInZipaction.Returns: string
-
get_external_document_contents()¶ The
getExternalDocumentContentsaction.Returns: string
-
get_generic_thumbnail_url(document_version_id=None)¶ The
getGenericThumbnailUrlaction.Parameters: document_version_id – documentVersionID (type: string)Returns: string
-
get_proof_details(document_version_id=None)¶ The
getProofDetailsaction.Parameters: document_version_id – documentVersionID (type: string)Returns: map
-
get_proof_details_url(proof_id=None)¶ The
getProofDetailsURLaction.Parameters: proof_id – proofID (type: string)Returns: string
-
get_proof_url()¶ The
getProofURLaction.Returns: string
-
get_proof_usage()¶ The
getProofUsageaction.Returns: map
-
get_public_generic_thumbnail_url(document_version_id=None, public_token=None)¶ The
getPublicGenericThumbnailUrlaction.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
getPublicThumbnailFilePathaction.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
getS3DocumentURLaction.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
getThumbnailDataaction.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
getThumbnailFilePathaction.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
getTotalSizeForDocumentsaction.Parameters: - document_ids – documentIDs (type:
string[]) - include_linked – includeLinked (type:
boolean)
Returns: java.lang.Long- document_ids – documentIDs (type:
-
groups¶ Collectionforgroups
-
handle_proof_callback(callback_xml=None)¶ The
handleProofCallbackaction.Parameters: callback_xml – callbackXML (type: string)
-
is_in_linked_folder(document_id=None)¶ The
isInLinkedFolderaction.Parameters: document_id – documentID (type: string)Returns: java.lang.Boolean
-
is_linked_document(document_id=None)¶ The
isLinkedDocumentaction.Parameters: document_id – documentID (type: string)Returns: java.lang.Boolean
-
is_proof_auto_genration_enabled()¶ The
isProofAutoGenrationEnabledaction.Returns: java.lang.Boolean
-
is_proofable(document_version_id=None)¶ The
isProofableaction.Parameters: document_version_id – documentVersionID (type: string)Returns: java.lang.Boolean
-
move(obj_id=None, doc_obj_code=None)¶ The
moveaction.Parameters: - obj_id – objID (type:
string) - doc_obj_code – docObjCode (type:
string)
- obj_id – objID (type:
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
process_google_drive_change_notification(push_notification=None)¶ The
processGoogleDriveChangeNotificationaction.Parameters: push_notification – pushNotification (type: string)
-
refresh_external_document_info(document_id=None)¶ The
refreshExternalDocumentInfoaction.Parameters: document_id – documentID (type: string)Returns: string
-
refresh_external_documents()¶ The
refreshExternalDocumentsaction.
The
regenerateBoxSharedLinkaction.Parameters: document_version_id – documentVersionID (type: string)
-
remind_requestee(document_request_id=None)¶ The
remindRequesteeaction.Parameters: document_request_id – documentRequestID (type: string)Returns: string
-
save_document_metadata(document_id=None)¶ The
saveDocumentMetadataaction.Parameters: document_id – documentID (type: string)
-
security_ancestors¶ CollectionforsecurityAncestors
-
send_documents_to_external_provider(document_ids=None, provider_id=None, destination_folder_id=None)¶ The
sendDocumentsToExternalProvideraction.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
setupGoogleDrivePushNotificationsaction.Returns: string
Collectionforshares
-
subscribers¶ Collectionforsubscribers
-
unlink_documents(ids=None)¶ The
unlinkDocumentsaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
upload_documents(document_request_id=None, documents=None)¶ The
uploadDocumentsaction.Parameters: - document_request_id – documentRequestID (type:
string) - documents – documents (type:
string[])
Returns: string[]- document_request_id – documentRequestID (type:
-
versions¶ Collectionforversions
-
zip_document_versions()¶ The
zipDocumentVersionsaction.Returns: string
-
zip_documents(obj_code=None, obj_id=None)¶ The
zipDocumentsaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
Returns: string- obj_code – objCode (type:
-
zip_documents_versions(ids=None)¶ The
zipDocumentsVersionsaction.Parameters: ids – ids (type: string[])Returns: string
-
-
class
workfront.versions.unsupported.DocumentApproval(session=None, **fields)¶ ObjectforDOCAPLReferenceforautoDocumentShare
FieldforautoDocumentShareID
-
notify_approver(id=None)¶ The
notifyApproveraction.Parameters: id – ID (type: string)
-
class
workfront.versions.unsupported.DocumentFolder(session=None, **fields)¶ ObjectforDOCFDR-
children¶ Collectionforchildren
-
delete_folders_and_contents(document_folder_id=None, obj_code=None, object_id=None)¶ The
deleteFoldersAndContentsaction.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¶ Collectionfordocuments
-
get_folder_size_in_bytes(folder_id=None, recursive=None, include_linked=None)¶ The
getFolderSizeInBytesaction.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
getLinkedFolderMetaDataaction.Parameters: linked_folder_id – linkedFolderID (type: string)Returns: string
-
is_linked_folder(document_folder_id=None)¶ The
isLinkedFolderaction.Parameters: document_folder_id – documentFolderID (type: string)Returns: java.lang.Boolean
-
is_smart_folder(document_folder_id=None)¶ The
isSmartFolderaction.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
refreshLinkedFolderaction.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
refreshLinkedFolderContentsaction.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
refreshLinkedFolderMetaDataaction.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
sendFolderToExternalProvideraction.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
unlinkFoldersaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.DocumentProvider(session=None, **fields)¶ ObjectforDOCPRO-
get_all_type_provider_ids(external_integration_type=None, doc_provider_config_id=None)¶ The
getAllTypeProviderIDsaction.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
getProviderWithWriteAccessaction.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)¶ ObjectforDOCCFG
-
class
workfront.versions.unsupported.DocumentProviderMetadata(session=None, **fields)¶ ObjectforDOCMET-
get_metadata_map_for_provider_type(external_integration_type=None)¶ The
getMetadataMapForProviderTypeaction.Parameters: external_integration_type – externalIntegrationType (type: string)Returns: map
-
load_metadata_for_document(document_id=None, external_integration_type=None)¶ The
loadMetadataForDocumentaction.Parameters: - document_id – documentID (type:
string) - external_integration_type – externalIntegrationType (type:
string)
Returns: map- document_id – documentID (type:
-
ObjectforDOCSHRFieldforaccessorIDs
FieldforaccessorObjCode
FieldforaccessorObjID
Referenceforcustomer
FieldforcustomerID
Fieldfordescription
Referencefordocument
FieldfordocumentID
ReferenceforenteredBy
FieldforenteredByID
FieldforentryDate
FieldforisApprover
FieldforisDownload
FieldforisProofer
FieldforlastUpdateDate
ReferenceforlastUpdatedBy
FieldforlastUpdatedByID
The
notifyShareaction.Parameters: id – ID (type: string)
ReferenceforpendingApproval
Referenceforrole
FieldforroleID
Referenceforteam
FieldforteamID
Referenceforuser
FieldforuserID
-
class
workfront.versions.unsupported.DocumentVersion(session=None, **fields)¶ ObjectforDOCV-
add_document_version(document_version_bean=None)¶ The
addDocumentVersionaction.Parameters: document_version_bean – documentVersionBean (type: DocumentVersion)Returns: string
-
file_handle()¶ The
fileHandleaction.Returns: string
-
public_file_handle(version_id=None, public_token=None)¶ The
publicFileHandleaction.Parameters: - version_id – versionID (type:
string) - public_token – publicToken (type:
string)
Returns: string- version_id – versionID (type:
-
remove_document_version(document_version=None)¶ The
removeDocumentVersionaction.Parameters: document_version – documentVersion (type: DocumentVersion)
-
-
class
workfront.versions.unsupported.Email(session=None, **fields)¶ ObjectforEMAILC-
send_test_email(email_address=None, username=None, password=None, host=None, port=None, usessl=None)¶ The
sendTestEmailaction.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
testPopAccountSettingsaction.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)¶ ObjectforEMLTPL-
get_email_subjects(customer_id=None, handler_name_map=None, obj_code=None, obj_id=None, event_type=None)¶ The
getEmailSubjectsaction.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
getHelpDeskRegistrationEmailaction.Parameters: user_id – userID (type: string)Returns: string
-
get_user_invitation_email(user_id=None)¶ The
getUserInvitationEmailaction.Parameters: user_id – userID (type: string)Returns: string
-
-
class
workfront.versions.unsupported.Endorsement(session=None, **fields)¶ ObjectforENDR-
get_liked_endorsement_ids(endorsement_ids=None)¶ The
getLikedEndorsementIDsaction.Parameters: endorsement_ids – endorsementIDs (type: string[])Returns: string[]
-
like()¶ The
likeaction.
-
replies¶ Collectionforreplies
Collectionforshares
-
unlike()¶ The
unlikeaction.
-
ObjectforENDSHRFieldforaccessorObjCode
FieldforaccessorObjID
Referenceforcustomer
FieldforcustomerID
Referenceforendorsement
FieldforendorsementID
ReferenceforenteredBy
FieldforenteredByID
FieldforentryDate
FieldforlastUpdateDate
ReferenceforlastUpdatedBy
FieldforlastUpdatedByID
Referenceforteam
FieldforteamID
Referenceforuser
FieldforuserID
-
class
workfront.versions.unsupported.EventHandler(session=None, **fields)¶ ObjectforEVNTH-
app_events¶ CollectionforappEvents
FieldforisHidden
-
reset_subjects_to_default(event_handler_ids=None)¶ The
resetSubjectsToDefaultaction.Parameters: event_handler_ids – eventHandlerIDs (type: string[])Returns: string[]
-
set_custom_subject(custom_subjects=None, custom_subject_properties=None)¶ The
setCustomSubjectaction.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)¶ ObjectforEXRATE-
suggest_exchange_rate(base_currency=None, to_currency_code=None)¶ The
suggestExchangeRateaction.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)¶ ObjectforEXPNS-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
move(obj_id=None, exp_obj_code=None)¶ The
moveaction.Parameters: - obj_id – objID (type:
string) - exp_obj_code – expObjCode (type:
string)
- obj_id – objID (type:
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
-
class
workfront.versions.unsupported.ExpenseType(session=None, **fields)¶ ObjectforEXPTYP-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.ExternalDocument(session=None, **fields)¶ ObjectforEXTDOC-
browse_list_with_link_action(provider_type=None, document_provider_id=None, search_params=None, link_action=None)¶ The
browseListWithLinkActionaction.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
getAuthenticationUrlForProvideraction.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
getThumbnailPathaction.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
loadExternalBrowseLocationaction.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
saveExternalBrowseLocationaction.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
showExternalThumbnailsaction.Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.ExternalSection(session=None, **fields)¶ ObjectforEXTSEC-
calculate_url(external_section_id=None, obj_code=None, obj_id=None)¶ The
calculateURLaction.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
calculateURLSaction.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)¶ ObjectforFVRITE-
update_favorite_name(name=None, favorite_id=None)¶ The
updateFavoriteNameaction.Parameters: - name – name (type:
string) - favorite_id – favoriteID (type:
string)
- name – name (type:
-
-
class
workfront.versions.unsupported.Feature(session=None, **fields)¶ ObjectforFEATR-
export()¶ The
exportaction.Returns: string
-
is_enabled(name=None)¶ The
isEnabledaction.Parameters: name – name (type: string)Returns: java.lang.Boolean
-
override_for_session(name=None, value=None)¶ The
overrideForSessionaction.Parameters: - name – name (type:
string) - value – value (type:
boolean)
- name – name (type:
-
-
class
workfront.versions.unsupported.Group(session=None, **fields)¶ ObjectforGROUP-
add_early_access(ids=None)¶ The
addEarlyAccessaction.Parameters: ids – ids (type: string[])
-
check_delete(ids=None)¶ The
checkDeleteaction.Parameters: ids – ids (type: string[])
-
children¶ Collectionforchildren
-
delete_early_access(ids=None)¶ The
deleteEarlyAccessaction.Parameters: ids – ids (type: string[])
-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
replace_delete_groups(ids=None, replace_group_id=None)¶ The
replaceDeleteGroupsaction.Parameters: - ids – ids (type:
string[]) - replace_group_id – replaceGroupID (type:
string)
- ids – ids (type:
-
user_groups¶ CollectionforuserGroups
-
-
class
workfront.versions.unsupported.Hour(session=None, **fields)¶ ObjectforHOUR-
approve()¶ The
approveaction.
-
unapprove()¶ The
unapproveaction.
-
-
class
workfront.versions.unsupported.HourType(session=None, **fields)¶ ObjectforHOURT-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
timesheetprofiles¶ Collectionfortimesheetprofiles
-
users¶ Collectionforusers
-
-
class
workfront.versions.unsupported.ImportTemplate(session=None, **fields)¶ ObjectforITMPL-
import_rows¶ CollectionforimportRows
-
-
class
workfront.versions.unsupported.Issue(session=None, **fields)¶ ObjectforOPTASK-
accept_work()¶ The
acceptWorkaction.
-
access_rules¶ CollectionforaccessRules
-
add_comment(text)¶ Add a comment to the current object containing the supplied text.
The new
Commentinstance is returned, it does not need to be saved.
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
assign(obj_id=None, obj_code=None)¶ The
assignaction.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
assignMultipleaction.Parameters: - user_ids – userIDs (type:
string[]) - role_ids – roleIDs (type:
string[]) - team_id – teamID (type:
string)
- user_ids – userIDs (type:
-
assignments¶ Collectionforassignments
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
convert_to_project(project=None, exchange_rate=None, options=None)¶ The
convertToProjectaction.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.
FieldfordisplayQueueBreadcrumb
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
hours¶ Collectionforhours
-
mark_done(status=None)¶ The
markDoneaction.Parameters: status – status (type: string)
-
mark_not_done(assignment_id=None)¶ The
markNotDoneaction.Parameters: assignment_id – assignmentID (type: string)
-
move(project_id=None)¶ The
moveaction.Parameters: project_id – projectID (type: string)
-
move_to_task(project_id=None, parent_id=None)¶ The
moveToTaskaction.Parameters: - project_id – projectID (type:
string) - parent_id – parentID (type:
string)
- project_id – projectID (type:
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
FieldforqueueTopicBreadcrumb
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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
replyToAssignmentaction.Parameters: - note_text – noteText (type:
string) - commit_date – commitDate (type:
dateTime)
- note_text – noteText (type:
-
resolvables¶ Collectionforresolvables
-
security_ancestors¶ CollectionforsecurityAncestors
-
timed_notifications(notification_ids=None)¶ The
timedNotificationsaction.Parameters: notification_ids – notificationIDs (type: string[])
-
unaccept_work()¶ The
unacceptWorkaction.
-
unassign(user_id=None)¶ The
unassignaction.Parameters: user_id – userID (type: string)
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.Iteration(session=None, **fields)¶ ObjectforITRN-
assign_iteration_to_descendants(task_ids=None, iteration_id=None)¶ The
assignIterationToDescendantsaction.Parameters: - task_ids – taskIDs (type:
string[]) - iteration_id – iterationID (type:
string)
- task_ids – taskIDs (type:
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
legacy_burndown_info_with_percentage(iteration_id=None)¶ The
legacyBurndownInfoWithPercentageaction.Parameters: iteration_id – iterationID (type: string)Returns: map
-
legacy_burndown_info_with_points(iteration_id=None)¶ The
legacyBurndownInfoWithPointsaction.Parameters: iteration_id – iterationID (type: string)Returns: map
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
-
class
workfront.versions.unsupported.JournalEntry(session=None, **fields)¶ ObjectforJRNLEReferencefordocumentShare
FieldfordocumentShareID
-
edit_field_names(parameter_id=None, field_name=None)¶ The
editFieldNamesaction.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
getLikedJournalEntryIDsaction.Parameters: journal_entry_ids – journalEntryIDs (type: string[])Returns: string[]
-
like()¶ The
likeaction.
-
replies¶ Collectionforreplies
-
unlike()¶ The
unlikeaction.
-
class
workfront.versions.unsupported.JournalField(session=None, **fields)¶ ObjectforJRNLF-
migrate_wild_card_journal_fields()¶ The
migrateWildCardJournalFieldsaction.
-
set_journal_fields_for_obj_code(obj_code=None, messages=None)¶ The
setJournalFieldsForObjCodeaction.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)¶ ObjectforKSS-
import_kick_start(file_handle=None, file_type=None)¶ The
importKickStartaction.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)¶ ObjectforLYTMPL-
clear_all_custom_tabs(reset_default_nav=None, reset_nav_items=None)¶ The
clearAllCustomTabsaction.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
clearAllUserCustomTabsaction.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
clearPPMigrationFlagaction.
-
clear_user_custom_tabs(user_ids=None, reset_default_nav=None, reset_nav_items=None, layout_page_types=None)¶ The
clearUserCustomTabsaction.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:
FieldfordefaultNavItem
-
get_layout_template_cards_by_card_location(layout_template_id=None, card_location=None)¶ The
getLayoutTemplateCardsByCardLocationaction.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
getLayoutTemplateUsersaction.Parameters: layout_template_ids – layoutTemplateIDs (type: string[])Returns: string[]
-
layout_template_cards¶ CollectionforlayoutTemplateCards
-
layout_template_date_preferences¶ CollectionforlayoutTemplateDatePreferences
-
layout_template_pages¶ CollectionforlayoutTemplatePages
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
migrate_portal_profile(portal_profile_ids=None)¶ The
migratePortalProfileaction.Parameters: portal_profile_ids – portalProfileIDs (type: string[])Returns: map
FieldfornavBar
FieldfornavItems
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
-
class
workfront.versions.unsupported.LayoutTemplateDatePreference(session=None, **fields)¶ ObjectforLTMPDP
-
class
workfront.versions.unsupported.MasterTask(session=None, **fields)¶ ObjectforMTSK-
assignments¶ Collectionforassignments
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
expenses¶ Collectionforexpenses
-
groups¶ Collectionforgroups
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
-
class
workfront.versions.unsupported.MilestonePath(session=None, **fields)¶ ObjectforMPATH-
groups¶ Collectionforgroups
-
milestones¶ Collectionformilestones
-
-
class
workfront.versions.unsupported.Note(session=None, **fields)¶ ObjectforNOTE-
add_comment(text)¶ Add a comment to this comment.
The new
Commentinstance 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
addNoteToObjectsaction.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
getLikedNoteIDsaction.Parameters: note_ids – noteIDs (type: string[])Returns: string[]
-
like()¶ The
likeaction.
-
replies¶ Collectionforreplies
Collectionfortags
-
unlike()¶ The
unlikeaction.
-
-
class
workfront.versions.unsupported.Parameter(session=None, **fields)¶ ObjectforPARAM-
parameter_options¶ CollectionforparameterOptions
-
-
class
workfront.versions.unsupported.ParameterOption(session=None, **fields)¶ ObjectforPOPTFieldforisHidden
-
class
workfront.versions.unsupported.PortalProfile(session=None, **fields)¶ ObjectforPTLPFLCollectionforcustomMenus
-
custom_tabs¶ CollectionforcustomTabs
-
portal_sections¶ CollectionforportalSections
-
portal_tabs¶ CollectionforportalTabs
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
class
workfront.versions.unsupported.PortalSection(session=None, **fields)¶ ObjectforPTLSEC-
access_rules¶ CollectionforaccessRules
-
get_pk(obj_code=None)¶ The
getPKaction.Parameters: obj_code – objCode (type: string)Returns: string
-
get_report_from_cache(background_job_id=None)¶ The
getReportFromCacheaction.Parameters: background_job_id – backgroundJobID (type: string)Returns: map
-
is_report_filterable(query_class_obj_code=None, obj_code=None, obj_id=None)¶ The
isReportFilterableaction.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
linkCustomeraction.
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
migrate_portal_sections_ppmto_anaconda()¶ The
migratePortalSectionsPPMToAnacondaaction.
-
portal_tab_sections¶ CollectionforportalTabSections
-
scheduled_reports¶ CollectionforscheduledReports
-
security_ancestors¶ CollectionforsecurityAncestors
-
send_now()¶ The
sendNowaction.
-
unlink_customer()¶ The
unlinkCustomeraction.
-
-
class
workfront.versions.unsupported.PortalTab(session=None, **fields)¶ ObjectforPTLTAB-
access_rules¶ CollectionforaccessRules
-
advanced_copy(new_name=None, advanced_copies=None)¶ The
advancedCopyaction.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
exportDashboardaction.Parameters: - dashboard_exports – dashboardExports (type:
string[]) - dashboard_export_options – dashboardExportOptions (type:
map)
Returns: map- dashboard_exports – dashboardExports (type:
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
migrate_custom_tab_user_prefs(user_ids=None)¶ The
migrateCustomTabUserPrefsaction.Parameters: user_ids – userIDs (type: string[])
-
portal_tab_sections¶ CollectionforportalTabSections
-
-
class
workfront.versions.unsupported.Portfolio(session=None, **fields)¶ ObjectforPORT-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
groups¶ Collectionforgroups
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
programs¶ Collectionforprograms
-
projects¶ Collectionforprojects
-
-
class
workfront.versions.unsupported.Program(session=None, **fields)¶ ObjectforPRGM-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
move(portfolio_id=None, options=None)¶ The
moveaction.Parameters: - portfolio_id – portfolioID (type:
string) - options – options (type:
string[])
- portfolio_id – portfolioID (type:
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
projects¶ Collectionforprojects
-
security_ancestors¶ CollectionforsecurityAncestors
-
-
class
workfront.versions.unsupported.Project(session=None, **fields)¶ ObjectforPROJ-
access_rules¶ CollectionforaccessRules
-
alignment_values¶ CollectionforalignmentValues
-
all_hours¶ CollectionforallHours
-
all_priorities¶ CollectionforallPriorities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
async_delete(projects_to_delete=None, force=None)¶ The
asyncDeleteaction.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
attachTemplateaction.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
attachTemplateWithParameterValuesaction.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¶ CollectionforawaitingApprovals
-
baselines¶ Collectionforbaselines
-
billing_records¶ CollectionforbillingRecords
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
calculate_finance()¶ The
calculateFinanceaction.
-
calculate_project_score_values(type=None)¶ The
calculateProjectScoreValuesaction.Parameters: type – type (type: com.attask.common.constants.ScoreCardTypeEnum)
-
calculate_timeline()¶ The
calculateTimelineaction.
-
create_project_with_override(project=None, exchange_rate=None)¶ The
createProjectWithOverrideaction.Parameters: - project – project (type:
Project) - exchange_rate – exchangeRate (type:
ExchangeRate)
Returns: string- project – project (type:
-
deliverable_values¶ CollectionfordeliverableValues
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
exchange_rates¶ CollectionforexchangeRates
-
expenses¶ Collectionforexpenses
-
export_as_msproject_file()¶ The
exportAsMSProjectFileaction.Returns: string
-
export_business_case()¶ The
exportBusinessCaseaction.Returns: string
-
get_help_desk_user_can_add_issue()¶ The
getHelpDeskUserCanAddIssueaction.Returns: java.lang.Boolean
-
get_project_currency()¶ The
getProjectCurrencyaction.Returns: string
-
hour_types¶ CollectionforhourTypes
-
hours¶ Collectionforhours
-
import_msproject_file(file_handle=None, project_name=None)¶ The
importMSProjectFileaction.Parameters: - file_handle – fileHandle (type:
string) - project_name – projectName (type:
string)
Returns: string- file_handle – fileHandle (type:
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
open_op_tasks¶ CollectionforopenOpTasks
-
parameter_values¶ CollectionforparameterValues
-
project_user_roles¶ CollectionforprojectUserRoles
-
project_users¶ CollectionforprojectUsers
-
rates¶ Collectionforrates
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, approval_username=None, approval_password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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
removeUsersFromProjectaction.Parameters: user_ids – userIDs (type: string[])
-
resolvables¶ Collectionforresolvables
-
resource_allocations¶ CollectionforresourceAllocations
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
save_project_as_template(template_name=None, exclude_ids=None, options=None)¶ The
saveProjectAsTemplateaction.Parameters: - template_name – templateName (type:
string) - exclude_ids – excludeIDs (type:
string[]) - options – options (type:
string[])
Returns: string- template_name – templateName (type:
-
security_ancestors¶ CollectionforsecurityAncestors
-
set_budget_to_schedule()¶ The
setBudgetToScheduleaction.
-
tasks¶ Collectionfortasks
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.QueueDef(session=None, **fields)¶ ObjectforQUED-
object_categories¶ CollectionforobjectCategories
-
queue_topics¶ CollectionforqueueTopics
FieldforshareMode
-
-
class
workfront.versions.unsupported.QueueTopic(session=None, **fields)¶ ObjectforQUET-
object_categories¶ CollectionforobjectCategories
-
-
class
workfront.versions.unsupported.QueueTopicGroup(session=None, **fields)¶ ObjectforQUETGP-
queue_topic_groups¶ CollectionforqueueTopicGroups
-
queue_topics¶ CollectionforqueueTopics
-
-
class
workfront.versions.unsupported.Recent(session=None, **fields)¶ ObjectforRECENT-
update_last_viewed_object()¶ The
updateLastViewedObjectaction.Returns: string
-
-
class
workfront.versions.unsupported.RecentMenuItem(session=None, **fields)¶ ObjectforRECENTMENUITEM-
bulk_delete_recent(obj_code=None, obj_ids=None)¶ The
bulkDeleteRecentaction.Parameters: - obj_code – objCode (type:
string) - obj_ids – objIDs (type:
string[])
- obj_code – objCode (type:
-
delete_recent(obj_code=None, obj_id=None)¶ The
deleteRecentaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
- obj_code – objCode (type:
The
rotateRecentMenuaction.Parameters: - obj_code – objCode (type:
string) - obj_id – objID (type:
string)
- obj_code – objCode (type:
-
-
class
workfront.versions.unsupported.RecentUpdate(session=None, **fields)¶ ObjectforRUPDTEFieldforauthorID
FieldforauthorName
FieldforlatestCommentAuthorID
FieldforlatestCommentAuthorName
-
class
workfront.versions.unsupported.Reseller(session=None, **fields)¶ ObjectforRSELR-
account_reps¶ CollectionforaccountReps
-
-
class
workfront.versions.unsupported.ResourcePool(session=None, **fields)¶ ObjectforRSPOOL-
resource_allocations¶ CollectionforresourceAllocations
-
roles¶ Collectionforroles
-
users¶ Collectionforusers
-
-
class
workfront.versions.unsupported.RiskType(session=None, **fields)¶ ObjectforRSKTYP-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.Role(session=None, **fields)¶ ObjectforROLE-
add_early_access(ids=None)¶ The
addEarlyAccessaction.Parameters: ids – ids (type: string[])
-
delete_early_access(ids=None)¶ The
deleteEarlyAccessaction.Parameters: ids – ids (type: string[])
-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.SSOMapping(session=None, **fields)¶ ObjectforSSOMAP-
mapping_rules¶ CollectionformappingRules
-
-
class
workfront.versions.unsupported.SSOOption(session=None, **fields)¶ ObjectforSSOPT-
sso_mappings¶ CollectionforssoMappings
-
upload_saml2metadata(handle=None)¶ The
uploadSAML2Metadataaction.Parameters: handle – handle (type: string)Returns: string
-
upload_ssocertificate(handle=None)¶ The
uploadSSOCertificateaction.Parameters: handle – handle (type: string)
-
-
class
workfront.versions.unsupported.SandboxMigration(session=None, **fields)¶ ObjectforSNDMG-
cancel_scheduled_migration()¶ The
cancelScheduledMigrationaction.
-
migrate_now()¶ The
migrateNowaction.
-
migration_estimate()¶ The
migrationEstimateaction.Returns: map
-
migration_queue_duration()¶ The
migrationQueueDurationaction.Returns: java.lang.Integer
-
schedule_migration(schedule_date=None)¶ The
scheduleMigrationaction.Parameters: schedule_date – scheduleDate (type: dateTime)
-
-
class
workfront.versions.unsupported.Schedule(session=None, **fields)¶ ObjectforSCHED-
get_earliest_work_time_of_day(date=None)¶ The
getEarliestWorkTimeOfDayaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
get_latest_work_time_of_day(date=None)¶ The
getLatestWorkTimeOfDayaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
get_next_completion_date(date=None, cost_in_minutes=None)¶ The
getNextCompletionDateaction.Parameters: - date – date (type:
dateTime) - cost_in_minutes – costInMinutes (type:
int)
Returns: dateTime- date – date (type:
-
get_next_start_date(date=None)¶ The
getNextStartDateaction.Parameters: date – date (type: dateTime)Returns: dateTime
-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
non_work_days¶ CollectionfornonWorkDays
-
other_groups¶ CollectionforotherGroups
-
-
class
workfront.versions.unsupported.ScheduledReport(session=None, **fields)¶ ObjectforSCHREP-
groups¶ Collectionforgroups
-
roles¶ Collectionforroles
-
send_report_delivery_now(user_ids=None, team_ids=None, group_ids=None, role_ids=None, external_emails=None, delivery_options=None)¶ The
sendReportDeliveryNowaction.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¶ Collectionforteams
-
users¶ Collectionforusers
-
-
class
workfront.versions.unsupported.ScoreCard(session=None, **fields)¶ ObjectforSCORE-
score_card_questions¶ CollectionforscoreCardQuestions
-
-
class
workfront.versions.unsupported.ScoreCardOption(session=None, **fields)¶ ObjectforSCOPTFieldforisHidden
-
class
workfront.versions.unsupported.ScoreCardQuestion(session=None, **fields)¶ ObjectforSCOREQ-
score_card_options¶ CollectionforscoreCardOptions
-
-
class
workfront.versions.unsupported.Task(session=None, **fields)¶ ObjectforTASK-
accept_work()¶ The
acceptWorkaction.
-
access_rules¶ CollectionforaccessRules
-
add_comment(text)¶ Add a comment to the current object containing the supplied text.
The new
Commentinstance is returned, it does not need to be saved.
-
all_priorities¶ CollectionforallPriorities
-
all_statuses¶ CollectionforallStatuses
-
approve_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
approveApprovalaction.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¶ CollectionforapproverStatuses
-
assign(obj_id=None, obj_code=None)¶ The
assignaction.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
assignMultipleaction.Parameters: - user_ids – userIDs (type:
string[]) - role_ids – roleIDs (type:
string[]) - team_id – teamID (type:
string)
- user_ids – userIDs (type:
-
assignments¶ Collectionforassignments
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
bulk_copy(task_ids=None, project_id=None, parent_id=None, options=None)¶ The
bulkCopyaction.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
bulkMoveaction.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
calculateDataExtensionaction.
-
calculate_data_extensions(ids=None)¶ The
calculateDataExtensionsaction.Parameters: ids – ids (type: string[])
-
children¶ Collectionforchildren
-
convert_to_project(project=None, exchange_rate=None)¶ The
convertToProjectaction.Parameters: - project – project (type:
Project) - exchange_rate – exchangeRate (type:
ExchangeRate)
Returns: string- project – project (type:
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
expenses¶ Collectionforexpenses
-
hours¶ Collectionforhours
-
mark_done(status=None)¶ The
markDoneaction.Parameters: status – status (type: string)
-
mark_not_done(assignment_id=None)¶ The
markNotDoneaction.Parameters: assignment_id – assignmentID (type: string)
-
move(project_id=None, parent_id=None, options=None)¶ The
moveaction.Parameters: - project_id – projectID (type:
string) - parent_id – parentID (type:
string) - options – options (type:
string[])
- project_id – projectID (type:
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
parameter_values¶ CollectionforparameterValues
-
predecessors¶ Collectionforpredecessors
-
recall_approval()¶ The
recallApprovalaction.
-
reject_approval(user_id=None, username=None, password=None, audit_note=None, audit_user_ids=None, send_note_as_email=None)¶ The
rejectApprovalaction.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
replyToAssignmentaction.Parameters: - note_text – noteText (type:
string) - commit_date – commitDate (type:
dateTime)
- note_text – noteText (type:
-
resolvables¶ Collectionforresolvables
-
security_ancestors¶ CollectionforsecurityAncestors
-
successors¶ Collectionforsuccessors
-
timed_notifications(notification_ids=None)¶ The
timedNotificationsaction.Parameters: notification_ids – notificationIDs (type: string[])
-
unaccept_work()¶ The
unacceptWorkaction.
-
unassign(user_id=None)¶ The
unassignaction.Parameters: user_id – userID (type: string)
-
unassign_occurrences(user_id=None)¶ The
unassignOccurrencesaction.Parameters: user_id – userID (type: string)Returns: string[]
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.Team(session=None, **fields)¶ ObjectforTEAMOB-
add_early_access(ids=None)¶ The
addEarlyAccessaction.Parameters: ids – ids (type: string[])
-
backlog_tasks¶ CollectionforbacklogTasks
-
delete_early_access(ids=None)¶ The
deleteEarlyAccessaction.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
moveTasksOnTeamBacklogaction.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¶ CollectionforteamMemberRoles
-
team_members¶ CollectionforteamMembers
-
updates¶ Collectionforupdates
-
users¶ Collectionforusers
-
-
class
workfront.versions.unsupported.Template(session=None, **fields)¶ ObjectforTMPL-
access_rule_preferences¶ CollectionforaccessRulePreferences
-
access_rules¶ CollectionforaccessRules
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
calculate_timeline()¶ The
calculateTimelineaction.Returns: string
-
deliverable_values¶ CollectionfordeliverableValues
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
expenses¶ Collectionforexpenses
-
get_template_currency()¶ The
getTemplateCurrencyaction.Returns: string
-
groups¶ Collectionforgroups
-
hour_types¶ CollectionforhourTypes
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
rates¶ Collectionforrates
-
remove_users_from_template(user_ids=None)¶ The
removeUsersFromTemplateaction.Parameters: user_ids – userIDs (type: string[])
-
risks¶ Collectionforrisks
-
roles¶ Collectionforroles
-
routing_rules¶ CollectionforroutingRules
-
set_access_rule_preferences(access_rule_preferences=None)¶ The
setAccessRulePreferencesaction.Parameters: access_rule_preferences – accessRulePreferences (type: string[])
-
template_tasks¶ CollectionfortemplateTasks
-
template_user_roles¶ CollectionfortemplateUserRoles
-
template_users¶ CollectionfortemplateUsers
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.TemplateTask(session=None, **fields)¶ ObjectforTTSK-
assign_multiple(user_ids=None, role_ids=None, team_id=None)¶ The
assignMultipleaction.Parameters: - user_ids – userIDs (type:
string[]) - role_ids – roleIDs (type:
string[]) - team_id – teamID (type:
string)
- user_ids – userIDs (type:
-
assignments¶ Collectionforassignments
-
bulk_copy(template_id=None, template_task_ids=None, parent_template_task_id=None, options=None)¶ The
bulkCopyaction.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
bulkMoveaction.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
calculateDataExtensionaction.
-
children¶ Collectionforchildren
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
expenses¶ Collectionforexpenses
-
move(template_id=None, parent_id=None, options=None)¶ The
moveaction.Parameters: - template_id – templateID (type:
string) - parent_id – parentID (type:
string) - options – options (type:
string[])
- template_id – templateID (type:
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
predecessors¶ Collectionforpredecessors
-
successors¶ Collectionforsuccessors
-
timed_notifications(notification_ids=None)¶ The
timedNotificationsaction.Parameters: notification_ids – notificationIDs (type: string[])
-
-
class
workfront.versions.unsupported.Timesheet(session=None, **fields)¶ ObjectforTSHET-
approvers¶ Collectionforapprovers
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
hours¶ Collectionforhours
-
notification_records¶ CollectionfornotificationRecords
-
pin_timesheet_object(user_id=None, obj_code=None, obj_id=None)¶ The
pinTimesheetObjectaction.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
unpinTimesheetObjectaction.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)¶ ObjectforTSPRO-
approvers¶ Collectionforapprovers
-
generate_customer_timesheets(obj_ids=None)¶ The
generateCustomerTimesheetsaction.Parameters: obj_ids – objIDs (type: string[])
-
has_reference(ids=None)¶ The
hasReferenceaction.Parameters: ids – ids (type: string[])Returns: java.lang.Boolean
-
hour_types¶ CollectionforhourTypes
-
notification_records¶ CollectionfornotificationRecords
-
-
class
workfront.versions.unsupported.UIFilter(session=None, **fields)¶ ObjectforUIFT-
access_rules¶ CollectionforaccessRules
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
un_link_users(filter_id=None, linked_user_ids=None)¶ The
unLinkUsersaction.Parameters: - filter_id – filterID (type:
string) - linked_user_ids – linkedUserIDs (type:
string[])
- filter_id – filterID (type:
-
users¶ Collectionforusers
-
-
class
workfront.versions.unsupported.UIGroupBy(session=None, **fields)¶ ObjectforUIGB-
access_rules¶ CollectionforaccessRules
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
un_link_users(group_id=None, linked_user_ids=None)¶ The
unLinkUsersaction.Parameters: - group_id – groupID (type:
string) - linked_user_ids – linkedUserIDs (type:
string[])
- group_id – groupID (type:
-
-
class
workfront.versions.unsupported.UIView(session=None, **fields)¶ ObjectforUIVW-
access_rules¶ CollectionforaccessRules
-
expand_view_aliases(obj_code=None, definition=None)¶ The
expandViewAliasesaction.Parameters: - obj_code – objCode (type:
string) - definition – definition (type:
map)
Returns: map- obj_code – objCode (type:
-
get_view_fields()¶ The
getViewFieldsaction.Returns: string[]
-
linked_roles¶ CollectionforlinkedRoles
-
linked_teams¶ CollectionforlinkedTeams
-
linked_users¶ CollectionforlinkedUsers
-
migrate_uiviews_ppmto_anaconda()¶ The
migrateUIViewsPPMToAnacondaaction.
-
un_link_users(view_id=None, linked_user_ids=None)¶ The
unLinkUsersaction.Parameters: - view_id – viewID (type:
string) - linked_user_ids – linkedUserIDs (type:
string[])
- view_id – viewID (type:
-
-
class
workfront.versions.unsupported.Update(session=None, **fields)¶ ObjectforUPDATE-
audit_session_count(user_id=None, target_user_id=None, start_date=None, end_date=None)¶ The
auditSessionCountaction.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¶ CollectionforcombinedUpdates
-
get_update_types_for_stream(stream_type=None)¶ The
getUpdateTypesForStreamaction.Parameters: stream_type – streamType (type: string)Returns: string[]
-
has_updates_before_date(obj_code=None, obj_id=None, date=None)¶ The
hasUpdatesBeforeDateaction.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
isValidUpdateNoteaction.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¶ CollectionformessageArgs
-
nested_updates¶ CollectionfornestedUpdates
-
replies¶ Collectionforreplies
-
sub_message_args¶ CollectionforsubMessageArgs
-
update_obj¶ The object referenced by this update.
-
-
class
workfront.versions.unsupported.User(session=None, **fields)¶ ObjectforUSER-
access_rule_preferences¶ CollectionforaccessRulePreferences
-
add_customer_feedback_improvement(is_better=None, comment=None)¶ The
addCustomerFeedbackImprovementaction.Parameters: - is_better – isBetter (type:
boolean) - comment – comment (type:
string)
- is_better – isBetter (type:
-
add_customer_feedback_score_rating(score=None, comment=None)¶ The
addCustomerFeedbackScoreRatingaction.Parameters: - score – score (type:
int) - comment – comment (type:
string)
- score – score (type:
-
add_early_access(ids=None)¶ The
addEarlyAccessaction.Parameters: ids – ids (type: string[])
-
add_external_user(email_addr=None)¶ The
addExternalUseraction.Parameters: email_addr – emailAddr (type: string)Returns: string
-
add_mobile_device(token=None, device_type=None)¶ The
addMobileDeviceaction.Parameters: - token – token (type:
string) - device_type – deviceType (type:
string)
Returns: map- token – token (type:
-
assign_user_token()¶ The
assignUserTokenaction.Returns: string
-
calculate_data_extension()¶ The
calculateDataExtensionaction.
-
check_other_user_early_access()¶ The
checkOtherUserEarlyAccessaction.Returns: java.lang.Boolean
-
clear_access_rule_preferences(obj_code=None)¶ The
clearAccessRulePreferencesaction.Parameters: obj_code – objCode (type: string)
-
clear_api_key()¶ The
clearApiKeyaction.Returns: string
-
complete_external_user_registration(first_name=None, last_name=None, new_password=None)¶ The
completeExternalUserRegistrationaction.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
completeUserRegistrationaction.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¶ CollectionforcustomTabs
-
delegations_from¶ CollectionfordelegationsFrom
-
delete_early_access(ids=None)¶ The
deleteEarlyAccessaction.Parameters: ids – ids (type: string[])
-
direct_reports¶ CollectionfordirectReports
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
expire_password()¶ The
expirePasswordaction.
-
external_sections¶ CollectionforexternalSections
-
favorites¶ Collectionforfavorites
-
get_api_key()¶ The
getApiKeyaction.Returns: string
-
get_next_customer_feedback_type()¶ The
getNextCustomerFeedbackTypeaction.Returns: string
-
get_or_add_external_user(email_addr=None)¶ The
getOrAddExternalUseraction.Parameters: email_addr – emailAddr (type: string)Returns: string
-
get_reset_password_token_expired(token=None)¶ The
getResetPasswordTokenExpiredaction.Parameters: token – token (type: string)Returns: java.lang.Boolean
-
has_early_access()¶ The
hasEarlyAccessaction.Returns: java.lang.Boolean
-
hour_types¶ CollectionforhourTypes
-
is_npssurvey_available()¶ The
isNPSSurveyAvailableaction.Returns: java.lang.Boolean
FieldforisSharePointAuthenticated
-
is_username_re_captcha_required()¶ The
isUsernameReCaptchaRequiredaction.Returns: java.lang.Boolean
-
linked_portal_tabs¶ CollectionforlinkedPortalTabs
-
messages¶ Collectionformessages
-
migrate_users_ppmto_anaconda()¶ The
migrateUsersPPMToAnacondaaction.
-
mobile_devices¶ CollectionformobileDevices
-
object_categories¶ CollectionforobjectCategories
-
parameter_values¶ CollectionforparameterValues
-
portal_sections¶ CollectionforportalSections
-
portal_tabs¶ CollectionforportalTabs
-
remove_mobile_device(token=None)¶ The
removeMobileDeviceaction.Parameters: token – token (type: string)Returns: map
-
reserved_times¶ CollectionforreservedTimes
-
reset_password(old_password=None, new_password=None)¶ The
resetPasswordaction.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
retrieveAndStoreOAuth2Tokensaction.Parameters: - state – state (type:
string) - authorization_code – authorizationCode (type:
string)
- state – state (type:
-
retrieve_and_store_oauth_token(oauth_token=None)¶ The
retrieveAndStoreOAuthTokenaction.Parameters: oauth_token – oauth_token (type: string)
-
roles¶ Collectionforroles
-
send_invitation_email()¶ The
sendInvitationEmailaction.
-
set_access_rule_preferences(access_rule_preferences=None)¶ The
setAccessRulePreferencesaction.Parameters: access_rule_preferences – accessRulePreferences (type: string[])
-
submit_npssurvey(data_map=None)¶ The
submitNPSSurveyaction.Parameters: data_map – dataMap (type: map)
-
teams¶ Collectionforteams
-
timesheet_templates¶ CollectionfortimesheetTemplates
-
ui_filters¶ CollectionforuiFilters
-
ui_group_bys¶ CollectionforuiGroupBys
-
ui_views¶ CollectionforuiViews
-
update_next_survey_on_date(next_suvey_date=None)¶ The
updateNextSurveyOnDateaction.Parameters: next_suvey_date – nextSuveyDate (type: dateTime)
-
updates¶ Collectionforupdates
-
user_activities¶ CollectionforuserActivities
-
user_groups¶ CollectionforuserGroups
-
user_pref_values¶ CollectionforuserPrefValues
-
validate_re_captcha(captcha_response=None)¶ The
validateReCaptchaaction.Parameters: captcha_response – captchaResponse (type: string)Returns: java.lang.Boolean
-
watch_list¶ CollectionforwatchList
-
work_items¶ CollectionforworkItems
-
-
class
workfront.versions.unsupported.UserAvailability(session=None, **fields)¶ ObjectforUSRAVL-
delete_duplicate_availability(duplicate_user_availability_ids=None)¶ The
deleteDuplicateAvailabilityaction.Parameters: duplicate_user_availability_ids – duplicateUserAvailabilityIDs (type: string[])
-
get_user_assignments(user_id=None, start_date=None, end_date=None)¶ The
getUserAssignmentsaction.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)¶ ObjectforUSRNOT-
acknowledge()¶ The
acknowledgeaction.Returns: string
-
acknowledge_all()¶ The
acknowledgeAllaction.Returns: string[]
-
acknowledge_many(obj_ids=None)¶ The
acknowledgeManyaction.Parameters: obj_ids – objIDs (type: string[])Returns: string[]
-
add_team_note(team_id=None, obj_code=None, target_id=None, type=None)¶ The
addTeamNoteaction.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
addTeamsNotesaction.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
addUserNoteaction.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
addUsersNotesaction.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:
ReferencefordocumentShare
FieldfordocumentShareID
ReferenceforendorsementShare
FieldforendorsementShareID
-
get_my_notification_last_view_date()¶ The
getMyNotificationLastViewDateaction.Returns: dateTime
-
has_announcement_delete_access()¶ The
hasAnnouncementDeleteAccessaction.Returns: java.lang.Boolean
-
mark_deleted(note_id=None)¶ The
markDeletedaction.Parameters: note_id – noteID (type: string)
-
unacknowledge()¶ The
unacknowledgeaction.
-
unacknowledged_announcement_count()¶ The
unacknowledgedAnnouncementCountaction.Returns: java.lang.Integer
-
unacknowledged_count()¶ The
unacknowledgedCountaction.Returns: java.lang.Integer
-
unmark_deleted(note_id=None)¶ The
unmarkDeletedaction.Parameters: note_id – noteID (type: string)
-
-
class
workfront.versions.unsupported.UserObjectPref(session=None, **fields)¶ ObjectforUSOP-
set(user_id=None, ref_obj_code=None, ref_obj_id=None, name=None, value=None)¶ The
setaction.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)¶ ObjectforUSERPF-
get_inactive_notifications_value(user_id=None)¶ The
getInactiveNotificationsValueaction.Parameters: user_id – userID (type: string)Returns: string
-
set_inactive_notifications_value(user_id=None, value=None)¶ The
setInactiveNotificationsValueaction.Parameters: - user_id – userID (type:
string) - value – value (type:
string)
- user_id – userID (type:
-
-
class
workfront.versions.unsupported.UserResource(session=None, **fields)¶ ObjectforUSERRS-
assignments¶ Collectionforassignments
-
-
class
workfront.versions.unsupported.WhatsNew(session=None, **fields)¶ ObjectforWTSN-
is_whats_new_available(product_toggle=None)¶ The
isWhatsNewAvailableaction.Parameters: product_toggle – productToggle (type: int)Returns: java.lang.Boolean
-
-
class
workfront.versions.unsupported.Work(session=None, **fields)¶ ObjectforWORK-
access_rules¶ CollectionforaccessRules
-
all_priorities¶ CollectionforallPriorities
-
all_severities¶ CollectionforallSeverities
-
all_statuses¶ CollectionforallStatuses
-
approver_statuses¶ CollectionforapproverStatuses
-
assignments¶ Collectionforassignments
-
awaiting_approvals¶ CollectionforawaitingApprovals
-
children¶ Collectionforchildren
FieldfordisplayQueueBreadcrumb
-
document_requests¶ CollectionfordocumentRequests
-
documents¶ Collectionfordocuments
-
done_statuses¶ CollectionfordoneStatuses
-
expenses¶ Collectionforexpenses
-
get_my_accomplishments_count()¶ The
getMyAccomplishmentsCountaction.Returns: java.lang.Integer
-
get_my_work_count()¶ The
getMyWorkCountaction.Returns: java.lang.Integer
-
get_work_requests_count(filters=None)¶ The
getWorkRequestsCountaction.Parameters: filters – filters (type: map)Returns: java.lang.Integer
-
hours¶ Collectionforhours
-
notification_records¶ CollectionfornotificationRecords
-
object_categories¶ CollectionforobjectCategories
-
op_tasks¶ CollectionforopTasks
-
open_op_tasks¶ CollectionforopenOpTasks
-
parameter_values¶ CollectionforparameterValues
-
predecessors¶ Collectionforpredecessors
FieldforqueueTopicBreadcrumb
-
resolvables¶ Collectionforresolvables
-
security_ancestors¶ CollectionforsecurityAncestors
-
successors¶ Collectionforsuccessors
-
team_request_count(filters=None)¶ The
teamRequestCountaction.Parameters: filters – filters (type: map)Returns: java.lang.Integer
-
team_requests_count()¶ The
teamRequestsCountaction.Returns: map
-
updates¶ Collectionforupdates
-
-
class
workfront.versions.unsupported.WorkItem(session=None, **fields)¶ ObjectforWRKITM-
make_top_priority(obj_code=None, assignable_id=None, user_id=None)¶ The
makeTopPriorityaction.Parameters: obj_code – objCode (type: string):param assignable_id : assignableID (type:
string) :param user_id: userID (type:string)
-
mark_viewed()¶ The
markViewedaction.
-
Development¶
This package is developed using continuous integration which can be found here:
https://travis-ci.org/cjw296/python-workfront
The latest development version of the documentation can be found here:
http://python-workfront.readthedocs.org/en/latest/
If you wish to contribute to this project, then you should fork the repository found here:
https://github.com/cjw296/python-workfront/
Once that has been done and you have a checkout, you can follow these instructions to perform various development tasks:
Setting up a virtualenv¶
The recommended way to set up a development environment is to turn your checkout into a virtualenv and then install the package in editable form as follows:
$ virtualenv .
$ bin/pip install -U -e .[test,build]
Running the tests¶
Once you’ve set up a virtualenv, the tests can be run as follows:
$ bin/nosetests
Building the documentation¶
The Sphinx documentation is built by doing the following from the directory containing setup.py:
$ source bin/activate
$ cd docs
$ make html
To check that the description that will be used on PyPI renders properly, do the following:
$ python setup.py --long-description | rst2html.py > desc.html
The resulting desc.html should be checked by opening in a browser.
To check that the README that will be used on GitHub renders properly, do the following:
$ cat README.rst | rst2html.py > readme.html
The resulting readme.html should be checked by opening in a browser.
Making a release¶
To make a release, just update the version in setup.py,
update the change log, tag it
and push to https://github.com/cjw296/python-workfront
and Travis CI should take care of the rest.
Once Travis CI is done, make sure to go to https://readthedocs.org/projects/python-workfront/versions/ and make sure the new release is marked as an Active Version.
Adding a new version of the Workfront API¶
Build the generated module:
$ python -u -m workfront.generate --log-level 0 --version v5.0
Wire in any mixins in the
__init__.pyof the generated package.Wire the new version into
api.rst.
Changes¶
0.8.0 (xx February 2016)¶
- Documentation added.
0.7.0 (17 February 2016)¶
- Add Quickstart and API documentation.
- Add actions to the reflected object model.
- Add a caching later to
workfront.generatefor faster repeated generation of the reflected object model. - Simplify the package and module structure of the reflected object model.
0.6.1 (12 February 2016)¶
- Fix brown bag release that had import errors and didn’t work under Python 3 at all!
0.6.0 (11 February 2016)¶
- Python 3 support added.
0.3.2 (10 February 2016)¶
- Python 2 only release to PyPI.
0.3.0 (10 February 2016)¶
- Re-work of object model to support multiple API versions
- Full test coverage.
0.0dev0 (21 August 2015)¶
- Initial prototype made available on GitHub
License¶
Copyright (c) 2015-2016 Jump Systems LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.