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": "9630c61b-0d20-43c1-8bfe-0193525ecd48",
"Asset": {
"AssetId": "67176d10-a695-4869-ac00-5d8a64d9542c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f5e7ada4-bc09-4c02-8845-15846fa99eab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2268ce63-82f4-4456-82f0-e97c3ae883d0",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "767d54b4-62ea-4cba-b10a-45467738d726",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-15T01:24:31.6977961-08:00",
"MeasurementValueNeededDate": "2026-01-15T01:24:31.6977961-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a718a1f2-1da0-4805-ac54-6a225fa4ca2f",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-15T01:24:31.6977961-08:00",
"MeasurementValueNeededDate": "2026-01-15T01:24:31.6977961-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2ae16069-b907-4e44-ae12-c61f99fca282",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "5eea71e9-fc2a-4879-afff-67002ae5f861",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f5e7ada4-bc09-4c02-8845-15846fa99eab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2268ce63-82f4-4456-82f0-e97c3ae883d0",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-15T01:24:31.6977961-08:00",
"Fields": [
{
"FormTypeFieldId": "e43dfe7e-acda-404c-b9a7-cb7ddbdec415",
"Section": {
"FormTypeSectionId": "55445d90-5e86-4365-950e-4314c020fded",
"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": "22bf167d-0e35-4a1b-9298-f58861c8c59a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3ba60a7f-b0f6-4e15-a028-3e000ce0be49",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0dd7396e-b132-491c-b50a-84f8eb8a0684",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-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": "e43dfe7e-acda-404c-b9a7-cb7ddbdec415",
"Section": {
"FormTypeSectionId": "55445d90-5e86-4365-950e-4314c020fded",
"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": "22bf167d-0e35-4a1b-9298-f58861c8c59a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3ba60a7f-b0f6-4e15-a028-3e000ce0be49",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0dd7396e-b132-491c-b50a-84f8eb8a0684",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-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": "ec1ad9df-a233-4008-aeeb-f0addcc9126a",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-01-15T01:24:31.6977961-08:00",
"Location": "sample string 1",
"TaskId": "c16a5802-c34d-4dde-9df7-157e88454ded",
"Values": [
{
"FormFieldValueId": "53696b53-ebaf-4195-9f56-f20487f956d6",
"FormTypeField": {
"FormTypeFieldId": "e43dfe7e-acda-404c-b9a7-cb7ddbdec415",
"Section": {
"FormTypeSectionId": "55445d90-5e86-4365-950e-4314c020fded",
"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": "22bf167d-0e35-4a1b-9298-f58861c8c59a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3ba60a7f-b0f6-4e15-a028-3e000ce0be49",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0dd7396e-b132-491c-b50a-84f8eb8a0684",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-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": "53696b53-ebaf-4195-9f56-f20487f956d6",
"FormTypeField": {
"FormTypeFieldId": "e43dfe7e-acda-404c-b9a7-cb7ddbdec415",
"Section": {
"FormTypeSectionId": "55445d90-5e86-4365-950e-4314c020fded",
"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": "22bf167d-0e35-4a1b-9298-f58861c8c59a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3ba60a7f-b0f6-4e15-a028-3e000ce0be49",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0dd7396e-b132-491c-b50a-84f8eb8a0684",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-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": "5cb601ae-6e31-4d91-9b06-bd3325dc6202",
"CreateDate": "2026-01-15T01:24:31.6977961-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-15T01:24:31.6977961-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}