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": "2fa51e2f-13a6-4c17-87e0-49f01d2107f1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "66fb9d2f-edbb-4314-85e2-8daf414a16f4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8f3e98aa-5628-4ff7-b1b2-5456a10a0c5f",
"CreateDate": "2026-07-24T01:25:36.3449948-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-24T01:25:36.3449948-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-24T01:25:36.3449948-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "63db79f4-7bf8-4877-b115-48cba09a6f81",
"Section": {
"FormTypeSectionId": "6b008dd0-c726-473e-a531-a9346b4dc20e",
"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": "5642b296-02f0-4d18-9f0f-b647689c24b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4146acff-84ea-4409-9632-617d74d9533d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "402735ea-620a-4cde-86fe-98a642e6166f",
"CreateDate": "2026-07-24T01:25:36.3449948-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-24T01:25:36.3449948-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9f31890f-ac79-42f8-8fb7-72075370108c",
"FieldId": "4a4591ec-1b57-4d1d-9a94-3813bc65955f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9f31890f-ac79-42f8-8fb7-72075370108c",
"FieldId": "4a4591ec-1b57-4d1d-9a94-3813bc65955f",
"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": "63db79f4-7bf8-4877-b115-48cba09a6f81",
"Section": {
"FormTypeSectionId": "6b008dd0-c726-473e-a531-a9346b4dc20e",
"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": "5642b296-02f0-4d18-9f0f-b647689c24b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4146acff-84ea-4409-9632-617d74d9533d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "402735ea-620a-4cde-86fe-98a642e6166f",
"CreateDate": "2026-07-24T01:25:36.3449948-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-24T01:25:36.3449948-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9f31890f-ac79-42f8-8fb7-72075370108c",
"FieldId": "4a4591ec-1b57-4d1d-9a94-3813bc65955f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9f31890f-ac79-42f8-8fb7-72075370108c",
"FieldId": "4a4591ec-1b57-4d1d-9a94-3813bc65955f",
"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": "1d971f5d-fdea-404f-bac3-e9ce2dd63fe4",
"CreateDate": "2026-07-24T01:25:36.3449948-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-24T01:25:36.3449948-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}