Proper use of the "fields" parameter on CS REST API

Hi All,

I have a question on using the "fields" parameter on a REST call to the CS API. I've been using Postman to test the results from different GET calls to the API for nodes. When I try to filter out the list of fields I want returned I get nothing. Is this functionality actually enabled or am I just be doing something wrong.

We are CS 10.5 SP1 update 2016-09.

I'm passing the fields parameter as part of the query string such as this:

/api/v1/nodes/{id}/nodes?fields=id,name,create_date

but that returns nothing...if I remove the fields parameter I get all nodes under the specified node id.

Thanks

Find more posts tagged with

API

Comments

Mark Farrall

It's actually the set of fields you're restricting, not individual fields within a set. So values like 'data' or 'definitions' are what work. Whatever objects appear on the first level of the response.

Leonel Leal II

Thanks Mark for clearing that up. I was looking at it from the point of view that it was supposed to return only a field from within a set. Now that I know how it works I will just have to work with that.