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": "0ab23a64-fa30-4888-b10f-e9e273c0a151",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "187d8b28-7566-4643-b501-c19d8dfc0c43",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c818e2af-9f82-4443-8a08-5a846fcab64b",
"CreateDate": "2026-07-27T03:57:14.101155-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-27T03:57:14.101155-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-27T03:57:14.101155-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "613b8db2-23a7-4b22-b918-182292785e29",
"Section": {
"FormTypeSectionId": "492f0e95-28d0-4dfe-b0d7-9e95ddbcaab5",
"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": "61313454-f6ec-4ec2-a87f-ab306c5c2bec",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e717a183-ad10-4e77-bbbe-ac17d7bed890",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38cc3bcf-1981-4e65-9af5-f4e9a2640a65",
"CreateDate": "2026-07-27T03:57:14.101155-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-27T03:57:14.101155-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6b4bbb62-44c5-4c93-84cd-9b03aefdf0ae",
"FieldId": "9394af0c-4ed1-4743-b4d5-eed91239644d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6b4bbb62-44c5-4c93-84cd-9b03aefdf0ae",
"FieldId": "9394af0c-4ed1-4743-b4d5-eed91239644d",
"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": "613b8db2-23a7-4b22-b918-182292785e29",
"Section": {
"FormTypeSectionId": "492f0e95-28d0-4dfe-b0d7-9e95ddbcaab5",
"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": "61313454-f6ec-4ec2-a87f-ab306c5c2bec",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e717a183-ad10-4e77-bbbe-ac17d7bed890",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38cc3bcf-1981-4e65-9af5-f4e9a2640a65",
"CreateDate": "2026-07-27T03:57:14.101155-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-27T03:57:14.101155-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6b4bbb62-44c5-4c93-84cd-9b03aefdf0ae",
"FieldId": "9394af0c-4ed1-4743-b4d5-eed91239644d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6b4bbb62-44c5-4c93-84cd-9b03aefdf0ae",
"FieldId": "9394af0c-4ed1-4743-b4d5-eed91239644d",
"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": "450fd93b-c71b-4642-8a05-9e630196d130",
"CreateDate": "2026-07-27T03:57:14.101155-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-27T03:57:14.101155-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}