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": "aa2d4e5b-0f3e-45c0-9e7b-254e2df348f5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe514464-9393-4c2d-8cec-f6c5132fb2ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "597b6867-0deb-4552-b531-6c6b1c681c7f",
"CreateDate": "2026-03-30T09:58:53.4874938-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T09:58:53.4874938-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-30T09:58:53.4874938-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ff97cac7-9a7b-4163-baa6-6fc9a2ccb492",
"Section": {
"FormTypeSectionId": "15443c73-9293-4110-9a98-3ea180c4289b",
"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": "0eed0944-5ca9-4df3-9c04-ca449c725176",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8717cd96-1dd2-4154-ae0d-e9e4f12d4fd9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8851663d-a491-4f87-9405-77a4f570ee7f",
"CreateDate": "2026-03-30T09:58:53.4874938-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T09:58:53.4874938-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "169805c7-364b-4c75-b422-dca09bf30476",
"FieldId": "9f62e682-501e-429c-b89e-26c1bbba0bd3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "169805c7-364b-4c75-b422-dca09bf30476",
"FieldId": "9f62e682-501e-429c-b89e-26c1bbba0bd3",
"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": "ff97cac7-9a7b-4163-baa6-6fc9a2ccb492",
"Section": {
"FormTypeSectionId": "15443c73-9293-4110-9a98-3ea180c4289b",
"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": "0eed0944-5ca9-4df3-9c04-ca449c725176",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8717cd96-1dd2-4154-ae0d-e9e4f12d4fd9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8851663d-a491-4f87-9405-77a4f570ee7f",
"CreateDate": "2026-03-30T09:58:53.4874938-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T09:58:53.4874938-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "169805c7-364b-4c75-b422-dca09bf30476",
"FieldId": "9f62e682-501e-429c-b89e-26c1bbba0bd3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "169805c7-364b-4c75-b422-dca09bf30476",
"FieldId": "9f62e682-501e-429c-b89e-26c1bbba0bd3",
"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": "bc604a2f-cd40-4d93-a772-8aeceaeeb8ac",
"CreateDate": "2026-03-30T09:58:53.4874938-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T09:58:53.4874938-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}