Forms / Templates
Get Form Template
This endpoint retrieves data of a specific Form Template based on JSON input. The API returns a single Form Template available to the user, according to the unique ID provided. If the specified Form Template does not exist, the response will be a "bad request".
You will only receive the Form Template 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
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier for the Form Template to retrieve data |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| guid | String | Globally Unique identifier for the Form Template in ForceManager |
| type | Integer | Internal type of the Entity associated to the Form Template |
| typeDescription | Integer | Friendly name of the Entity associated to the Form Template |
| url | Integer | URL of the Form Template index file |
| active | Boolean | True if the Form Template is activated, false otherwise |
| idRole | Integer | ID of the Role (see Roles resource) associated to the Form Template |
| extraFields | String | |
| id | Integer | Unique identifier for the Form Template in ForceManager |
| dateCreated | String | Date and time when the Form Template was created |
| dateDeleted | String | Date and time when the Form Template was deleted |
| dateUpdated | String | Date and time when the Form Template was last updated |
| deleted | Boolean | If true, the Form Template has been deleted and archived |
| descriptionBR | String | Form Template name in Brasilian Portuguese |
| descriptionDE | String | Form Template name in German |
| descriptionDK | String | Form Template name in Dutch |
| descriptionEN | String | Form Template name in English |
| descriptionES | String | Form Template name in Spanish |
| descriptionFR | String | Form Template name in French |
| descriptionIT | String | Form Template name in Italian |
| descriptionPT | String | Form Template name in Portuguese |
| descriptionRU | String | Form Template name in Russian |
| descriptionUS | String | Form Template name in American English |
| id | Integer | Unique identifier for the Form Template in ForceManager |
| userCreated | Integer | Unique identifier of the user who created the Form Template |
| userDeleted | Integer | Unique identifier of the user who deleted the Form Template |
| userUpdated | Integer | Unique identifier of the user who last updated the Form Template |
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/forms/{ID}/template
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/forms/{ID}/template
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Form Template
Changes
No recorded changes to this operation across all 1 revision of this API.