Value Lists / Values
Get Value
This endpoint retrieves data of a specific Value from a specific Value List based on JSON input. The API returns a single Value available to the user in the Value List, according to the unique ID provided. If the specified Value or Value List do not exist, the response will be a "bad request".
You will only receive the Value 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 |
REQUEST
| Attribute | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Value |
RESPONSE
This endpoint returns just one Value from the Value List.
| Attribute | Type | Description |
|---|---|---|
| UserBorrado | Integer | The id of the user that deleted the value |
| UserCreado | Integer | The id of the user that created the value |
| UserModificado | Integer | The id of the user that updated the value |
| borrado | Boolean | If true, the Value has been deleted |
| descripcion | String | Value name in Spanish |
| descripcion_br | String | Value name in Brasilian Portuguese |
| descripcion_de | String | Value name in German |
| descripcion_dk | String | Value name in Dutch |
| descripcion_en | String | Value name in English |
| descripcion_fr | String | Value name in French |
| descripcion_it | String | Value name in Italian |
| descripcion_pt | String | Value name in Portuguese |
| descripcion_ru | String | Value name in Russian |
| descripcion_us | String | Value name in American English |
| extId | String | External unique identifier for the Value |
| fCreado | String | The date when the value was created |
| fModificado | String | The date when the value was last updated |
| fborrado | String | The date when the value was deleted |
| id | Integer | Unique identifier for the Value in ForceManager |
| idParent | Integer | The id of the entity that the Value depends to, that determines if the Value is visible or not |
| intOrder | Integer | The order of the value in the list |
| strIdEnvironment | String | The branch where this value is visible |
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/list/VALUE/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/list/VALUE/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Value
Changes
No recorded changes to this operation across all 1 revision of this API.