Help Endpoints
Use the references for REST API V9.0 Help endpoints.
GET /help/endpoints
Retrieves a list of endpoint documentation objects that are currently in the system.
Table 1: GET /help/endpoints Resource Details
MIME Type |
|---|
application/json |
Table 2: GET /help/endpoints 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/endpoints Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The endpoint documentation list was retrieved. | |
500 | 1020 | An unexpected error has occurred. |
Response Description
An array of endpoint documentation objects. An endpoint documentation object contains the following fields:
id - Number - The ID of the endpoint documentation. This ID is not permanent. It might change any time services are restarted.
summary - String - A brief summary of the endpoint.
deprecated - Boolean - Returns true if the endpoint is deprecated. Returns false otherwise.
http_method - String - The HTTP request type. One of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH.
error_responses - Array of Objects - A list of potential error responses of this endpoint.
error_responses(response_code) - Number - The HTTP code for this error response.
error_responses(description) - String - The description for this error response.
error_responses(unique_code) - Number - The unique code for this error response.
error_responses(response_code_description) - String - The description of the response.
response_description - String - The description of the response.
version - String - The version of this endpoint.
success_responses - Array of Objects - A list of potential success responses for this endpoint.
success_responses(response_code) - Number - The HTTP code for this response.
success_responses(description) - String - The description of this response.
success_responses(response_code_description) - String - The name for the response code from RFC 2616.
description - String - A description of this endpoint.
path - String - The path of this endpoint.
response_mime_types - Array of Objects - A list of possible response MIME types for this endpoint.
response_mime_types(mime_type) - String - The MIME type value, e.g. TEXT_PLAIN
response_mime_types(media_type) - String - The RFC style Media Type, e.g. text/plain This value is suitable for use in HTTP requests.
response_mime_types(sample) - String - The sample of this response MIME type.
parameters - Array of Objects - A list of user parameters for this endpoint.
parameters(description) - String - A description of this parameter.
parameters(default_value) - String - The default value of this parameter. Null if there is no default value for this parameter. This is always a String, regardless of the underlying data type of the parameter.
parameters(type) - String - The type of parameter, one of QUERY, HEADER, PATH, BODY.
parameters(parameter_name) - String - The name of this parameter.
parameters(mime_types) - Array of Objects - A list of possible mime_types for this parameter.
parameters(mime_types(data_type)) - String - A description of the data type of this parameter.
parameters(mime_types(mime_type)) - String - The MIME type of the parameter.
parameters(mime_types(sample)) - String - The sample for this parameter.
resource_id - Number - The ID of the associated resource.
last_modified_version - String - The API version this endpoint was last modified. It is less than or equal to the version in the version field.
caller_has_access - Boolean - True if the user has the required capabilities to call this endpoint, false otherwise.
Response Sample
[ { "caller_has_access": true, "deprecated": true, "description": "String", "error_responses": [ { "description": "String", "response_code": 42, "response_code_description": "String", "unique_code": 42 } ], "http_method": "String <one of: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH>", "id": 42, "last_modified_version": "String", "parameters": [ { "default_value": "String", "description": "String", "mime_types": [ { "data_type": "String", "mime_type": "String", "sample": "String" } ], "parameter_name": "String", "type": "String <one of: QUERY, HEADER, PATH, BODY>" } ], "path": "String", "resource_id": 42, "response_description": "String", "response_mime_types": [ { "mime_type": "String", "sample": "String", "media_type": "String" } ], "success_responses": [ { "description": "String", "response_code": 42, "response_code_description": "String" } ], "summary": "String", "version": "String" } ]
GET /help/endpoints/{endpoint_id}
Retrieves a single endpoint documentation object.
Table 4: GET /help/endpoints/{endpoint_id} Resource Details
MIME Type |
|---|
application/json |
Table 5: GET /help/endpoints/{endpoint_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
endpoint_id | path | Required | Number (Integer) | text/plain | The endpoint 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 6: GET /help/endpoints/{endpoint_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The endpoint documentation object was retrieved. | |
404 | 1002 | No endpoint documentation object was found for the provided endpoint id. |
500 | 1020 | An unexpected error has occurred. |
Response Description
An endpoint documentation object. An endpoint documentation object contains the following fields:
id - Number - The ID of the endpoint documentation. This ID is not permanent. It might change any time services are restarted.
summary - String - A brief summary of the endpoint.
deprecated - Boolean - Returns true if the endpoint is deprecated. Returns false otherwise.
http_method - String - The HTTP request type. One of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH.
error_responses - Array of Objects - A list of potential error responses of this endpoint.
error_responses(response_code) - Number - The HTTP code for this error response.
error_responses(description) - String - The description for this error response.
error_responses(unique_code) - Number - The unique code for this error response.
error_responses(response_code_description) - String - The description of the response.
response_description - String - The description of the response.
version - String - The version of this endpoint.
success_responses - Array of Objects - A list of potential success responses for this endpoint.
success_responses(response_code) - Number - The HTTP code for this response.
success_responses(description) - String - The description of this response.
success_responses(response_code_description) - String - The name for the response code from RFC 2616.
description - String - A description of this endpoint.
path - String - The path of this endpoint.
response_mime_types - Array of Objects - A list of possible response MIME types for this endpoint.
response_mime_types(mime_type) - String - The MIME type value, e.g. TEXT_PLAIN
response_mime_types(media_type) - String - The RFC style Media Type, e.g. text/plain This value is suitable for use in HTTP requests.
response_mime_types(sample) - String - The sample of this response MIME type.
parameters - Array of Objects - A list of user parameters for this endpoint.
parameters(description) - String - A description of this parameter.
parameters(default_value) - String - The default value of this parameter. Null if there is no default value for this parameter. This is always a String, regardless of the underlying data type of the parameter.
parameters(type) - String - The type of parameter, one of QUERY, HEADER, PATH, BODY.
parameters(parameter_name) - String - The name of this parameter.
parameters(mime_types) - Array of Objects - A list of possible mime_types for this parameter.
parameters(mime_types(data_type)) - String - A description of the data type of this parameter.
parameters(mime_types(mime_type)) - String - The MIME type of the parameter.
parameters(mime_types(sample)) - String - The sample for this parameter.
resource_id - Number - The ID of the associated resource.
last_modified_version - String - The API version this endpoint was last modified. It will be less than or equal to the version in the version field.
caller_has_access - Boolean - Returns true if the user has the required capabilities to call this endpoint. Returns false otherwise.
Response Sample
{ "caller_has_access": true, "deprecated": true, "description": "String", "error_responses": [ { "description": "String", "response_code": 42, "response_code_description": "String", "unique_code": 42 } ], "http_method": "String <one of: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH>", "id": 42, "last_modified_version": "String", "parameters": [ { "default_value": "String", "description": "String", "mime_types": [ { "data_type": "String", "mime_type": "String", "sample": "String" } ], "parameter_name": "String", "type": "String <one of: QUERY, HEADER, PATH, BODY>" } ], "path": "String", "resource_id": 42, "response_description": "String", "response_mime_types": [ { "mime_type": "String", "sample": "String" } ], "success_responses": [ { "description": "String", "response_code": 42, "response_code_description": "String" } ], "summary": "String", "version": "String" }
GET /help/resources
Retrieves a list of resource documentation objects currently in the system.
Table 7: GET /help/resources Resource Details
MIME Type |
|---|
application/json |
Table 8: GET /help/resources Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
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. |
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. |
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. |
Table 9: 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" } ]
GET /help/resources/{resource_id}
Retrieves a single resource documentation object.
Table 10: GET /help/resources/{resource_id} Resource Details
MIME Type |
|---|
application/json |
Table 11: 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 12: 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" }
GET /help/versions
Retrieves a list of version documentation objects currently in the system.
Table 13: GET /help/versions Resource Details
MIME Type |
|---|
application/json |
Table 14: GET /help/versions Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
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. |
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. |
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. |
Table 15: GET /help/versions Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The version documentation list was retrieved. | |
500 | 1020 | An unexpected error has occurred. |
Response Description
An array of version documentation objects. A version documentation object contains the following fields:
id - Number - The ID of the version documentation object. This ID is not permanent. It might change any time services are restarted.
deprecated - Boolean - Returns true if this version is deprecated. Returns false otherwise.
removed - Boolean - Returns true if this version is removed. Returns false otherwise. Endpoints cannot be called from an API version that is removed.
root_resource_ids - Array of Numbers - Resource IDs of the root resources in this version of the API.
version - String - The API version that this version documentation represents.
Response Sample
[ { "deprecated": true, "id": 42, "removed": true, "root_resource_ids": [ 42 ], "version": "String" } ]
GET /help/versions/{version_id}
Retrieves a single version documentation object.
Table 16: GET /help/versions/{version_id} Resource Details
MIME Type |
|---|
application/json |
Table 17: GET /help/versions/{version_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
version_id | path | Required | Number (Integer) | text/plain | The ID of the version documentation to retrieve. |
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 18: GET /help/versions/{version_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The version documentation object was retrieved. | |
404 | 1002 | No version documentation object was found for the provided version id. |
500 | 1020 | An unexpected error has occurred. |
Response Description
A version documentation object. A version documentation object contains the following fields:
id - Number - The ID of the version documentation object. This ID is not permanent. It might change any time services are restarted.
deprecated - Boolean - Returns true if this version is deprecated. Returns false otherwise.
removed - Boolean - Returns true if this version is removed. Returns false otherwise. Endpoints cannot be called with an API version that is removed.
root_resource_ids - Array of Numbers - Resource IDs of the root resources in this version of the API.
version - String - The API version that this version documentation represents.
Response Sample
{ "deprecated": true, "id": 42, "removed": true, "root_resource_ids": [ 42 ], "version": "String" }