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": "19144f86-81b8-4a04-8843-ad136726e68d",
"Asset": {
"AssetId": "8b31c97d-c6de-4eb1-8fff-85861f28ad3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8dba84e9-1edc-471c-a0e0-2005739fdc26",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "46065736-9b0e-42c6-8de9-1dd8834082e7",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f658625f-9c1c-447e-9c49-1ac5850b39be",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-04T12:33:27.2013939-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:27.2013939-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8c4b481b-e30e-4e1e-b680-6476dcb57caa",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-04T12:33:27.2013939-07:00",
"MeasurementValueNeededDate": "2026-05-04T12:33:27.2013939-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "33125677-e79e-49dd-9650-d31159b4b7a9",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "20b2ca28-43e1-4a03-8976-f7e533b850d8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8dba84e9-1edc-471c-a0e0-2005739fdc26",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "46065736-9b0e-42c6-8de9-1dd8834082e7",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-04T12:33:27.2013939-07:00",
"Fields": [
{
"FormTypeFieldId": "69f1607e-78bc-4223-a1ed-fc26b09d8f96",
"Section": {
"FormTypeSectionId": "18fc70cb-e60a-44dc-bc8d-ce2ddb690571",
"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": "29983780-617c-4f3c-8811-1ebcdb1be522",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad5bb67d-7deb-423d-b42a-e73e1ec4a43f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f58d1c0-4935-4174-b936-36d61fc033a2",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "69f1607e-78bc-4223-a1ed-fc26b09d8f96",
"Section": {
"FormTypeSectionId": "18fc70cb-e60a-44dc-bc8d-ce2ddb690571",
"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": "29983780-617c-4f3c-8811-1ebcdb1be522",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad5bb67d-7deb-423d-b42a-e73e1ec4a43f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f58d1c0-4935-4174-b936-36d61fc033a2",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "f6d3797a-aec7-489d-903b-ffb7cbe7c74b",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-04T12:33:27.2013939-07:00",
"Location": "sample string 1",
"TaskId": "93b56d4e-0e5f-4f56-9b6b-a564b34c6b4d",
"Values": [
{
"FormFieldValueId": "4e8ca209-1f76-4a90-a570-9eccbe11c75a",
"FormTypeField": {
"FormTypeFieldId": "69f1607e-78bc-4223-a1ed-fc26b09d8f96",
"Section": {
"FormTypeSectionId": "18fc70cb-e60a-44dc-bc8d-ce2ddb690571",
"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": "29983780-617c-4f3c-8811-1ebcdb1be522",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad5bb67d-7deb-423d-b42a-e73e1ec4a43f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f58d1c0-4935-4174-b936-36d61fc033a2",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "4e8ca209-1f76-4a90-a570-9eccbe11c75a",
"FormTypeField": {
"FormTypeFieldId": "69f1607e-78bc-4223-a1ed-fc26b09d8f96",
"Section": {
"FormTypeSectionId": "18fc70cb-e60a-44dc-bc8d-ce2ddb690571",
"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": "29983780-617c-4f3c-8811-1ebcdb1be522",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ad5bb67d-7deb-423d-b42a-e73e1ec4a43f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1f58d1c0-4935-4174-b936-36d61fc033a2",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "c53680d6-a48e-4828-b7c2-1aa8a009a5a5",
"CreateDate": "2026-05-04T12:33:27.2013939-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-04T12:33:27.2013939-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}