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": "0c297db0-90b4-49d0-8e22-5eb95f2e434d",
"Asset": {
"AssetId": "ce0a0613-7e4a-4bb0-8b4b-8e26d8308b0e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "94e041d0-f1e3-4b63-b439-3bd65ccd9200",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b73aeaf3-1b4d-4fb0-b06a-6417e361e5d3",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4119465d-8e8c-47ec-ba36-11789178c9a7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T15:32:28.6864417-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:28.6864417-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c0916a65-58d7-407e-907a-1039dfb42853",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T15:32:28.6864417-08:00",
"MeasurementValueNeededDate": "2026-11-21T15:32:28.6864417-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "129eb3e8-50a8-4a36-b8db-2b4ffc06e7ce",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "3b490db2-a8fc-4847-9b1b-788a1ebe55c0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "94e041d0-f1e3-4b63-b439-3bd65ccd9200",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b73aeaf3-1b4d-4fb0-b06a-6417e361e5d3",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T15:32:28.6864417-08:00",
"Fields": [
{
"FormTypeFieldId": "d28847d9-e36d-47b5-b25c-428cf297ce4f",
"Section": {
"FormTypeSectionId": "d8caf2ce-78cc-49f7-95db-78e1daa4e7fc",
"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": "43eb31a3-f370-4b01-a86d-10641df9bfab",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34055794-96c5-4600-86d0-8dc3c03f1583",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb45aa2c-3d88-4c79-8e8e-f8dbffe569df",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-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": "d28847d9-e36d-47b5-b25c-428cf297ce4f",
"Section": {
"FormTypeSectionId": "d8caf2ce-78cc-49f7-95db-78e1daa4e7fc",
"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": "43eb31a3-f370-4b01-a86d-10641df9bfab",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34055794-96c5-4600-86d0-8dc3c03f1583",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb45aa2c-3d88-4c79-8e8e-f8dbffe569df",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-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": "20cc0da3-d293-4343-a420-635f59392e65",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-11-21T15:32:28.6864417-08:00",
"Location": "sample string 1",
"TaskId": "476a3ffc-0b27-4b20-a607-5cf82e04e58f",
"Values": [
{
"FormFieldValueId": "08caf8e6-320d-4fe5-8994-d5c7998e92b6",
"FormTypeField": {
"FormTypeFieldId": "d28847d9-e36d-47b5-b25c-428cf297ce4f",
"Section": {
"FormTypeSectionId": "d8caf2ce-78cc-49f7-95db-78e1daa4e7fc",
"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": "43eb31a3-f370-4b01-a86d-10641df9bfab",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34055794-96c5-4600-86d0-8dc3c03f1583",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb45aa2c-3d88-4c79-8e8e-f8dbffe569df",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-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": "08caf8e6-320d-4fe5-8994-d5c7998e92b6",
"FormTypeField": {
"FormTypeFieldId": "d28847d9-e36d-47b5-b25c-428cf297ce4f",
"Section": {
"FormTypeSectionId": "d8caf2ce-78cc-49f7-95db-78e1daa4e7fc",
"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": "43eb31a3-f370-4b01-a86d-10641df9bfab",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34055794-96c5-4600-86d0-8dc3c03f1583",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb45aa2c-3d88-4c79-8e8e-f8dbffe569df",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-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": "a8fbace7-500a-4457-85fb-ae71a0e47818",
"CreateDate": "2026-11-21T15:32:28.6864417-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T15:32:28.6864417-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}