Psoda API: List of descendants

Psoda API – /rest_api/v2/objects/{object id}/descendants.json

Use this URI to retrieve a list of descendant objects for the selected object identified by {object id}.WARNING: This method can return a very large number of results. Please use the filters below to restrict the results to just what you need.

Header: API-Key (mandatory)

You must specify an API-Key to access any data from Psoda. You can find your API-Key by logging into Psoda with the user account you want to use for the API, navigate to “My stuff” and then click on the “API Code” button in the top header area.

Header: If-Modified-Since (optional)

Use this header if you want to limit the results to only those descendants that have been modified since the specified date. The date is in a text format, e.g. 15 Nov 1994 12:45:26 GMT

Header: Accept-Language (optional)

Use this header if you want to change the language for the user. The following languages are currently supported:
  • af – Afrikaans
  • en – English
  • en-nz – English
  • en-uk – English
  • en-us – United States English
  • ja – Japanese
  • ru – Russian
  • zh-cn – Simplified Chinese
  • zh-hk – Simplified Chinese
  • zh-mo – Simplified Chinese
  • zh-sg – Simplified Chinese
  • zh-tw – Simplified Chinese
  • zh – Simplified Chinese

Parameter: pageSize (optional)

You can use this parameter to specify how many objects you want in your result set. If this is left blank, then 100 objects will be returned as a default.

Parameter: start (optional)

You can use this parameter to specify where you want your result set to start from. If this is left blank, 0 will be used and your result set will start from the first object.

Parameter: lang (optional)

Alternatively, you can use this parameter to set the language.

Parameter: fields (optional)

You can use this parameter to limit which attributes are returned from the API call. You can specify multiple fields with commas separating them. If the field does not exist for the item then it will not be included in the result.

Parameter: classes (optional)

You can use this parameter to specify the types of descendants that will be returned from the query. It is a comma separted list. For example “risk,issue,action”

Parameter: max_levels (optional)

Set this parameter to the maximum number of levels to include in the results. max_levels=1 is equivalent to using /children.json. The default is -1 which returns all levels.

Parameter: include_archived (optional)

The default is to include any archived items in the query response. You can set this optional parameter to “false” to block archived items from being returned.

Parameter: include_deleted (optional)

The default is to not include any deleted items in the response. You can set this optional parameter to “true” to include deleted items.

Response: pagination

Our REST API supports pagination. If your pageSize parameter is less than the total amount of objects you’re querying on, then you will be provided with information that will allow you to obtain the next set of objects. More details can be found here

The pagination object contains the following fields:

cursor: If you haven’t received all of your data in one request, then a cursor will be returned. This cursor can be used in a subsequent next request that will return the next set of objects.

start: This will show you where your result set has started from. Your first request will start with 0, then increment based on the pageSize parameter (if the pageSize was 100, it would be 0, 100, 200, 300)

pageSize: This will show how many objects were in the result set, which is specified in the pageSize parameter. If the result set was less than what was specified in the pageSize parameter then this field will reflect that (if the pageSize parameter was set 100 but the result only contained 50 objects, then this field would be 50).

total: This will show the total amount of objects, when the start field + pageSize field is greater than or equal to this number that means you are at the last request.

Response: links

If your pageSize parameter is less than the total amount of objects you’re querying on, a URI will be given that can be used to retrieve your next page of information. If there is no more data to obtain, this field will be empty. This URI will contain any parameters used in the previous request which can simplify the pagination process.

The top level of the API is https://www.psoda.com/help/top-level/