Calling A Workfront API Using Postman

Introduction

This article shows how to call a Workfront API using Postman.

Postman lets you quickly test the API without building a Fusion scenario, so you can check the response and data easily.

If another application needs data from Workfront, it’s a good idea to test the API in Postman first before sharing the URL and credentials.

Steps

1.       Create an API key in Workfront:

·       Login to Workfront and navigate to Setup à Customer Info

·       “After creation, API keys expire in” can be set to “None”

·       Click on “Generate API key” to create a new key.

·       Save the key securely. It will be required for configuration in Postman

A screenshot of a computer Description automatically generated

2.       Constructing the API URL:

·       We can get the Base URL using the scenario debugger, which we will cover in a separate KB document. For now, let's use the Base URL shown below.

o   Base URL: https://r100kazi29.testdrive.workfront.com/attask/api/v21.0/

·       We can get the resource path from API explorer: https://developer.adobe.com/workfront/api-explorer/

·       Let's retrieve the details of a project using its ID. Please refer to the screenshot: we've filtered by project, and under the "Fields" tab, we can see the relevant fields. Note that the object code is "PROJ"A screenshot of a computer Description automatically generated

·       Now let’s construct the resource path of the API. Since we want to pull out all fields, we will use the first query parameter as “?fields = *”. Additionally, we need to search the project by ID and hence let us add the second query parameter as “ID=66f8f7b6001c98e378293ecdb6c00541”. This is the ID of the project that we are querying.

·       The final resource path will look like this. Note that the object code is followed by “search,” followed by the query parameters: “proj/search?fields=*&ID=66f8f7b6001c98e378293ecdb6c00541”

·       The final API URL will be a concatenation of Base URL and the Resource path:

https://r100kazi29.testdrive.workfront.com/attask/api/v21.0/proj/search?fields=*&ID=66f8f7b6001c98e378293ecdb6c00541

·       Now that we have constructed the API URL let us test it in Postman

·      Note: Always use the latest version of Workfront API. For example in this case we have use v21.0.

3.       Post man configuration:

·       Open Postman.

·       Click on the + icon to open a new untitled request tab.

A screenshot of a computer Description automatically generated

·       Copy and paste the constructed API URL into the “Enter URL or paste” text box.

A screenshot of a computer Description automatically generated

·       Open the Authorization tab and select the Auth Type as API Key. For the Key Type, type apiKey, and enter your API key value in the Value field. Under Add to, select Header.

A screenshot of a computer Description automatically generated

·       Click on Send

·       You will find the API response under the Body tab.

A screenshot of a computer program Description automatically generated

Comments

Post a Comment

Popular posts from this blog

REST API Calls with Query Parameters in BizTalk: A Step-by-Step Guide

Image
 Introduction In this blog, I will provide a comprehensive guide on how to call a REST API that requires query parameters. We'll walk through the necessary steps to set up the environment and make successful API calls. Solution High Level Steps 1. API Overview: We will be using an open API for demonstration purposes. The API endpoint we'll be working with is: https://randomuser.me/api/?results=1 2. Schema Creation: Create a schema named "SourceA" that matches the structure of the messages you'll be dropping in the receive location. To create a JSON response schema, follow these steps: capture the JSON response by running a test in Postman, and then utilize a JSON schema generator to create the desired JSON schema. 3. Field Promotion: In the SourceA schema, promote the field called "results." This field will serve as the variable for the query parameter. 4. Receive JSON Pipeline: Develop a receive JSON pipeline that can receive JSON messages and convert t...
Read more

Error: Number of included segments do not match

Introduction In this blog, we tackle a crucial issue encountered during the reprocessing of an X12 EDI message. We will get into the root cause of the problem and provide you with a solution to overcome it. Error: An output message of the component "Unknown " in receive pipeline "Microsoft.BizTalk.Edi.DefaultPipelines.EdiReceive, Microsoft.BizTalk.Edi.EdiPipelines, Version=3.0.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" is suspended due to the following error:       Error encountered during parsing. The X12 transaction set with id '103465910' contained in functional group with id '02', in interchange with id '000000009', with sender id '4532345856     ', receiver id '8038025150     ' is being suspended with following errors: Error: 1 (Miscellaneous error) 4: Number of included segments do not match . The sequence number of the suspended message is 1.  Root Cause: The issue stems from a mismatch in the number of se...
Read more

Updating BizTalk SSO DB using BTDF and a simple BTDF deployment

Image
Introduction In some cases, it becomes important to securely store key-value pairs, such as configuration data (e.g., usernames and passwords), rather than hardcoding them within a BizTalk orchestration. One effective way to achieve this is by storing these key-value pairs securely in the BizTalk SSO (Enterprise Single Sign-On) database and subsequently reading these values within our orchestration through a simple line of code within a BizTalk expression shape. In this blog post, we will go through the steps to add key-value pairs to the SSO database using the BizTalk Deployment Framework (BTDF). We will also explore how to read these values within a BizTalk orchestration and perform a simple BizTalk deployment using BTDF. Steps Creating a BizTalk Solution, Schema Project and Map project: Let's first create a BizTalk Solution called "SSOPOC" and a project called "SSOPOC.Schema". For this, you need to go to Visual Studio and click on File --> New Project --...
Read more