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": "086e6305-162d-44e3-b296-136751d3b44b",
"Asset": {
"AssetId": "7cd2a9e9-f2a6-4d28-8b63-292e36b007bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f9d0444c-10f9-493f-98cc-265cd5bbfbc4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "349d61a1-fe87-48f7-aa40-4e33f537d7cc",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c4fe618b-9d0f-4151-9bdc-8e26a63eaac0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-21T04:56:39.5019437-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:56:39.5019437-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f12f09f7-4f57-49de-86c0-71516095d11c",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-21T04:56:39.5019437-08:00",
"MeasurementValueNeededDate": "2025-12-21T04:56:39.5019437-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "245c8a41-017e-44ce-ab45-664406e384b2",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "854b9e3d-c6d6-4817-a6a2-7064b41f5dd0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f9d0444c-10f9-493f-98cc-265cd5bbfbc4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "349d61a1-fe87-48f7-aa40-4e33f537d7cc",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-21T04:56:39.5019437-08:00",
"Fields": [
{
"FormTypeFieldId": "f4e5aa0e-5842-4c0f-899b-18e5f3fe82b4",
"Section": {
"FormTypeSectionId": "3c6af822-0f83-4246-b753-812e97a9b39e",
"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": "1d34f74a-c0f5-4c3b-becc-f22495eda3a8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c2b5633e-2510-4f10-8180-659b36f2d0df",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "30367a24-043b-452e-b0d6-f34a124d1e0e",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-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": "f4e5aa0e-5842-4c0f-899b-18e5f3fe82b4",
"Section": {
"FormTypeSectionId": "3c6af822-0f83-4246-b753-812e97a9b39e",
"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": "1d34f74a-c0f5-4c3b-becc-f22495eda3a8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c2b5633e-2510-4f10-8180-659b36f2d0df",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "30367a24-043b-452e-b0d6-f34a124d1e0e",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-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": "2fb12cda-1530-4e4b-a9c1-99511b2d9ed3",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-12-21T04:56:39.5019437-08:00",
"Location": "sample string 1",
"TaskId": "fc87fb70-8151-40bb-acc5-e1899985674c",
"Values": [
{
"FormFieldValueId": "77943305-f7ee-4636-a8f5-ff7a353df516",
"FormTypeField": {
"FormTypeFieldId": "f4e5aa0e-5842-4c0f-899b-18e5f3fe82b4",
"Section": {
"FormTypeSectionId": "3c6af822-0f83-4246-b753-812e97a9b39e",
"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": "1d34f74a-c0f5-4c3b-becc-f22495eda3a8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c2b5633e-2510-4f10-8180-659b36f2d0df",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "30367a24-043b-452e-b0d6-f34a124d1e0e",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-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": "77943305-f7ee-4636-a8f5-ff7a353df516",
"FormTypeField": {
"FormTypeFieldId": "f4e5aa0e-5842-4c0f-899b-18e5f3fe82b4",
"Section": {
"FormTypeSectionId": "3c6af822-0f83-4246-b753-812e97a9b39e",
"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": "1d34f74a-c0f5-4c3b-becc-f22495eda3a8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c2b5633e-2510-4f10-8180-659b36f2d0df",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "30367a24-043b-452e-b0d6-f34a124d1e0e",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-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": "02bbb0d9-f6a1-44df-9cdb-bbfeb68087a1",
"CreateDate": "2025-12-21T04:56:39.5019437-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-21T04:56:39.5019437-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}