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": "ac99f734-4552-4418-93c9-a38bc1ba9cfc",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2a929dc6-f11b-4851-8fa2-662bbd6f94b3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "752fd59b-d10d-4170-8923-5255a49fad28",
"CreateDate": "2026-02-04T11:53:17.4583659-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-04T11:53:17.4583659-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-04T11:53:17.4583659-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "6eb440b6-3c92-4667-b43d-7c7de9579bd4",
"Section": {
"FormTypeSectionId": "798526f2-b05a-4cd1-8f18-a2f8e0b3c6a5",
"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": "7ccf9a0a-fe43-4430-9840-38b3e410a4d6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "85ced05e-851d-4483-89d1-36649c9a94ed",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "84bfe474-2a09-4bdd-9f76-34bfc1f07078",
"CreateDate": "2026-02-04T11:53:17.4583659-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-04T11:53:17.4583659-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4765a455-ca07-47a8-95ff-3c568e5082d6",
"FieldId": "5afd9930-af2a-4c82-a71f-56b9da0a8e7b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4765a455-ca07-47a8-95ff-3c568e5082d6",
"FieldId": "5afd9930-af2a-4c82-a71f-56b9da0a8e7b",
"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": "6eb440b6-3c92-4667-b43d-7c7de9579bd4",
"Section": {
"FormTypeSectionId": "798526f2-b05a-4cd1-8f18-a2f8e0b3c6a5",
"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": "7ccf9a0a-fe43-4430-9840-38b3e410a4d6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "85ced05e-851d-4483-89d1-36649c9a94ed",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "84bfe474-2a09-4bdd-9f76-34bfc1f07078",
"CreateDate": "2026-02-04T11:53:17.4583659-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-04T11:53:17.4583659-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4765a455-ca07-47a8-95ff-3c568e5082d6",
"FieldId": "5afd9930-af2a-4c82-a71f-56b9da0a8e7b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4765a455-ca07-47a8-95ff-3c568e5082d6",
"FieldId": "5afd9930-af2a-4c82-a71f-56b9da0a8e7b",
"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": "15d000a7-da53-4662-bd5c-1228157422f1",
"CreateDate": "2026-02-04T11:53:17.4583659-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-04T11:53:17.4583659-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}