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": "44f081d0-5bc1-459a-bf2d-178c343397a4",
"Asset": {
"AssetId": "a255ba23-f05a-4703-9a90-c923c4031f68",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f669956b-c3c8-4355-b4d7-158b9269ad52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4cc9c5cc-5606-4b98-9d67-61fed8c271f8",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e4bd10b8-1179-4237-b3b2-e9338028a588",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T15:00:45.499803-07:00",
"MeasurementValueNeededDate": "2026-03-24T15:00:45.499803-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6fa6ff6-777d-4169-910d-4ff589db01e5",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T15:00:45.499803-07:00",
"MeasurementValueNeededDate": "2026-03-24T15:00:45.499803-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3dd4dbdf-6589-4c59-a9d2-57b0854d115c",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "79d4cf38-864b-46f1-8576-43f63bb947c5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f669956b-c3c8-4355-b4d7-158b9269ad52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4cc9c5cc-5606-4b98-9d67-61fed8c271f8",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-24T15:00:45.499803-07:00",
"Fields": [
{
"FormTypeFieldId": "337b7748-1a35-4428-999e-2077a3bb9905",
"Section": {
"FormTypeSectionId": "e1066953-dff9-44d1-b5c2-16ee8bbf5b57",
"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": "2b9c6b1b-342b-439b-8143-5546a67ebbc6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6da8dc3b-1eee-464f-9d74-dc0e96bfa8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4bfef061-b3ae-4a23-8635-4f6a57810119",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-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": "337b7748-1a35-4428-999e-2077a3bb9905",
"Section": {
"FormTypeSectionId": "e1066953-dff9-44d1-b5c2-16ee8bbf5b57",
"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": "2b9c6b1b-342b-439b-8143-5546a67ebbc6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6da8dc3b-1eee-464f-9d74-dc0e96bfa8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4bfef061-b3ae-4a23-8635-4f6a57810119",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-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": "ad6ba58e-2f35-49d3-932c-89eb026c3d37",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-24T15:00:45.499803-07:00",
"Location": "sample string 1",
"TaskId": "3154889b-4ad2-42b9-8523-64a48a373937",
"Values": [
{
"FormFieldValueId": "58e66ee1-1f1f-46b5-a0fb-d959a30790df",
"FormTypeField": {
"FormTypeFieldId": "337b7748-1a35-4428-999e-2077a3bb9905",
"Section": {
"FormTypeSectionId": "e1066953-dff9-44d1-b5c2-16ee8bbf5b57",
"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": "2b9c6b1b-342b-439b-8143-5546a67ebbc6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6da8dc3b-1eee-464f-9d74-dc0e96bfa8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4bfef061-b3ae-4a23-8635-4f6a57810119",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-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": "58e66ee1-1f1f-46b5-a0fb-d959a30790df",
"FormTypeField": {
"FormTypeFieldId": "337b7748-1a35-4428-999e-2077a3bb9905",
"Section": {
"FormTypeSectionId": "e1066953-dff9-44d1-b5c2-16ee8bbf5b57",
"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": "2b9c6b1b-342b-439b-8143-5546a67ebbc6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6da8dc3b-1eee-464f-9d74-dc0e96bfa8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4bfef061-b3ae-4a23-8635-4f6a57810119",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T15:00:45.499803-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": "832313eb-312f-4bd5-88ef-432bbd09e443",
"CreateDate": "2026-03-24T15:00:45.499803-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T15:00:45.499803-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}