GET Forms?formId={formId}
Retrieves a form by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formId |
Id of the form |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Form |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormId": "bd489e35-f16a-4a6f-b8de-46308eb5409a",
"Asset": {
"AssetId": "3c29dfe6-da86-464a-96ad-b7e7d9608459",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a644ec0-4aab-41df-bc9d-eba99543331a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "95b2170d-58fe-434d-b5f6-b88013e1257b",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5ad99946-ccb3-441e-bb19-c95ec80ba6aa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"MeasurementValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "695cbc0e-63d2-4913-a621-7db084e2f2da",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"MeasurementValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "52c8b8c2-5636-4431-bb11-0b782fb8afff",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "875c49b8-39f8-4028-a281-82e9e0989039",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5a644ec0-4aab-41df-bc9d-eba99543331a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "95b2170d-58fe-434d-b5f6-b88013e1257b",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "36f8033e-b66e-46c6-8e59-3877cf4377c1",
"Section": {
"FormTypeSectionId": "afc769b8-7584-4158-8411-db1eec8a515a",
"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": "56192fa5-aaf4-4e42-a504-177193be3ac5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cd5c6e31-0e1a-4848-a6ae-1b64af916299",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ee3de069-781c-414b-9174-203c6f7b7d88",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"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": "36f8033e-b66e-46c6-8e59-3877cf4377c1",
"Section": {
"FormTypeSectionId": "afc769b8-7584-4158-8411-db1eec8a515a",
"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": "56192fa5-aaf4-4e42-a504-177193be3ac5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cd5c6e31-0e1a-4848-a6ae-1b64af916299",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ee3de069-781c-414b-9174-203c6f7b7d88",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"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": "3082599a-6d82-4071-84de-020040e50d55",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-06-25T13:28:57.8020737-07:00",
"Location": "sample string 1",
"TaskId": "596b9b05-f413-4ff5-bde5-f9a70ec798a6",
"Values": [
{
"FormFieldValueId": "4910d634-c3a6-4303-b6ab-3cf1be6aec4d",
"FormId": "4541395c-0e99-43a5-9985-0f166e3ea654",
"FormTypeField": {
"FormTypeFieldId": "36f8033e-b66e-46c6-8e59-3877cf4377c1",
"FormType": {
"FormTypeId": "875c49b8-39f8-4028-a281-82e9e0989039",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5a644ec0-4aab-41df-bc9d-eba99543331a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "95b2170d-58fe-434d-b5f6-b88013e1257b",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "3082599a-6d82-4071-84de-020040e50d55",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "afc769b8-7584-4158-8411-db1eec8a515a",
"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": "56192fa5-aaf4-4e42-a504-177193be3ac5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cd5c6e31-0e1a-4848-a6ae-1b64af916299",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ee3de069-781c-414b-9174-203c6f7b7d88",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
},
{
"FormFieldValueId": "4910d634-c3a6-4303-b6ab-3cf1be6aec4d",
"FormId": "4541395c-0e99-43a5-9985-0f166e3ea654",
"FormTypeField": {
"FormTypeFieldId": "36f8033e-b66e-46c6-8e59-3877cf4377c1",
"FormType": {
"FormTypeId": "875c49b8-39f8-4028-a281-82e9e0989039",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5a644ec0-4aab-41df-bc9d-eba99543331a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "95b2170d-58fe-434d-b5f6-b88013e1257b",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-25T13:28:57.8020737-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "3082599a-6d82-4071-84de-020040e50d55",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "afc769b8-7584-4158-8411-db1eec8a515a",
"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": "56192fa5-aaf4-4e42-a504-177193be3ac5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cd5c6e31-0e1a-4848-a6ae-1b64af916299",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ee3de069-781c-414b-9174-203c6f7b7d88",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4d3aeb97-acf0-4542-86d2-04ce9810e0cb",
"FieldId": "7afcd156-218d-4492-b7c9-002bebc2fbe3",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
}
],
"SourceSystemId": "sample string 2",
"CompanyId": "bb752c16-1790-4f8a-9c51-27d6e947619b",
"CreateDate": "2026-06-25T13:28:57.8020737-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-25T13:28:57.8020737-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}