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": "b36825f2-8e65-4fe0-b4d2-9ea1a5f1ae9d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c5bc896f-b706-47fb-9aba-8251a588bb46",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "69a0411d-d1cf-4945-a29c-7ed45437d032",
"CreateDate": "2025-12-31T13:06:28.4463915-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T13:06:28.4463915-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-31T13:06:28.4463915-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "2378a6d0-d9e0-49b4-b608-4ba87df4f879",
"Section": {
"FormTypeSectionId": "0edbad8b-5787-4ceb-a322-b35073cafd67",
"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": "a27889a9-372c-4011-86c5-fdd916d0a2f0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dec550fa-1d8d-4a44-9540-944913cf0e85",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cb7178ff-c28b-4428-afd8-9904ee664a33",
"CreateDate": "2025-12-31T13:06:28.4463915-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T13:06:28.4463915-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fe6c6930-71ba-46fe-945e-e0796bd9e1f4",
"FieldId": "efb85071-b10f-4386-97d2-328f5c1743ed",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fe6c6930-71ba-46fe-945e-e0796bd9e1f4",
"FieldId": "efb85071-b10f-4386-97d2-328f5c1743ed",
"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": "2378a6d0-d9e0-49b4-b608-4ba87df4f879",
"Section": {
"FormTypeSectionId": "0edbad8b-5787-4ceb-a322-b35073cafd67",
"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": "a27889a9-372c-4011-86c5-fdd916d0a2f0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dec550fa-1d8d-4a44-9540-944913cf0e85",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cb7178ff-c28b-4428-afd8-9904ee664a33",
"CreateDate": "2025-12-31T13:06:28.4463915-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-31T13:06:28.4463915-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "fe6c6930-71ba-46fe-945e-e0796bd9e1f4",
"FieldId": "efb85071-b10f-4386-97d2-328f5c1743ed",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "fe6c6930-71ba-46fe-945e-e0796bd9e1f4",
"FieldId": "efb85071-b10f-4386-97d2-328f5c1743ed",
"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": "fba160fa-b3ea-43ab-aef0-5f9622d29551",
"CreateDate": "2025-12-31T13:06:28.4463915-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-31T13:06:28.4463915-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}