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": "477c06f9-b613-4c12-b4db-0da57980b1c9",
"Asset": {
"AssetId": "55c812d6-c156-4a28-b00f-362ab6a2fc2a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "93de33e5-a82f-4fd1-939e-e7ffdaf90667",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "831839c6-6bcd-4cda-9e73-4188dca28def",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "31d0e6d0-ec70-4517-81f4-18f929985435",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T17:48:41.9872823-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:48:41.9872823-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bab74994-52da-4c34-a9de-5b8bf945fa0e",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-13T17:48:41.9872823-07:00",
"MeasurementValueNeededDate": "2026-06-13T17:48:41.9872823-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cf71fc10-55c3-458b-be6e-72ba13b80031",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c1dd94ee-c1d1-4718-9aeb-c44620b3f566",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "93de33e5-a82f-4fd1-939e-e7ffdaf90667",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "831839c6-6bcd-4cda-9e73-4188dca28def",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-13T17:48:41.9872823-07:00",
"Fields": [
{
"FormTypeFieldId": "3ad90a2d-57cf-4100-b3e5-19ae1d1bd5e5",
"Section": {
"FormTypeSectionId": "e0afd831-a554-4da0-8003-748d9a0fd864",
"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": "178ce2f0-7332-4204-b67a-b7f3cade805c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4ecf656-0bc4-4c71-984d-fc5fd92bbb3f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "70b09b92-c46d-477f-96cc-75ec6e606dab",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-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": "3ad90a2d-57cf-4100-b3e5-19ae1d1bd5e5",
"Section": {
"FormTypeSectionId": "e0afd831-a554-4da0-8003-748d9a0fd864",
"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": "178ce2f0-7332-4204-b67a-b7f3cade805c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4ecf656-0bc4-4c71-984d-fc5fd92bbb3f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "70b09b92-c46d-477f-96cc-75ec6e606dab",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-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": "f99ff247-3692-4287-b21f-4776c65ea929",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-13T17:48:41.9872823-07:00",
"Location": "sample string 1",
"TaskId": "ff99a285-e50e-402d-a390-a03e80d091f6",
"Values": [
{
"FormFieldValueId": "56754534-261e-4547-a9f7-9c0e8c54cb64",
"FormTypeField": {
"FormTypeFieldId": "3ad90a2d-57cf-4100-b3e5-19ae1d1bd5e5",
"Section": {
"FormTypeSectionId": "e0afd831-a554-4da0-8003-748d9a0fd864",
"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": "178ce2f0-7332-4204-b67a-b7f3cade805c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4ecf656-0bc4-4c71-984d-fc5fd92bbb3f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "70b09b92-c46d-477f-96cc-75ec6e606dab",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-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": "56754534-261e-4547-a9f7-9c0e8c54cb64",
"FormTypeField": {
"FormTypeFieldId": "3ad90a2d-57cf-4100-b3e5-19ae1d1bd5e5",
"Section": {
"FormTypeSectionId": "e0afd831-a554-4da0-8003-748d9a0fd864",
"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": "178ce2f0-7332-4204-b67a-b7f3cade805c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c4ecf656-0bc4-4c71-984d-fc5fd92bbb3f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "70b09b92-c46d-477f-96cc-75ec6e606dab",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-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": "c7d8d579-8ca0-4652-8d49-6a2a910b7505",
"CreateDate": "2026-06-13T17:48:41.9872823-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T17:48:41.9872823-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}