GET /help/resources/{resource_id}

Retrieves a single resource documentation object.

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

Table 2. GET /help/resources/{resource_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
resource_id	path	Required	Number (Integer)	text/plain	The resource id.
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.

Table 3. GET /help/resources/{resource_id} response codes
HTTP Response Code	Unique Code	Description
200		The resource documentation object was retrieved.
404	1002	No resource documentation object was found for the provided resource ID.
500	1020	An unexpected error has occurred.

Response Description

A resource documentation object. 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"
}