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": "4578ad8d-19e2-4384-8864-ac95e13ee6be",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "86fe61da-a550-4419-8028-668f2258265c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ab976bf-22a3-4ffd-bae4-6244cd5867e9",
"CreateDate": "2026-06-02T09:53:30.1298531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-02T09:53:30.1298531-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-02T09:53:30.1298531-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "bcb6947d-3dc9-4164-8eb5-8f8cbab1cdbc",
"Section": {
"FormTypeSectionId": "2938969e-fe57-4ee7-b86f-883627facf6c",
"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": "f634e14d-07d8-405e-8c04-d4f03537d5c1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c559f346-1975-4283-a856-caac918993b1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "75fe69f6-f21a-4f03-8737-172e89095c7c",
"CreateDate": "2026-06-02T09:53:30.1298531-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T09:53:30.1298531-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a21219da-4d9c-4a00-8595-64a081184d22",
"FieldId": "27cfe7d7-568f-43cf-bc13-15ea7312d302",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a21219da-4d9c-4a00-8595-64a081184d22",
"FieldId": "27cfe7d7-568f-43cf-bc13-15ea7312d302",
"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": "bcb6947d-3dc9-4164-8eb5-8f8cbab1cdbc",
"Section": {
"FormTypeSectionId": "2938969e-fe57-4ee7-b86f-883627facf6c",
"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": "f634e14d-07d8-405e-8c04-d4f03537d5c1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c559f346-1975-4283-a856-caac918993b1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "75fe69f6-f21a-4f03-8737-172e89095c7c",
"CreateDate": "2026-06-02T09:53:30.1298531-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-02T09:53:30.1298531-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a21219da-4d9c-4a00-8595-64a081184d22",
"FieldId": "27cfe7d7-568f-43cf-bc13-15ea7312d302",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a21219da-4d9c-4a00-8595-64a081184d22",
"FieldId": "27cfe7d7-568f-43cf-bc13-15ea7312d302",
"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": "b89f414f-f96b-46b3-a3a9-77feda4c01d7",
"CreateDate": "2026-06-02T09:53:30.1298531-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-02T09:53:30.1298531-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}