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": "5cd911af-0f21-4543-8eb0-24c5c4589207",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b36b903f-491d-440a-b15a-d1db4e639866",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "06102f0e-04af-449b-a840-1442ad2d6911",
"CreateDate": "2026-02-11T03:37:36.7156892-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-11T03:37:36.7156892-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-11T03:37:36.7156892-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ddc9b240-4d5a-42df-a8f7-9b0ef7a404a8",
"Section": {
"FormTypeSectionId": "252ea133-f3b1-48cd-9f47-45c7e4c94654",
"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": "6c00ac03-40b4-43f0-bed6-4ebe43206f28",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c428f120-4d01-44fd-ba6b-f460297b38bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f91a5b81-2af4-454d-a2d6-84eb3bbd3107",
"CreateDate": "2026-02-11T03:37:36.7156892-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T03:37:36.7156892-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "912a4c5a-028b-444d-84f5-2b10c24b5a74",
"FieldId": "9a3fdab6-a6d6-4b1e-bb13-f5c0513c23ac",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "912a4c5a-028b-444d-84f5-2b10c24b5a74",
"FieldId": "9a3fdab6-a6d6-4b1e-bb13-f5c0513c23ac",
"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": "ddc9b240-4d5a-42df-a8f7-9b0ef7a404a8",
"Section": {
"FormTypeSectionId": "252ea133-f3b1-48cd-9f47-45c7e4c94654",
"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": "6c00ac03-40b4-43f0-bed6-4ebe43206f28",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c428f120-4d01-44fd-ba6b-f460297b38bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f91a5b81-2af4-454d-a2d6-84eb3bbd3107",
"CreateDate": "2026-02-11T03:37:36.7156892-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T03:37:36.7156892-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "912a4c5a-028b-444d-84f5-2b10c24b5a74",
"FieldId": "9a3fdab6-a6d6-4b1e-bb13-f5c0513c23ac",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "912a4c5a-028b-444d-84f5-2b10c24b5a74",
"FieldId": "9a3fdab6-a6d6-4b1e-bb13-f5c0513c23ac",
"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": "a741b1da-c255-45cf-9740-2985d825948b",
"CreateDate": "2026-02-11T03:37:36.7156892-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-11T03:37:36.7156892-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}