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": "17caa424-725c-4cb0-98de-0b1d9068ad83",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "72e85f5e-a3e2-45c3-ac5d-c211856556f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c4ed631d-18a5-4091-a458-f9f27ba0b85f",
"CreateDate": "2025-12-24T02:46:04.833267-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-24T02:46:04.833267-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-24T02:46:04.833267-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "cd9df033-ae0d-4ba0-aa75-fd50010ee63e",
"Section": {
"FormTypeSectionId": "68619782-a857-4e30-b800-520e6eaeb241",
"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": "e491c2a8-9ba8-4c1b-8748-3cd5991e1e80",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "89acfabd-28a6-4899-bfb5-4cbc20918701",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8672809d-cfb9-404f-87cc-ced88f0cc854",
"CreateDate": "2025-12-24T02:46:04.833267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T02:46:04.833267-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2b98b4bd-82b9-4676-87c5-5ede43a01efd",
"FieldId": "e6ec805e-eb0e-456e-91a1-e6e9efbf8401",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2b98b4bd-82b9-4676-87c5-5ede43a01efd",
"FieldId": "e6ec805e-eb0e-456e-91a1-e6e9efbf8401",
"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": "cd9df033-ae0d-4ba0-aa75-fd50010ee63e",
"Section": {
"FormTypeSectionId": "68619782-a857-4e30-b800-520e6eaeb241",
"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": "e491c2a8-9ba8-4c1b-8748-3cd5991e1e80",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "89acfabd-28a6-4899-bfb5-4cbc20918701",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8672809d-cfb9-404f-87cc-ced88f0cc854",
"CreateDate": "2025-12-24T02:46:04.833267-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-24T02:46:04.833267-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2b98b4bd-82b9-4676-87c5-5ede43a01efd",
"FieldId": "e6ec805e-eb0e-456e-91a1-e6e9efbf8401",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2b98b4bd-82b9-4676-87c5-5ede43a01efd",
"FieldId": "e6ec805e-eb0e-456e-91a1-e6e9efbf8401",
"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": "99e9c865-9c72-489f-b5ad-6f315951d1af",
"CreateDate": "2025-12-24T02:46:04.833267-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-24T02:46:04.833267-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}