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": "6199ac2a-3cee-4fc3-875a-56fd7f902815",
"Asset": {
"AssetId": "583a28d2-0e11-4ef4-b48d-71aa021ce414",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "863f8ebf-85c9-4ca6-b21f-e744df695cf4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b9c2a987-412f-4020-8c4b-521308204730",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "02132d88-7a14-49f9-ae97-8faa2a32ac4b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-13T23:59:11.2988706-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:59:11.2988706-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "223fc8bd-15c9-40de-8654-3ec0b262955b",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-13T23:59:11.2988706-07:00",
"MeasurementValueNeededDate": "2026-07-13T23:59:11.2988706-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8f1258f6-ad83-4328-be41-8d0298909040",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "0c116df7-2f15-4640-98f7-a3301a87c509",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "863f8ebf-85c9-4ca6-b21f-e744df695cf4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b9c2a987-412f-4020-8c4b-521308204730",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-13T23:59:11.2988706-07:00",
"Fields": [
{
"FormTypeFieldId": "11dd24e1-b70c-4175-b7fe-5a9905c37ff6",
"Section": {
"FormTypeSectionId": "8a811059-3a72-4c38-ad91-4cbe1711c7f3",
"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": "fc9281fe-5c6e-4eaf-931f-9bd833534950",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d766d6b7-9029-43af-a693-69295272ff92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9540204f-0aab-439e-8e22-7c5a11769bdd",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-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": "11dd24e1-b70c-4175-b7fe-5a9905c37ff6",
"Section": {
"FormTypeSectionId": "8a811059-3a72-4c38-ad91-4cbe1711c7f3",
"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": "fc9281fe-5c6e-4eaf-931f-9bd833534950",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d766d6b7-9029-43af-a693-69295272ff92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9540204f-0aab-439e-8e22-7c5a11769bdd",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-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": "36013025-28a1-4ae2-a1b4-4bcef24ebc7d",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-07-13T23:59:11.2988706-07:00",
"Location": "sample string 1",
"TaskId": "0f3c337e-4ba3-4ea8-834b-098608e26e15",
"Values": [
{
"FormFieldValueId": "0486b722-59c7-4c09-b428-eb37f62e2d5a",
"FormTypeField": {
"FormTypeFieldId": "11dd24e1-b70c-4175-b7fe-5a9905c37ff6",
"Section": {
"FormTypeSectionId": "8a811059-3a72-4c38-ad91-4cbe1711c7f3",
"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": "fc9281fe-5c6e-4eaf-931f-9bd833534950",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d766d6b7-9029-43af-a693-69295272ff92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9540204f-0aab-439e-8e22-7c5a11769bdd",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-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": "0486b722-59c7-4c09-b428-eb37f62e2d5a",
"FormTypeField": {
"FormTypeFieldId": "11dd24e1-b70c-4175-b7fe-5a9905c37ff6",
"Section": {
"FormTypeSectionId": "8a811059-3a72-4c38-ad91-4cbe1711c7f3",
"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": "fc9281fe-5c6e-4eaf-931f-9bd833534950",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d766d6b7-9029-43af-a693-69295272ff92",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9540204f-0aab-439e-8e22-7c5a11769bdd",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-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": "585b7e63-4a23-43af-8f8c-ebc756cbf090",
"CreateDate": "2026-07-13T23:59:11.2988706-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-13T23:59:11.2988706-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}