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": "c109cda5-6271-47e1-99a3-84918cea0726",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a077b15e-8fdf-44df-8a92-df39bf3e02b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "56a4f61b-b299-4e7d-80aa-e5899ef679cf",
"CreateDate": "2026-08-16T07:35:26.5399981-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-16T07:35:26.5399981-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-16T07:35:26.5399981-07:00",
"Fields": [
{
"FormTypeFieldId": "bcd030d4-88bb-457b-8490-9646b4673f26",
"Section": {
"FormTypeSectionId": "350dddd4-99cf-473b-b0ba-89d084f11f6f",
"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": "da758e4e-f409-4ef5-bf74-79782491c639",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "01402c85-37d8-4698-a7b4-a8158a2d4cc8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "57564dc9-8066-4af7-a6ef-397518d42a20",
"CreateDate": "2026-08-16T07:35:26.5399981-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:35:26.5399981-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "bcd030d4-88bb-457b-8490-9646b4673f26",
"Section": {
"FormTypeSectionId": "350dddd4-99cf-473b-b0ba-89d084f11f6f",
"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": "da758e4e-f409-4ef5-bf74-79782491c639",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "01402c85-37d8-4698-a7b4-a8158a2d4cc8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "57564dc9-8066-4af7-a6ef-397518d42a20",
"CreateDate": "2026-08-16T07:35:26.5399981-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:35:26.5399981-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "2bd89485-6eca-4cfb-b368-e16560936a7c",
"CreateDate": "2026-08-16T07:35:26.5399981-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:35:26.5399981-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}