GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form type.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormTypeId": "21014cfc-dfd6-4e50-97a8-92083d952bb6",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d8757a67-15f4-42f3-9abe-d36e1d9a2016",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "07e4f7d4-5b19-4cb6-9587-466127068a4b",
"CreateDate": "2026-11-21T15:32:24.342694-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:24.342694-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T15:32:24.342694-08:00",
"Fields": [
{
"FormTypeFieldId": "e9f50657-8f0c-419d-b3c0-42563e6db9ac",
"Section": {
"FormTypeSectionId": "f6fd9545-0e2d-4635-a078-4d5a26e7bdd7",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "9d60fc30-d745-4740-905e-34bb815cb4e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d4543bb0-d165-49a4-a28c-83df85ace76f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "04e4b101-eb81-4913-956e-c05f0a32bb5d",
"CreateDate": "2026-11-21T15:32:24.342694-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.342694-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "e9f50657-8f0c-419d-b3c0-42563e6db9ac",
"Section": {
"FormTypeSectionId": "f6fd9545-0e2d-4635-a078-4d5a26e7bdd7",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "9d60fc30-d745-4740-905e-34bb815cb4e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d4543bb0-d165-49a4-a28c-83df85ace76f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "04e4b101-eb81-4913-956e-c05f0a32bb5d",
"CreateDate": "2026-11-21T15:32:24.342694-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.342694-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "b60372b9-f667-4bf1-b07b-605ee2992b9c",
"CreateDate": "2026-11-21T15:32:24.342694-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:24.342694-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}