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": "634e8211-c0db-4b4a-8560-f41b8c3faab2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9e89a8d8-0a10-4e43-974c-15c16ea45b00",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8b05b396-0574-4a44-912a-e671d3e7fd2d",
"CreateDate": "2026-08-29T22:03:07.3133093-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T22:03:07.3133093-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-29T22:03:07.3133093-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e4bdd517-cc54-42ad-a5d6-a88216268c28",
"Section": {
"FormTypeSectionId": "4235b0c6-57a0-4083-a955-2c27402fe3d4",
"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": "a73a168e-70dd-4b4e-85ba-909252adce11",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7c96f900-97c1-411f-8a98-cdd22bacfda1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed836be-2af1-4587-9c26-2c826d086a62",
"CreateDate": "2026-08-29T22:03:07.3133093-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T22:03:07.3133093-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea4799cf-6e2f-4002-9f6e-5a4808720ec6",
"FieldId": "f5e67d09-45a6-4cbf-8ef5-c61321877d77",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea4799cf-6e2f-4002-9f6e-5a4808720ec6",
"FieldId": "f5e67d09-45a6-4cbf-8ef5-c61321877d77",
"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": "e4bdd517-cc54-42ad-a5d6-a88216268c28",
"Section": {
"FormTypeSectionId": "4235b0c6-57a0-4083-a955-2c27402fe3d4",
"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": "a73a168e-70dd-4b4e-85ba-909252adce11",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7c96f900-97c1-411f-8a98-cdd22bacfda1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "eed836be-2af1-4587-9c26-2c826d086a62",
"CreateDate": "2026-08-29T22:03:07.3133093-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T22:03:07.3133093-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea4799cf-6e2f-4002-9f6e-5a4808720ec6",
"FieldId": "f5e67d09-45a6-4cbf-8ef5-c61321877d77",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea4799cf-6e2f-4002-9f6e-5a4808720ec6",
"FieldId": "f5e67d09-45a6-4cbf-8ef5-c61321877d77",
"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": "db95dbb5-387a-4c83-bf8d-9ff416b19f97",
"CreateDate": "2026-08-29T22:03:07.3133093-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T22:03:07.3133093-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}