fusetools.pm_tools.Workfront¶
-
class
fusetools.pm_tools.Workfront[source]¶ Bases:
objectFunctions for interacting with Workfront.
Methods
Authenticates a user for a given Workfront login/password.
Retrieves Workfront issues with a given custom field.
Retrieves Workfront projects with a given custom field.
Retrieves Workfront projects in a given project status.
Retrieves Workfront tasks with a name string.
Retrieves Workfront tasks with a given status.
Uploads a file to Workfront.
-
classmethod
wf_login(wf_name, wf_pwd, proxies=None)[source]¶ Authenticates a user for a given Workfront login/password.
- Parameters
wf_name – Workfront username.
wf_pwd – Workfront password.
proxies – Proxies to include on request (Optional).
- Returns
SessionId for authenticated user.
-
classmethod
wf_pull_issues_custom_field(wf_api_key, proxies=None)[source]¶ Retrieves Workfront issues with a given custom field.
- Parameters
proxies – Proxies to include on request (Optional).
wf_api_key – Workfront API key.
- Returns
JSON response for API call.
-
classmethod
wf_pull_projects_custom_field(wf_api_key, proxies=None)[source]¶ Retrieves Workfront projects with a given custom field.
- Parameters
wf_api_key – Workfront API key.
proxies – Proxies to include on request (Optional).
- Returns
JSON response for API call.
-
classmethod
wf_pull_projects_status(status, wf_api_key, proxies=None)[source]¶ Retrieves Workfront projects in a given project status.
- Parameters
status – Project status to search for projects.
wf_api_key – Workfront API key.
proxies – Proxies to include on request (Optional).
- Returns
JSON response for API call.
-
classmethod
wf_pull_tasks_name(name_string, wf_api_key, proxies=None, assignee=False)[source]¶ Retrieves Workfront tasks with a name string.
- Parameters
name_string – String to search tasks for.
wf_api_key – Workfront API Key.
proxies – Proxies to include on request (Optional).
assignee – Additional filter on task assignee name.
- Returns
JSON response for API call.
-
classmethod
wf_pull_tasks_status(status, wf_api_key, proxies=None, assignee=False)[source]¶ Retrieves Workfront tasks with a given status.
- Parameters
status – Workfront status category.
proxies – Proxies to include on request (Optional).
wf_api_key – Workfront API Key.
assignee – Additional filter on task assignee name.
- Returns
JSON response for API call.
-
classmethod
wf_upload_file(wf_api_key, file, file_path, obj_id, obj_type, proxies=None)[source]¶ Uploads a file to Workfront.
- Parameters
wf_api_key – Workfront API Key
file – Name of file to upload.
file_path – Name of filepath for file to upload.
obj_id – Id of Workfront object to upload file to.
obj_type – Type of object to upload on Workfront.
proxies – Proxies to include on request (Optional).
- Returns
JSON response for API call.
-
classmethod