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": "b2278288-9a4b-445c-9cb3-8ff62ae63277",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "356156a1-3732-473d-a4f9-51dee596e2aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8ba207d2-4252-474f-be75-57a79719d4b5",
"CreateDate": "2026-08-26T15:38:51.3497224-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-26T15:38:51.3497224-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-26T15:38:51.3497224-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "eba6f00c-750a-4e75-b302-41d5bf53e40c",
"Section": {
"FormTypeSectionId": "fb635ef4-a053-4aad-8647-681eb4a60039",
"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": "3d9330cc-aa46-4c99-9558-286f1bca7233",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "371756c3-811d-445e-bfc7-3f4c502f9f22",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a1b7af8a-abde-45e7-851e-b2ed82c8770e",
"CreateDate": "2026-08-26T15:38:51.3497224-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T15:38:51.3497224-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0be38803-0cd9-476f-ac94-66005ce8d22d",
"FieldId": "d00abc5e-8f0f-4c72-9e6a-21b531ac5e99",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0be38803-0cd9-476f-ac94-66005ce8d22d",
"FieldId": "d00abc5e-8f0f-4c72-9e6a-21b531ac5e99",
"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": "eba6f00c-750a-4e75-b302-41d5bf53e40c",
"Section": {
"FormTypeSectionId": "fb635ef4-a053-4aad-8647-681eb4a60039",
"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": "3d9330cc-aa46-4c99-9558-286f1bca7233",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "371756c3-811d-445e-bfc7-3f4c502f9f22",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a1b7af8a-abde-45e7-851e-b2ed82c8770e",
"CreateDate": "2026-08-26T15:38:51.3497224-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T15:38:51.3497224-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0be38803-0cd9-476f-ac94-66005ce8d22d",
"FieldId": "d00abc5e-8f0f-4c72-9e6a-21b531ac5e99",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0be38803-0cd9-476f-ac94-66005ce8d22d",
"FieldId": "d00abc5e-8f0f-4c72-9e6a-21b531ac5e99",
"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": "d2822608-68c1-4858-8d6c-062becf05555",
"CreateDate": "2026-08-26T15:38:51.3497224-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-26T15:38:51.3497224-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}