Resource
Definition of an individual resource (and accessed with a specified verb) that may be returned for an owning object type.
Fields
| Field | Type | Mode † | Description |
|---|---|---|---|
availability | String | read-only | Comments regarding when this resource will be present in an object representation. |
description | String | read-only | Description of this resource. |
example | String | read-only | A usage example for this resource and verb combination. |
hasBody | Boolean | read-only | Flag indicating that this resource expects body content to be passed when it is called. |
jsMethod | String | read-only | The name of the JavaScript method to create in the JavaScript API to interact with the specified resource URI using the specified verb. Required only if the normal inference rules result in an undesired method name. |
name | String | read-only | The name of this resource. This name will be the key in the |
path | String | read-only | A URL, provided as an example, to the REST endpoint that serves this resource. |
since | String | read-only | Comments about the first version of the API in which this resource became available. |
unpublished | Boolean | read-only | Flag indicating that this resource is present for internal use only, and should not be considered to be generally available or documented. |
verb | String | read-only | The HTTP verb that will be used to interact with the URI of this resource by the generated JavaScript method. |