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": "5a56b3b4-4a6d-4ce1-a119-cf4611b35a65",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "86e19c84-0d9b-49f6-a1fa-1d6a44be8ecb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1aac53d6-5040-4424-aa8d-96b142ddcd0f",
"CreateDate": "2026-04-02T14:40:44.2922551-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-02T14:40:44.2922551-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-02T14:40:44.2922551-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "684356c6-6fd3-4390-aae0-85800f0e4e8b",
"Section": {
"FormTypeSectionId": "d9e4b2aa-31db-46db-92f6-7f7f318a33ad",
"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": "d9e4399e-a925-4686-a67f-95c8b14ffe13",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0bb9e1b5-60ba-486a-8650-e65236dac689",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8de80eb5-49a0-4372-afa5-9392b0976c8b",
"CreateDate": "2026-04-02T14:40:44.2922551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T14:40:44.2922551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e15ff4f0-6c98-404a-b9f4-bcf944b60dc9",
"FieldId": "009375cd-aae1-4cca-8f00-fd36ab9b7f57",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e15ff4f0-6c98-404a-b9f4-bcf944b60dc9",
"FieldId": "009375cd-aae1-4cca-8f00-fd36ab9b7f57",
"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": "684356c6-6fd3-4390-aae0-85800f0e4e8b",
"Section": {
"FormTypeSectionId": "d9e4b2aa-31db-46db-92f6-7f7f318a33ad",
"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": "d9e4399e-a925-4686-a67f-95c8b14ffe13",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0bb9e1b5-60ba-486a-8650-e65236dac689",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8de80eb5-49a0-4372-afa5-9392b0976c8b",
"CreateDate": "2026-04-02T14:40:44.2922551-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-02T14:40:44.2922551-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e15ff4f0-6c98-404a-b9f4-bcf944b60dc9",
"FieldId": "009375cd-aae1-4cca-8f00-fd36ab9b7f57",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e15ff4f0-6c98-404a-b9f4-bcf944b60dc9",
"FieldId": "009375cd-aae1-4cca-8f00-fd36ab9b7f57",
"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": "7fd17650-c78e-4351-8a32-77a01e27ab62",
"CreateDate": "2026-04-02T14:40:44.2922551-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-02T14:40:44.2922551-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}