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": "7432ddde-a8b8-4431-89ca-2ff4897fa532",
"Asset": {
"AssetId": "dab286c6-3f73-45b2-bd9c-988738ef561b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1db73ca8-e7cc-4b27-aab7-fb5b38eab28f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b7e425fb-fb73-4727-b87d-fbd918b78509",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b33c43e6-4376-473a-89d7-bea190af3900",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-03T02:28:32.3492908-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:28:32.3492908-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3a31d03c-3acb-4700-91a3-3a4eb0974ef8",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-03T02:28:32.3492908-07:00",
"MeasurementValueNeededDate": "2026-08-03T02:28:32.3492908-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73c6273f-9a5d-4234-aec1-406fad4fe80c",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c04af802-8c7f-4158-9ecd-8765925e53bd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1db73ca8-e7cc-4b27-aab7-fb5b38eab28f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b7e425fb-fb73-4727-b87d-fbd918b78509",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-03T02:28:32.3492908-07:00",
"Fields": [
{
"FormTypeFieldId": "bfc70f78-2f07-4cca-a20b-dd4cc1c9e39a",
"Section": {
"FormTypeSectionId": "5743970f-e545-4009-bea2-fbf2299786ce",
"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": "e764e0e4-a876-4119-b184-fa16bef08126",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f685550d-9bcc-48a5-8c68-7f3a535774a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "07ecdd52-7ce7-4300-bcf0-ea8af709e51b",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-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": "bfc70f78-2f07-4cca-a20b-dd4cc1c9e39a",
"Section": {
"FormTypeSectionId": "5743970f-e545-4009-bea2-fbf2299786ce",
"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": "e764e0e4-a876-4119-b184-fa16bef08126",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f685550d-9bcc-48a5-8c68-7f3a535774a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "07ecdd52-7ce7-4300-bcf0-ea8af709e51b",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-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": "bbef3f02-177b-458f-b03c-630026ac318a",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-03T02:28:32.3492908-07:00",
"Location": "sample string 1",
"TaskId": "55cece28-c1f9-43ee-a2b6-719686bb184f",
"Values": [
{
"FormFieldValueId": "4c702d37-159a-4fdd-be02-e566acb38351",
"FormTypeField": {
"FormTypeFieldId": "bfc70f78-2f07-4cca-a20b-dd4cc1c9e39a",
"Section": {
"FormTypeSectionId": "5743970f-e545-4009-bea2-fbf2299786ce",
"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": "e764e0e4-a876-4119-b184-fa16bef08126",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f685550d-9bcc-48a5-8c68-7f3a535774a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "07ecdd52-7ce7-4300-bcf0-ea8af709e51b",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-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": "4c702d37-159a-4fdd-be02-e566acb38351",
"FormTypeField": {
"FormTypeFieldId": "bfc70f78-2f07-4cca-a20b-dd4cc1c9e39a",
"Section": {
"FormTypeSectionId": "5743970f-e545-4009-bea2-fbf2299786ce",
"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": "e764e0e4-a876-4119-b184-fa16bef08126",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f685550d-9bcc-48a5-8c68-7f3a535774a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "07ecdd52-7ce7-4300-bcf0-ea8af709e51b",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-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": "6dfcb3ba-7422-4207-8b3a-3d5456db92a6",
"CreateDate": "2026-08-03T02:28:32.3492908-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-03T02:28:32.3492908-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}