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": "569212d1-c52b-4408-9035-a545fa109e69",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b7ff86b0-7be2-4dec-a12a-e4f4a5c99a97",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7dffff8a-69d4-46bb-948b-9d9e70c04359",
"CreateDate": "2026-05-10T21:44:34.7000192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-10T21:44:34.7000192-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-10T21:44:34.7000192-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "f7c52b16-c695-492b-ac9f-8d4c14f6a643",
"Section": {
"FormTypeSectionId": "43e0d57b-f9a4-4b9d-adea-648a6f733f36",
"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": "20ab715a-866a-42b2-be83-6ee39b64d632",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "16ac4666-453a-416f-942e-ea76f61a64c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c05c2b77-744b-4e6e-b58d-af2d5a12544d",
"CreateDate": "2026-05-10T21:44:34.7000192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-10T21:44:34.7000192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b24df2a5-e311-4f57-ae8a-3ff0f476cc92",
"FieldId": "eb9657c8-87bd-4538-b4cc-0edd5182d74e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b24df2a5-e311-4f57-ae8a-3ff0f476cc92",
"FieldId": "eb9657c8-87bd-4538-b4cc-0edd5182d74e",
"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": "f7c52b16-c695-492b-ac9f-8d4c14f6a643",
"Section": {
"FormTypeSectionId": "43e0d57b-f9a4-4b9d-adea-648a6f733f36",
"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": "20ab715a-866a-42b2-be83-6ee39b64d632",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "16ac4666-453a-416f-942e-ea76f61a64c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c05c2b77-744b-4e6e-b58d-af2d5a12544d",
"CreateDate": "2026-05-10T21:44:34.7000192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-10T21:44:34.7000192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b24df2a5-e311-4f57-ae8a-3ff0f476cc92",
"FieldId": "eb9657c8-87bd-4538-b4cc-0edd5182d74e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b24df2a5-e311-4f57-ae8a-3ff0f476cc92",
"FieldId": "eb9657c8-87bd-4538-b4cc-0edd5182d74e",
"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": "b83e7b44-f5bd-43a8-904e-32c3879f998e",
"CreateDate": "2026-05-10T21:44:34.7000192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-10T21:44:34.7000192-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}