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": "6c0ff545-af53-4de9-a631-018897813970",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7eed3d6c-8bb2-41e6-b68b-b3dca6bbca70",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d9a98ace-4aa4-4574-9d6a-c802e228fbc5",
"CreateDate": "2026-08-20T14:08:24.2054049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-20T14:08:24.2054049-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-20T14:08:24.2054049-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "08f4b1e9-77e2-41ea-a95c-c6dc4ba94a97",
"Section": {
"FormTypeSectionId": "6beb9845-31d8-4833-a0cb-3d95f7ba2c05",
"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": "d5bfe5da-adb4-443c-9f31-0d7510b1f13b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d6af86a2-c249-40c9-81ca-2c53436ae214",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2a9aea12-6178-4703-89f0-873da463b021",
"CreateDate": "2026-08-20T14:08:24.2054049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-20T14:08:24.2054049-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c86ead4d-19e2-474a-9fce-c96556ddc05a",
"FieldId": "e3255b4b-ee45-41bb-b4c0-49b81cba005d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c86ead4d-19e2-474a-9fce-c96556ddc05a",
"FieldId": "e3255b4b-ee45-41bb-b4c0-49b81cba005d",
"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": "08f4b1e9-77e2-41ea-a95c-c6dc4ba94a97",
"Section": {
"FormTypeSectionId": "6beb9845-31d8-4833-a0cb-3d95f7ba2c05",
"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": "d5bfe5da-adb4-443c-9f31-0d7510b1f13b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d6af86a2-c249-40c9-81ca-2c53436ae214",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2a9aea12-6178-4703-89f0-873da463b021",
"CreateDate": "2026-08-20T14:08:24.2054049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-20T14:08:24.2054049-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c86ead4d-19e2-474a-9fce-c96556ddc05a",
"FieldId": "e3255b4b-ee45-41bb-b4c0-49b81cba005d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c86ead4d-19e2-474a-9fce-c96556ddc05a",
"FieldId": "e3255b4b-ee45-41bb-b4c0-49b81cba005d",
"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": "2639966e-0180-4d0b-bb84-8eccdf407679",
"CreateDate": "2026-08-20T14:08:24.2054049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-20T14:08:24.2054049-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}