Resources
Get Resources
This endpoint retrieves all the methods available in the API on JSON input.
You will only receive the Resource's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Accept any data of whatever mime type |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| description | String | The endpoint description. (Extra information to get more context) |
| end_point | String | The method's url |
| operations | Object | This object contains the CRUD operations available in a JSON Object |
| schema | String | The schema's url for this method |
The operations object contains the following structure
| Attribute | Type | Description |
|---|---|---|
| create | Boolean | True if the create method is available, otherwise False |
| delete | Boolean | True if the create method is available, otherwise False |
| read | Boolean | True if the create method is available, otherwise False |
| update | Boolean | True if the create method is available, otherwise False |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/resources
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/resources
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
Get Resources
Changes
No recorded changes to this operation across all 1 revision of this API.