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": "ae0a82fb-59ab-4cb4-acf6-bd85c137ba55",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "20a7fd73-7d84-4a2c-a43b-2db00cf90e8c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "18400118-ed35-4727-84ad-8add5360a6ef",
"CreateDate": "2026-07-05T22:34:00.0279197-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-05T22:34:00.0279197-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-05T22:34:00.0279197-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ef99caeb-f33c-4f32-b3b8-67160e8bf39e",
"Section": {
"FormTypeSectionId": "a1e2e87e-fa21-4624-ab51-6ab76fb2aef2",
"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": "ff156823-b772-427f-97de-2a896572e12e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "52f8628d-0e81-4452-8ab7-0963a7593128",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ba971e93-993b-45d5-bc92-4e92dacd52cd",
"CreateDate": "2026-07-05T22:34:00.0279197-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-05T22:34:00.0279197-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4e6eb164-d958-4493-bbcd-81364d16950d",
"FieldId": "f1d4890d-51ad-4ff7-a193-0951d7908e2a",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4e6eb164-d958-4493-bbcd-81364d16950d",
"FieldId": "f1d4890d-51ad-4ff7-a193-0951d7908e2a",
"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": "ef99caeb-f33c-4f32-b3b8-67160e8bf39e",
"Section": {
"FormTypeSectionId": "a1e2e87e-fa21-4624-ab51-6ab76fb2aef2",
"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": "ff156823-b772-427f-97de-2a896572e12e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "52f8628d-0e81-4452-8ab7-0963a7593128",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ba971e93-993b-45d5-bc92-4e92dacd52cd",
"CreateDate": "2026-07-05T22:34:00.0279197-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-05T22:34:00.0279197-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4e6eb164-d958-4493-bbcd-81364d16950d",
"FieldId": "f1d4890d-51ad-4ff7-a193-0951d7908e2a",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4e6eb164-d958-4493-bbcd-81364d16950d",
"FieldId": "f1d4890d-51ad-4ff7-a193-0951d7908e2a",
"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": "aa645f42-5967-4e03-939e-9c3b298715a9",
"CreateDate": "2026-07-05T22:34:00.0279197-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-05T22:34:00.0279197-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}