ĆŪ¶¹ŹÓʵ

Select the type of Workfront record that you want the module to watch.

For example, select Task if you want to start executing the scenario each time a record field is updated in a task.

(Displays after you choose a Filter.) Select the type of Workfront record that you want the module to watch.

For example, if you want to start the scenario each time a new Project is created, select Project

Enter the object's ID.

Note: When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

If you are converting to a project, select the Template ID that you want to use for the project.

Note: When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

Select the type of Workfront record that you want the module to create.

For example, if you want to create a Project, select Project from the dropdown list and then make sure that you have access to data (from previous modules in the scenario) that will populate the project.

Select the fields that you want available for data input. This allows you to use these fields without having to scroll through the ones you don't need.

For fields in custom forms, use the Attach Custom Form field.

• When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

• When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

  For more information on rich text in updates, see Add an update to a work item in Update work.

Select the type of Workfront record that you want the module to create.

For example, if you want to create a Project, select Project from the dropdown list and then make sure that you have access to data (from previous modules in the scenario) that will populate the project.

• When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

• When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

  For more information on rich text in updates, see Add an update to a work item in Update work.

Add the headers of the request in the form of a standard JSON object. This determines the content type of the request.

For example, {"Content-type":"application/json"}

Note: If you're getting errors and it's difficult to determine their origin, consider modifying headers based on the Workfront documentation. If your Custom API Call returns a 422 HTTP Request Error, try using a "Content-Type":"text/plain" header.

Add the query for the API call in the form of a standard JSON object.

For example: {"name":"something-urgent"}

Tip: We recommend that you send information through the JSON body rather than as query parameters.

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Enter the unique Workfront ID of the record that you want the module to delete.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

1. Delete the record synchronously.
2. Add error handling to the Delete Record module to Ignore the error caused by the 40 second timeout.

Map or manually enter the unique Workfront ID of the document that you want the module to download.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

Select the action you want the module to perform.

You may need to fill out additional fields, depending on the Record Type and Action you choose. Some combinations of these two settings may require only a record ID, while others (such as Project for the Record Type and Attach Template for the Action) require additional information (such as an Object ID and a Template ID).

For options available to some actions, see Misc action options in this article.

For details about individual fields, see the .

Note: The developer documentation site includes information only through API version 14, but still contains valuable information for API calls.

1. Select the record type from the left navigation on the Workfront developer documentation page. The following types have their own pages:

   • Projects

   • Tasks

   • Issues

   • Users

   • Documents

   For all other record types, select Other objects and endpoints, and locate the record type on the alphabetically sorted pages.

2. On the page of the appropriate record type, search (Ctrl-F or Cmd-F) for the action.

3. View descriptions for available fields under the selected action.

Note:

When creating a proof through the Workfront Misc Action module, best practice is to create a proof without any advanced options, then update the proof using the Workfront Proof SOAP API.

For more information on creating a proof with the Workfront API (which this module uses), see Add advanced proofing options when creating a proof through the ĆŪ¶¹ŹÓʵ Workfront API

Enter or map the unique Workfront ID of the record that you want the module to interact with.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

• clearApprovers

• clearAssignments

• clearConstraints

• clearCustomData

• clearDocuments

• clearExpenses

• clearFinancials

  Clears financial data

• clearPermissions

• clearPredecessors

• clearProgress

• clearTimedNotifications

  Clears reminder notifications

• clearApprovers

• clearAssignments

• clearDocuments

• clearConstraints

• clearExpenses

• clearFinancials

  Clears financial data

• clearPermissions

• clearPredecessors

• clearProgress

• clearTimedNotifications

  Clears reminder notifications

• clearApprovers
• clearAssignments
• clearCustomData
• clearDocuments
• clearPermissions
• clearProgress

• preserveIssue

  Keep the original issue and tie its resolution to this task

• preservePrimaryContact

  Allow the issues's primary contact access to this task

• preserveCompletionDate

  Keep the Planned Completion Date of the issue

• preserveIssue

  Keep the original issue and tie its resolution to this task

• preservePrimaryContact

  Allow the issues's primary contact access to this task

• clearApprovers

• clearAssignments

• clearCustomData

• clearDocuments

• clearExpenses

• clearFinancials

  Clears financial data

• clearPermissions

• clearPredecessors

• clearProgress

• clearTimedNotifications

  Clears reminder notifications

• clearApprovers

• clearAssignments

• clearBillingRates

• clearConstraints

• clearDeliverables

  Clears goals

• clearDocuments

• clearExpenses

• clearFinancials

  Clears financial data

• clearHourTypes

• clearIssueSetup

  Clears queue propterties and issues setup

• clearPredecessors

• clearRisks

• clearSharingOptions

• clearTimedNotifications

  Clears reminder notifications

Enter the unique Workfront ID of the record that you want the module to read.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

Enter the unique Workfront ID of the record that you want the module to update.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

• When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

• When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

  For more information on rich text in updates, see Add an update to a work item in Update work.

Select the type of the parent record (Workfront object) whose associated records you want to read.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module in this article.

Enter or map the ID of the parent record whose associated records you want to read.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

Enter the field that you want to search by, the operator you want to use in your query, and the value that you are searching for in the field.

Note: Do not use username in your search criteria. Including username in an API query to Workfront logs the user into Workfront, and the search will not be successful.

Note: In and NotInwork with arrays. The inputs should be in array format.

Enter the field that you want to search by, the operator you want to use in your query, and the value that you are searching for in the field.

Note: Do not use username in your search criteria. Including username in an API query to Workfront logs the user into Workfront, and the search will not be successful.

Note: In and NotInwork with arrays. The inputs should be in array format.