Users schema
The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a User object.
You will only receive the Users Schema 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 | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
RESPONSE
The Users schema is a fields structure with the resource. For each property the API Schema will provide you some information:
- Description of each property
- Definition of the data type for each property
- Whether each property is required or optional
| Attribute | Type | Description |
|---|---|---|
| Field name | Object | Name of the attribute in ForceManager Schema |
| Properties | Object | Definition of the entity |
| Id | Object | Identifier of the value of field name |
| Value | Object | The value of the field name |
| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |
| Required | Array | If it’s a mandatory field or not |
Fields like "Value list" have extra information:
|Attribute|Type|Description|
|--|--|--|
| Table | String | The name of the values list table |
| Type | Object, null | The kind of data you will receive in the response |
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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/schema
- Auth: API key in header X-Session-Key
Headers
Response
Users schema
Changes
No recorded changes to this operation across all 1 revision of this API.