Solved

[GuideCX API] GET /tasks props[] not working

  • 25 August 2023
  • 2 replies
  • 137 views
Kaczuszka

Hi everyone!

I’m working on GuideCX API integration.

While testing the API with Postman I noticed that passing in the query props[property]=value isn’t working properly.

I want to filter tasks by responsibility field containing “CUSTOMER” value.

Just like documentation requires, I added include=properties in the query string.

Link to the documentation: https://api.guidecx.com/api/v2/docs#get-/tasks

 

Screenshot of tasks data without filtering by props[responsibility]=CUSTOMER:
(property responsibility = “CUSTOMER” is clearly here)


Screenshot after applying filter props[responsibility] = CUSTOMER:
(No data is found)

 

Would much appreciate any insights into this, thanks! :)

icon

Best answer by Hamani.Po'oi 25 August 2023, 19:38

View original

2 replies

Hamani.Po'oi
Badge

Hi @Kaczuszka !

The props are used to filter by the properties you set on the tasks via this call → https://api.guidecx.com/api/v2/docs#patch-/tasks/-taskId-/properties

These are hidden properties that you can set tied to this specific task. A common use case would be to add a Jira ticket ID or Issue Key associated with the GUIDEcx task as a property. You would then be able to use this call to filter by that property to find the task(s) with that value. 

I would recommend filtering by customer responsibility in the Recipe Builder in your GUIDEcx instance if you’re looking to add this call to a workflow. That allows you to build an additional step after searching all tasks on a given project in your workflow to filter out any tasks that are not CUSTOMER. 

Kaczuszka

@Hamani.Po'oi Gotcha. Thanks a lot for the clarification! 😃

Reply


Terms & ConditionsCookie settings