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": "1dc47990-4645-403d-bf69-2a85f0531d2b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c52a2214-2e2c-40fe-bab6-1db469d02a40",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5354850-bffc-4a50-97f4-e619507ab1cf",
"CreateDate": "2026-08-14T05:55:09.0052929-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-14T05:55:09.0052929-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-14T05:55:09.0052929-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "676374bc-94a2-4363-a5d0-2c40db7cfbdb",
"Section": {
"FormTypeSectionId": "2e187a91-0cef-4589-9c24-faf0397393a4",
"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": "ccef3d92-c5be-4d9a-847a-8356362dbf10",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ced33dc3-f3f0-49b5-84ad-1183edf99a86",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0a4d0a21-ae54-491a-9f8b-03bef6f96843",
"CreateDate": "2026-08-14T05:55:09.0052929-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-14T05:55:09.0052929-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7293edf5-3fe8-4b50-8ef8-9ba3c10dd290",
"FieldId": "2f5f7dfa-bfd9-4cef-9355-5793ba21f8a3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7293edf5-3fe8-4b50-8ef8-9ba3c10dd290",
"FieldId": "2f5f7dfa-bfd9-4cef-9355-5793ba21f8a3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "676374bc-94a2-4363-a5d0-2c40db7cfbdb",
"Section": {
"FormTypeSectionId": "2e187a91-0cef-4589-9c24-faf0397393a4",
"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": "ccef3d92-c5be-4d9a-847a-8356362dbf10",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ced33dc3-f3f0-49b5-84ad-1183edf99a86",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0a4d0a21-ae54-491a-9f8b-03bef6f96843",
"CreateDate": "2026-08-14T05:55:09.0052929-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-14T05:55:09.0052929-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7293edf5-3fe8-4b50-8ef8-9ba3c10dd290",
"FieldId": "2f5f7dfa-bfd9-4cef-9355-5793ba21f8a3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7293edf5-3fe8-4b50-8ef8-9ba3c10dd290",
"FieldId": "2f5f7dfa-bfd9-4cef-9355-5793ba21f8a3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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 4",
"CompanyId": "57c15a7c-af61-4f28-bbf2-aa7605b92229",
"CreateDate": "2026-08-14T05:55:09.0052929-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-14T05:55:09.0052929-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}