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": "bb246ea2-556a-4556-8fd6-df4a31ec4595",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "de949ce3-2cb9-4842-b36a-9b481ae6e8b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9cec423e-b16b-4b48-b7ff-4f847403b8c7",
"CreateDate": "2026-09-29T05:11:10.5473478-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-29T05:11:10.5473478-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-29T05:11:10.5473478-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "2b23432d-9ce3-43df-a380-56bc5e9613a3",
"Section": {
"FormTypeSectionId": "8b3af0d0-6b60-4687-8d16-20cead7b2b05",
"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": "a21828f9-7aaa-4baa-9831-e196bdd051aa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "86643540-70b1-4974-b672-1baea632abe8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "706c1245-7368-4385-a494-5108e10cea5d",
"CreateDate": "2026-09-29T05:11:10.5473478-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-29T05:11:10.5473478-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9c6a3621-185f-421f-83aa-dcf5d664c9cc",
"FieldId": "df501fc5-1616-4ad8-b052-f66f4c7c9649",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9c6a3621-185f-421f-83aa-dcf5d664c9cc",
"FieldId": "df501fc5-1616-4ad8-b052-f66f4c7c9649",
"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": "2b23432d-9ce3-43df-a380-56bc5e9613a3",
"Section": {
"FormTypeSectionId": "8b3af0d0-6b60-4687-8d16-20cead7b2b05",
"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": "a21828f9-7aaa-4baa-9831-e196bdd051aa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "86643540-70b1-4974-b672-1baea632abe8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "706c1245-7368-4385-a494-5108e10cea5d",
"CreateDate": "2026-09-29T05:11:10.5473478-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-29T05:11:10.5473478-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9c6a3621-185f-421f-83aa-dcf5d664c9cc",
"FieldId": "df501fc5-1616-4ad8-b052-f66f4c7c9649",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9c6a3621-185f-421f-83aa-dcf5d664c9cc",
"FieldId": "df501fc5-1616-4ad8-b052-f66f4c7c9649",
"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": "056d248e-0dd1-4812-b31c-1ab17e310b00",
"CreateDate": "2026-09-29T05:11:10.5473478-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-29T05:11:10.5473478-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}