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": "0acd55ff-499d-4b02-9554-277b57607632",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dc1b413d-05d8-457c-aaf6-56bfe66bb00d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "108dc87f-ebe2-434b-9153-9179d18c7dad",
"CreateDate": "2026-11-19T19:27:11.8371331-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T19:27:11.8371331-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-19T19:27:11.8371331-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "4086b813-deeb-4597-9fc3-e0aa79fd1503",
"Section": {
"FormTypeSectionId": "63895d61-5403-482a-9308-d2056fa22e4d",
"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": "05060d80-ea32-43a4-aff0-198333209355",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e3fe343c-500a-428d-96a8-69a7a84e177a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f161857-dd77-404a-84a3-7f14a8341e33",
"CreateDate": "2026-11-19T19:27:11.8371331-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T19:27:11.8371331-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2b62b925-d3b6-46a7-b722-2589b7d008b3",
"FieldId": "6e1c1747-c501-4f32-ae85-b6ac3e017af5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2b62b925-d3b6-46a7-b722-2589b7d008b3",
"FieldId": "6e1c1747-c501-4f32-ae85-b6ac3e017af5",
"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": "4086b813-deeb-4597-9fc3-e0aa79fd1503",
"Section": {
"FormTypeSectionId": "63895d61-5403-482a-9308-d2056fa22e4d",
"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": "05060d80-ea32-43a4-aff0-198333209355",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e3fe343c-500a-428d-96a8-69a7a84e177a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f161857-dd77-404a-84a3-7f14a8341e33",
"CreateDate": "2026-11-19T19:27:11.8371331-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T19:27:11.8371331-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2b62b925-d3b6-46a7-b722-2589b7d008b3",
"FieldId": "6e1c1747-c501-4f32-ae85-b6ac3e017af5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2b62b925-d3b6-46a7-b722-2589b7d008b3",
"FieldId": "6e1c1747-c501-4f32-ae85-b6ac3e017af5",
"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": "ac08fbbf-a6c4-4ed5-b619-e17872cf4ec7",
"CreateDate": "2026-11-19T19:27:11.8371331-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T19:27:11.8371331-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}