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": "b92332e5-2990-4519-9d27-ab1518cf7e73",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "32a79d04-2a63-4ed8-9346-b810559c395c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7b4d56ef-ebcd-4dc8-9881-bc272114a21c",
"CreateDate": "2026-10-11T11:58:48.203269-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-11T11:58:48.203269-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-11T11:58:48.203269-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "9ed60e17-3140-42e2-ac2b-f25a4321d117",
"Section": {
"FormTypeSectionId": "b0f1b068-18d0-42f6-a942-38b1291ee47e",
"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": "d1cbcde5-82b6-4554-819c-e34387659ffc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eee051ff-8289-4448-8de6-8dd3cd25dbc9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "44126b56-8d7c-4d75-a3cc-f791e78ac17c",
"CreateDate": "2026-10-11T11:58:48.203269-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T11:58:48.203269-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c83045b1-b68c-40a8-8e9e-3538f2991f93",
"FieldId": "c32466f2-0b80-416b-9824-537bb736cf2d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c83045b1-b68c-40a8-8e9e-3538f2991f93",
"FieldId": "c32466f2-0b80-416b-9824-537bb736cf2d",
"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": "9ed60e17-3140-42e2-ac2b-f25a4321d117",
"Section": {
"FormTypeSectionId": "b0f1b068-18d0-42f6-a942-38b1291ee47e",
"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": "d1cbcde5-82b6-4554-819c-e34387659ffc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "eee051ff-8289-4448-8de6-8dd3cd25dbc9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "44126b56-8d7c-4d75-a3cc-f791e78ac17c",
"CreateDate": "2026-10-11T11:58:48.203269-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-11T11:58:48.203269-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c83045b1-b68c-40a8-8e9e-3538f2991f93",
"FieldId": "c32466f2-0b80-416b-9824-537bb736cf2d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c83045b1-b68c-40a8-8e9e-3538f2991f93",
"FieldId": "c32466f2-0b80-416b-9824-537bb736cf2d",
"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": "b2ba99e7-6c30-4f00-9181-4786011603b0",
"CreateDate": "2026-10-11T11:58:48.203269-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-11T11:58:48.203269-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}