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": "08e0034e-1e4e-4bdd-a768-996e9fb4f27f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fdf9fe69-c002-45e1-9b29-38a3a1620a50",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "66a5f218-f42f-435f-8139-609e7d2c7637",
"CreateDate": "2026-04-09T08:31:30.0450627-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T08:31:30.0450627-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-09T08:31:30.0450627-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "57d0b21e-ed65-43bf-8306-ea714008800c",
"Section": {
"FormTypeSectionId": "c26132c4-330a-4493-af50-d10814a45870",
"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": "58dc2972-8fc0-4141-8fe3-6d2ff79c8c96",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e6d69935-4854-4fe5-8043-1c5613a9a9e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "69865d2e-1bc7-476e-9321-3886f3b2b56f",
"CreateDate": "2026-04-09T08:31:30.0450627-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T08:31:30.0450627-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d4acae50-ba78-41ea-b887-c38a09afcd93",
"FieldId": "3c44e78c-b5d9-4b68-89ac-64f8f292b473",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d4acae50-ba78-41ea-b887-c38a09afcd93",
"FieldId": "3c44e78c-b5d9-4b68-89ac-64f8f292b473",
"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": "57d0b21e-ed65-43bf-8306-ea714008800c",
"Section": {
"FormTypeSectionId": "c26132c4-330a-4493-af50-d10814a45870",
"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": "58dc2972-8fc0-4141-8fe3-6d2ff79c8c96",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e6d69935-4854-4fe5-8043-1c5613a9a9e8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "69865d2e-1bc7-476e-9321-3886f3b2b56f",
"CreateDate": "2026-04-09T08:31:30.0450627-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T08:31:30.0450627-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d4acae50-ba78-41ea-b887-c38a09afcd93",
"FieldId": "3c44e78c-b5d9-4b68-89ac-64f8f292b473",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d4acae50-ba78-41ea-b887-c38a09afcd93",
"FieldId": "3c44e78c-b5d9-4b68-89ac-64f8f292b473",
"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": "7f6c007a-a927-4ca8-b924-bcbe220eb1dc",
"CreateDate": "2026-04-09T08:31:30.0450627-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T08:31:30.0450627-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}