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": "e1c62b4b-3a0c-416b-87ba-ed5c10f53746",
"Asset": {
"AssetId": "049dd3b9-43f5-4d7f-a446-61691cc890e8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9b2d5d33-3695-4fbd-b24a-10e80baa2a5b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80ca3a58-8567-4964-a5bc-2436a92b1cf1",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7c6d95a6-a7a1-4be5-963e-9e6d50fd8956",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-13T23:46:44.2249456-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:46:44.2249456-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b0db26c4-b20a-45fb-802f-192a209c78e6",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-13T23:46:44.2249456-08:00",
"MeasurementValueNeededDate": "2026-01-13T23:46:44.2249456-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "377b53f0-608b-4dc1-9689-e1d1fad2822c",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "e20c41d8-611e-48e6-9ed0-565caa8d9561",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9b2d5d33-3695-4fbd-b24a-10e80baa2a5b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80ca3a58-8567-4964-a5bc-2436a92b1cf1",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-13T23:46:44.2249456-08:00",
"Fields": [
{
"FormTypeFieldId": "c7a60ec5-228c-455c-a28b-065cd3907147",
"Section": {
"FormTypeSectionId": "f7a47bb0-db64-434d-9afe-c51d1175e326",
"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": "438ccabd-a0f1-4abc-b927-aaeb8825531a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32cac6f0-e890-47c3-8e32-cbafed978057",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f9f7587-fb26-498d-b683-77a9ffae74ff",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08: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": "c7a60ec5-228c-455c-a28b-065cd3907147",
"Section": {
"FormTypeSectionId": "f7a47bb0-db64-434d-9afe-c51d1175e326",
"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": "438ccabd-a0f1-4abc-b927-aaeb8825531a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32cac6f0-e890-47c3-8e32-cbafed978057",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f9f7587-fb26-498d-b683-77a9ffae74ff",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08: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": "e0538720-b079-450a-9715-755e29b0fd8a",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-01-13T23:46:44.2249456-08:00",
"Location": "sample string 1",
"TaskId": "363ae713-f23c-4db7-9619-39b2f3dd52bf",
"Values": [
{
"FormFieldValueId": "00d4c508-5162-46b0-8cb4-e991258e68e9",
"FormTypeField": {
"FormTypeFieldId": "c7a60ec5-228c-455c-a28b-065cd3907147",
"Section": {
"FormTypeSectionId": "f7a47bb0-db64-434d-9afe-c51d1175e326",
"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": "438ccabd-a0f1-4abc-b927-aaeb8825531a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32cac6f0-e890-47c3-8e32-cbafed978057",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f9f7587-fb26-498d-b683-77a9ffae74ff",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08: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": "00d4c508-5162-46b0-8cb4-e991258e68e9",
"FormTypeField": {
"FormTypeFieldId": "c7a60ec5-228c-455c-a28b-065cd3907147",
"Section": {
"FormTypeSectionId": "f7a47bb0-db64-434d-9afe-c51d1175e326",
"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": "438ccabd-a0f1-4abc-b927-aaeb8825531a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32cac6f0-e890-47c3-8e32-cbafed978057",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f9f7587-fb26-498d-b683-77a9ffae74ff",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08: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": "8f9c2444-822b-46a8-ab3f-528e04a21387",
"CreateDate": "2026-01-13T23:46:44.2249456-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-13T23:46:44.2249456-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}