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": "1658df45-c981-43d2-82f7-ad6c65541f1d",
"Asset": {
"AssetId": "215a1988-1eea-4a16-8e15-3221d5ae7295",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a3e45c9c-8baa-4b27-8572-334c25a447b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1677e840-8eb4-4cc6-8f0c-f583b1557dff",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "953bfffa-e208-40d7-931e-f508b6e8425b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-14T05:53:54.5101103-07:00",
"MeasurementValueNeededDate": "2026-06-14T05:53:54.5101103-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5c04b21f-5bde-4392-8182-31001d76ec7d",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-14T05:53:54.5101103-07:00",
"MeasurementValueNeededDate": "2026-06-14T05:53:54.5101103-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6fe727bd-df08-4ff0-a42a-d78a1431b5ac",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "b2fc50c8-70ae-4827-80de-0bebc33ed13c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a3e45c9c-8baa-4b27-8572-334c25a447b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1677e840-8eb4-4cc6-8f0c-f583b1557dff",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-14T05:53:54.5101103-07:00",
"Fields": [
{
"FormTypeFieldId": "f08a12fb-73c1-4085-83e9-bc577d97c06e",
"Section": {
"FormTypeSectionId": "829d1d3b-1b6c-4bf5-a88c-5979d252ce8b",
"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": "f99a8ee1-ad70-4336-952e-16d386b6b3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ef49a-3279-4edf-a603-df4e32d23c50",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49ed3c2-8827-4fd1-96a6-5d99e6675988",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-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": "f08a12fb-73c1-4085-83e9-bc577d97c06e",
"Section": {
"FormTypeSectionId": "829d1d3b-1b6c-4bf5-a88c-5979d252ce8b",
"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": "f99a8ee1-ad70-4336-952e-16d386b6b3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ef49a-3279-4edf-a603-df4e32d23c50",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49ed3c2-8827-4fd1-96a6-5d99e6675988",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-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": "4256d540-c9c6-48a6-a0c6-fd72c6c53376",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-14T05:53:54.5101103-07:00",
"Location": "sample string 1",
"TaskId": "4432741a-f8ac-4823-8eec-2fd2d4de95a4",
"Values": [
{
"FormFieldValueId": "524c54ea-c7bb-4b21-bb26-a1f877c5e61e",
"FormTypeField": {
"FormTypeFieldId": "f08a12fb-73c1-4085-83e9-bc577d97c06e",
"Section": {
"FormTypeSectionId": "829d1d3b-1b6c-4bf5-a88c-5979d252ce8b",
"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": "f99a8ee1-ad70-4336-952e-16d386b6b3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ef49a-3279-4edf-a603-df4e32d23c50",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49ed3c2-8827-4fd1-96a6-5d99e6675988",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-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": "524c54ea-c7bb-4b21-bb26-a1f877c5e61e",
"FormTypeField": {
"FormTypeFieldId": "f08a12fb-73c1-4085-83e9-bc577d97c06e",
"Section": {
"FormTypeSectionId": "829d1d3b-1b6c-4bf5-a88c-5979d252ce8b",
"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": "f99a8ee1-ad70-4336-952e-16d386b6b3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "af7ef49a-3279-4edf-a603-df4e32d23c50",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49ed3c2-8827-4fd1-96a6-5d99e6675988",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-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": "0e7e4cf3-e846-4a1b-8c23-c1d8628d61b3",
"CreateDate": "2026-06-14T05:53:54.5101103-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-14T05:53:54.5101103-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}