GET /help/resources

Retrieves a list of resource documentation objects currently in the system.

Table 1. GET /help/resources resource details
MIME Type
application/json

Table 2. GET /help/resources request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /help/resources response codes
HTTP Response Code	Unique Code	Description
200		The resource documentation list was retrieved.
500	1020	An unexpected error has occurred.

Response Description

An array of resource documentation objects. A resource documentation object contains the following fields:

id - Number - The ID of the resource documentation object. This ID is not permanent. It might change any time services are restarted.
child_resource_ids - Array of Numbers - A list of resource documentation IDs that are the children of this resource.
endpoint_ids - Array of Numbers - A list of endpoint documentation IDs for endpoints on this resource.
resource - String - The current resource.
path - String - The full path of the current resource.
parent_resource_id - Number - The resource documentation ID of the parent of this resource. Null if this is a root resource.
version - String - The version of this resource.

Response Sample


[
    {
        "child_resource_ids": [
            42
        ],
        "endpoint_ids": [
            42
        ],
        "id": 42,
        "parent_resource_id": 42,
        "path": "String",
        "resource": "String",
        "version": "String"
    }
]