Expand my Community achievements bar.

Got questions about Workfront Governance? Join our upcoming Ask Me Anything session on February 12th!
SOLVED

Getting additional "dev tool" data from errors

Avatar

Level 5

The tl;dr: How do I utilize an HTTP or Custom API Call module in lieu of a download doc module so I can get this info?

 

The reason: 

There's a piece of data in these response headers that I want to utilize in an automation which isn't available using the regular ignore error handler. 

 

JohnJOSullivan_1-1735825269362.png

 

I'm guessing to get this info that I'd need to use an HTTP module or a custom API call module. I just don't know the syntax for this. Help?

Topics

Topics help categorize Community content and increase your ability to discover relevant content.

1 Accepted Solution

Avatar

Correct answer by
Employee

Hi @JohnJOSullivan

 

Thank you for your question! In order to return the response headers as part of the module's output, you'll want to use an HTTP Make a Request module. The URL is typically something like https://<domain>.my.workfront.com/attask/api/v19.0/OBJCODE (unless your Workfront instance is on the unified shell, in which case it would be https://<domain>.my.workfront.adobe.com/attask/api/v19.0/OBJCODE instead). To retrieve the object codes (endpoints), you can use our API Explorer HERE. Our API Basics documentation is located HERE and explains how to use our endpoints. 

 

For example, if you wanted to download a document, the URL would be https://<domain>.my.workfront.com/internal/document/download?ID=45125156 and the method would be "GET". You would use a session ID to authenticate the call; to retrieve this, the URL would be https://<domain>.my.workfront.com/attask/api/v19.0/session and the method would be "GET" as well. 

 

Below is a screenshot of my module config: 

 

Screen Shot 2025-01-08 at 8.00.20 AM.png

 

Below are some of the available response headers: 

 

Screen Shot 2025-01-08 at 8.02.49 AM.png

 

At this point, you may want to use an iterator module to iterate through those headers and expand them into individual bundles. With this type of module, all response codes are evaluated as successful unless you check the "Evaluate all states as errors (except for 2xx and 3xx )" option under advanced settings. This means that error handling is not required if you just want to ignore the error. However, the response header information will be available if you need to store it somewhere or email it to yourself etc. 

 

If you did want to use error handling, these response headers are not available to filter by because you can only filter by the error Type, Message or Detail. There is no way to filter by response headers when using error handling. Bear in mind though that you only need to use error handling if your scenario is stopping as a result of an error. The default behavior of the HTTP Make a Request module will not stop the scenario; it will ignore the error so you should be all set. 

 

- Monica 

View solution in original post

1 Reply

Avatar

Correct answer by
Employee

Hi @JohnJOSullivan

 

Thank you for your question! In order to return the response headers as part of the module's output, you'll want to use an HTTP Make a Request module. The URL is typically something like https://<domain>.my.workfront.com/attask/api/v19.0/OBJCODE (unless your Workfront instance is on the unified shell, in which case it would be https://<domain>.my.workfront.adobe.com/attask/api/v19.0/OBJCODE instead). To retrieve the object codes (endpoints), you can use our API Explorer HERE. Our API Basics documentation is located HERE and explains how to use our endpoints. 

 

For example, if you wanted to download a document, the URL would be https://<domain>.my.workfront.com/internal/document/download?ID=45125156 and the method would be "GET". You would use a session ID to authenticate the call; to retrieve this, the URL would be https://<domain>.my.workfront.com/attask/api/v19.0/session and the method would be "GET" as well. 

 

Below is a screenshot of my module config: 

 

Screen Shot 2025-01-08 at 8.00.20 AM.png

 

Below are some of the available response headers: 

 

Screen Shot 2025-01-08 at 8.02.49 AM.png

 

At this point, you may want to use an iterator module to iterate through those headers and expand them into individual bundles. With this type of module, all response codes are evaluated as successful unless you check the "Evaluate all states as errors (except for 2xx and 3xx )" option under advanced settings. This means that error handling is not required if you just want to ignore the error. However, the response header information will be available if you need to store it somewhere or email it to yourself etc. 

 

If you did want to use error handling, these response headers are not available to filter by because you can only filter by the error Type, Message or Detail. There is no way to filter by response headers when using error handling. Bear in mind though that you only need to use error handling if your scenario is stopping as a result of an error. The default behavior of the HTTP Make a Request module will not stop the scenario; it will ignore the error so you should be all set. 

 

- Monica