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": "7f9e0bfa-59d4-40c5-98f8-047b920f1a4c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "98447351-c58d-4e45-b653-ad59d23a00f6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "90d99b9f-f85e-4b06-a6d8-bb97384e62b6",
"CreateDate": "2026-05-01T23:59:50.0780486-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-01T23:59:50.0780486-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-01T23:59:50.0780486-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "644e27bb-e04e-42fa-a82f-ec9720b0122f",
"Section": {
"FormTypeSectionId": "ee9e554d-17ba-4768-9770-cc7f196bd89b",
"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": "aa0a167f-f5c0-4e45-89f0-2f0a97b29bb5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c1a346dc-fe3e-481e-a4c2-4b623a666322",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bfc0d315-9dfd-4b80-a350-ffb17457ce41",
"CreateDate": "2026-05-01T23:59:50.0780486-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T23:59:50.0780486-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "227c9401-4814-48a4-a3f2-520a9ec0a43c",
"FieldId": "403d0a7e-561f-4ef1-9c86-eabd219e7504",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "227c9401-4814-48a4-a3f2-520a9ec0a43c",
"FieldId": "403d0a7e-561f-4ef1-9c86-eabd219e7504",
"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": "644e27bb-e04e-42fa-a82f-ec9720b0122f",
"Section": {
"FormTypeSectionId": "ee9e554d-17ba-4768-9770-cc7f196bd89b",
"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": "aa0a167f-f5c0-4e45-89f0-2f0a97b29bb5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c1a346dc-fe3e-481e-a4c2-4b623a666322",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bfc0d315-9dfd-4b80-a350-ffb17457ce41",
"CreateDate": "2026-05-01T23:59:50.0780486-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T23:59:50.0780486-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "227c9401-4814-48a4-a3f2-520a9ec0a43c",
"FieldId": "403d0a7e-561f-4ef1-9c86-eabd219e7504",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "227c9401-4814-48a4-a3f2-520a9ec0a43c",
"FieldId": "403d0a7e-561f-4ef1-9c86-eabd219e7504",
"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": "2fbb51ce-7c36-45e2-901a-c8344f8f7ac9",
"CreateDate": "2026-05-01T23:59:50.0780486-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-01T23:59:50.0780486-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}