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": "fb4a722b-ad9c-4c89-92a3-bbdc5d6bb85a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "23278851-bcb7-4db0-b3fc-7780161553d1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7e7c6984-5600-411b-8640-9e45b491ccb8",
"CreateDate": "2026-02-21T22:48:51.6960254-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-21T22:48:51.6960254-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-21T22:48:51.6960254-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "b2344e29-6cf9-48d9-bd4a-6c28be8f5d7d",
"Section": {
"FormTypeSectionId": "1ef1ccf7-7e31-4a7d-bde2-a40948dc6291",
"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": "62ab7f56-bd71-4f30-9883-383dfba78a7d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "086b0f97-5d72-431b-b821-6b343889c729",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d4f6cf5a-d0f7-4c7b-8450-7556845e34e8",
"CreateDate": "2026-02-21T22:48:51.6960254-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-21T22:48:51.6960254-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6bea1172-3791-4c1c-8b95-68b24d0f9e30",
"FieldId": "54178ef1-1406-498e-918f-cff31e00f282",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6bea1172-3791-4c1c-8b95-68b24d0f9e30",
"FieldId": "54178ef1-1406-498e-918f-cff31e00f282",
"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": "b2344e29-6cf9-48d9-bd4a-6c28be8f5d7d",
"Section": {
"FormTypeSectionId": "1ef1ccf7-7e31-4a7d-bde2-a40948dc6291",
"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": "62ab7f56-bd71-4f30-9883-383dfba78a7d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "086b0f97-5d72-431b-b821-6b343889c729",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d4f6cf5a-d0f7-4c7b-8450-7556845e34e8",
"CreateDate": "2026-02-21T22:48:51.6960254-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-21T22:48:51.6960254-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6bea1172-3791-4c1c-8b95-68b24d0f9e30",
"FieldId": "54178ef1-1406-498e-918f-cff31e00f282",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6bea1172-3791-4c1c-8b95-68b24d0f9e30",
"FieldId": "54178ef1-1406-498e-918f-cff31e00f282",
"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": "8d7c7124-0a88-4ced-99db-ff21b732c6f8",
"CreateDate": "2026-02-21T22:48:51.6960254-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-21T22:48:51.6960254-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}