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": "5969da22-86eb-465d-8997-c62c0de5f54c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a22b814-803c-4d6c-af9c-5c52c497394d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2a2a61f8-796c-44b0-b9d7-04563328a9f7",
"CreateDate": "2026-04-19T20:56:04.9554211-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-19T20:56:04.9554211-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-19T20:56:04.9554211-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e8ed7bcf-05e6-49aa-beca-72ecc6ec7bad",
"Section": {
"FormTypeSectionId": "2acf78ca-6e7d-45fb-99a0-155a3a5fafc4",
"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": "11409de7-e97d-4b7a-8a90-30a563b1e06f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3a4da8a-52d1-4c5a-b691-042973c4af7a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8bb96c21-6f93-4da7-a561-0c35d07cea4b",
"CreateDate": "2026-04-19T20:56:04.9554211-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-19T20:56:04.9554211-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5329bf5b-7e11-456b-84d5-5035e9e5df6e",
"FieldId": "fcbe3cc3-ff4f-46d1-9dc6-72db1ccf0fb5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5329bf5b-7e11-456b-84d5-5035e9e5df6e",
"FieldId": "fcbe3cc3-ff4f-46d1-9dc6-72db1ccf0fb5",
"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": "e8ed7bcf-05e6-49aa-beca-72ecc6ec7bad",
"Section": {
"FormTypeSectionId": "2acf78ca-6e7d-45fb-99a0-155a3a5fafc4",
"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": "11409de7-e97d-4b7a-8a90-30a563b1e06f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3a4da8a-52d1-4c5a-b691-042973c4af7a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8bb96c21-6f93-4da7-a561-0c35d07cea4b",
"CreateDate": "2026-04-19T20:56:04.9554211-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-19T20:56:04.9554211-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5329bf5b-7e11-456b-84d5-5035e9e5df6e",
"FieldId": "fcbe3cc3-ff4f-46d1-9dc6-72db1ccf0fb5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5329bf5b-7e11-456b-84d5-5035e9e5df6e",
"FieldId": "fcbe3cc3-ff4f-46d1-9dc6-72db1ccf0fb5",
"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": "73f3214b-0d37-4131-bcbc-14026cd5c244",
"CreateDate": "2026-04-19T20:56:04.9554211-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-19T20:56:04.9554211-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}