List Extra Fields by Resource
Returns all Extra Fields available in the user's ForceManager implementation database, for a specific Entity.
You will only receive the Extra Field's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
PARAMETERS REQUEST
You can organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| resource | String | The unique and specific identifier for the Entity you to retrieve data. The allowed values are: accounts, activities, calendar, contacts, opportunities, products, rates, salesorders, users |
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | Organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/extrafields/VALUE?page=PAGE_NUMBER
You can also organise and view the results for Extra Fields in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/extrafields/VALUE?order=VALUE
RESPONSE
Returns information about all Extra Fields existing in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Extra Fields attributes:
| Attribute | Type | Description |
|---|---|---|
| entity | String | The name of the entity the Extra Field is linked to |
| description | String | Field name in Spanish |
| fieldName | String | Field name in the ForceManager database |
| type | Integer | Define the Extra Field's data type. The allowed types are: datetime, text, decimal, bit, list, multivalue |
| valueListRelated | String | If type is list or multivalue, it has to contain the database name of table that the Extra Field is sticked to |
| dateCreated | String | Date and time when the Extra Field was created |
| dateDeleted | String | Date and time when the Extra Field was deleted |
| dateUpdated | String | Date and time when the Extra Field was last updated |
| deleted | Boolean | If true, the Extra Field has been deleted and archived |
| defaultValue | String | The default value that the field should have |
| descriptionEN | String | Field name in English |
| descriptionIT | String | Field name in Italian |
| descriptionFR | String | Field name in French |
| descriptionDE | String | Field name in German |
| descriptionPT | String | Field name in Portuguese |
| descriptionUS | String | Field name in American English |
| descriptionRU | String | Field name in Russian |
| descriptionBR | String | Field name in Brasilian Portuguese |
| descriptionDK | String | Field name in Dutch |
| branches | Array | Branches in which the Extra Field is visibile |
| id | Integer | The Extra Field unique identifier |
| length | Integer | If Type is Text, define the length of this field |
| mandatory | Boolean | If true, the Extra Field is mandatory |
| mandatoryRestApi | Boolean | If true, the Extra Field is mandatory in the API requests |
| readOnly | Boolean | If true, the Extra Field is read only |
| order | Integer | Define its position inside the Tab |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Extra Field |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Extra Field |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Extra Field |
| tabId | Integer | The id of the tab that contains the Extra Field |
| searchable | Boolean | If true, you can search by the Extra Field |
| visibleInList | Boolean | If true, the Extra Field is visible in the entity list views of the web app |
| visibleInPhoneCallForm | Boolean | If true, the Extra Field is visible in the Phone Call form |
| webVisibility | Boolean | If true, the Extra Field is visible in all the devices |
| mobileVisibility | Boolean | If true, the Extra Field is visible in the mobile version |
| restApi | String | If true, the Extra Field will be visible in the API requests |
| dynamicField | String | The database name of the table that the Extra Field visibility depends from |
| dynamicFieldValues | Array | The IDs of the values of the table, the one specified in the dynamicField field, that make the Extra Field visibile |
| dependenceField | String | If type is list or multivalue, it has to contain the databae name fo the dependent table. This also requires to fill the idParent field of each Value of the valueListRelated table, to make the dependency effective |
| fuzzySearch | Boolean | If type is list or multivalue, a value of the table can be selected through a search input instead of a option drop down menu, inside the entity create/update form |
| includeTime | Boolean | If type is datetime, it lets you specify if the field has to include time values |
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/extrafields/VALUE
- Auth: API key in header X-Session-Key
Headers
Response
List Extra Fields by Resource
Changes
No recorded changes to this operation across all 1 revision of this API.