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": "20a0803d-ca7e-4feb-ab40-85f562bad9cf",
"Asset": {
"AssetId": "fda9fd49-3993-498a-82a9-e244da3e6e57",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "04791030-4ad2-46ab-9778-feb657c4eefd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc1fb52a-1f62-4ac2-8787-67a96e7e8f35",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "735f2dc2-8556-47ec-a493-5eb91e0622d9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-19T02:31:29.5118864-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:29.5118864-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ebbc61a7-8682-4dc7-be3f-e10cef640fff",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-19T02:31:29.5118864-07:00",
"MeasurementValueNeededDate": "2026-10-19T02:31:29.5118864-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b8f5e6a8-c7e2-46e7-a5f3-bf505e1940fc",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "870cc512-cb15-4fad-b39b-cdbdc816aff0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "04791030-4ad2-46ab-9778-feb657c4eefd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc1fb52a-1f62-4ac2-8787-67a96e7e8f35",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-19T02:31:29.5118864-07:00",
"Fields": [
{
"FormTypeFieldId": "e1a53b7d-bf7b-4566-bb85-7eef3faff5a4",
"Section": {
"FormTypeSectionId": "dcdb6e25-ab33-41ff-9ce9-b0362db3f3cc",
"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": "3f75eaa1-c6b9-4621-9626-70fa1b06c413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23c4cc70-73fe-4dcc-9260-72c1e78a1451",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "501ff86e-03b5-4592-aaee-1e39572f850c",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-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": "e1a53b7d-bf7b-4566-bb85-7eef3faff5a4",
"Section": {
"FormTypeSectionId": "dcdb6e25-ab33-41ff-9ce9-b0362db3f3cc",
"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": "3f75eaa1-c6b9-4621-9626-70fa1b06c413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23c4cc70-73fe-4dcc-9260-72c1e78a1451",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "501ff86e-03b5-4592-aaee-1e39572f850c",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-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": "e97d379f-9893-4f78-a855-0b44462b7f78",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-19T02:31:29.5118864-07:00",
"Location": "sample string 1",
"TaskId": "b9631163-a8d6-426b-baf1-367fab790d6e",
"Values": [
{
"FormFieldValueId": "8ce0d08c-ac66-475e-b941-0bbc95687757",
"FormTypeField": {
"FormTypeFieldId": "e1a53b7d-bf7b-4566-bb85-7eef3faff5a4",
"Section": {
"FormTypeSectionId": "dcdb6e25-ab33-41ff-9ce9-b0362db3f3cc",
"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": "3f75eaa1-c6b9-4621-9626-70fa1b06c413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23c4cc70-73fe-4dcc-9260-72c1e78a1451",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "501ff86e-03b5-4592-aaee-1e39572f850c",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-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": "8ce0d08c-ac66-475e-b941-0bbc95687757",
"FormTypeField": {
"FormTypeFieldId": "e1a53b7d-bf7b-4566-bb85-7eef3faff5a4",
"Section": {
"FormTypeSectionId": "dcdb6e25-ab33-41ff-9ce9-b0362db3f3cc",
"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": "3f75eaa1-c6b9-4621-9626-70fa1b06c413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "23c4cc70-73fe-4dcc-9260-72c1e78a1451",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "501ff86e-03b5-4592-aaee-1e39572f850c",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-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": "93e8994a-df49-4b81-b0d4-0889608cb1ca",
"CreateDate": "2026-10-19T02:31:29.5118864-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-19T02:31:29.5118864-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}