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": "f2fa0d44-d482-4810-9e2f-bebe24937118",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "79ce308d-3e51-4b30-a1c9-2ee9b09cd3e1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2316376e-5a15-45db-a23a-e6f94924a841",
"CreateDate": "2026-09-14T02:35:01.1571762-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T02:35:01.1571762-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-14T02:35:01.1571762-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ca218c70-06a2-473e-9ec0-a70f26f95d0e",
"Section": {
"FormTypeSectionId": "8dca6304-a69c-4c8f-a200-07d4669c1382",
"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": "0cda954a-4404-45a3-92da-a0fe09747231",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e1f906f-65e4-490c-b02a-bc425343dc4c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "43263425-6a27-4304-9f87-258da0eab449",
"CreateDate": "2026-09-14T02:35:01.1571762-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T02:35:01.1571762-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "559b1502-f3a5-47a0-bc8b-f889a5a758e9",
"FieldId": "28fa5985-134e-4f8d-8e6b-c0992d9925c2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "559b1502-f3a5-47a0-bc8b-f889a5a758e9",
"FieldId": "28fa5985-134e-4f8d-8e6b-c0992d9925c2",
"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": "ca218c70-06a2-473e-9ec0-a70f26f95d0e",
"Section": {
"FormTypeSectionId": "8dca6304-a69c-4c8f-a200-07d4669c1382",
"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": "0cda954a-4404-45a3-92da-a0fe09747231",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e1f906f-65e4-490c-b02a-bc425343dc4c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "43263425-6a27-4304-9f87-258da0eab449",
"CreateDate": "2026-09-14T02:35:01.1571762-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T02:35:01.1571762-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "559b1502-f3a5-47a0-bc8b-f889a5a758e9",
"FieldId": "28fa5985-134e-4f8d-8e6b-c0992d9925c2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "559b1502-f3a5-47a0-bc8b-f889a5a758e9",
"FieldId": "28fa5985-134e-4f8d-8e6b-c0992d9925c2",
"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": "525f413c-443f-4a3f-b728-7574ce93ecc2",
"CreateDate": "2026-09-14T02:35:01.1571762-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T02:35:01.1571762-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}