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": "19bafb2d-952e-427a-b90a-773b65b06ee4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "adae8c68-8303-4f1b-b72b-3746b40af31e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "632e3304-225c-4846-b2ad-9536dfd5a88b",
"CreateDate": "2026-09-05T00:41:04.8557934-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T00:41:04.8557934-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-05T00:41:04.8557934-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "4ec04a70-ae93-4680-8977-870e6f447385",
"Section": {
"FormTypeSectionId": "f3e17077-a2d0-44ce-9642-9faaddeb3764",
"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": "a9d07d84-005b-4186-957d-1ce3d5f131d5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4ed598c0-8475-4647-931c-25112d47cb76",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b7681b62-e005-4ec4-a32c-5e19a2e0898b",
"CreateDate": "2026-09-05T00:41:04.8557934-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T00:41:04.8557934-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "494e413c-084a-4a5d-ada5-815105e7788d",
"FieldId": "b9edbf9d-dad1-47a6-96f6-fac215270dd9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "494e413c-084a-4a5d-ada5-815105e7788d",
"FieldId": "b9edbf9d-dad1-47a6-96f6-fac215270dd9",
"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": "4ec04a70-ae93-4680-8977-870e6f447385",
"Section": {
"FormTypeSectionId": "f3e17077-a2d0-44ce-9642-9faaddeb3764",
"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": "a9d07d84-005b-4186-957d-1ce3d5f131d5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4ed598c0-8475-4647-931c-25112d47cb76",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b7681b62-e005-4ec4-a32c-5e19a2e0898b",
"CreateDate": "2026-09-05T00:41:04.8557934-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T00:41:04.8557934-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "494e413c-084a-4a5d-ada5-815105e7788d",
"FieldId": "b9edbf9d-dad1-47a6-96f6-fac215270dd9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "494e413c-084a-4a5d-ada5-815105e7788d",
"FieldId": "b9edbf9d-dad1-47a6-96f6-fac215270dd9",
"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": "19b2dd26-5cbc-4d6a-b273-8f5308eb6ca9",
"CreateDate": "2026-09-05T00:41:04.8557934-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T00:41:04.8557934-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}