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": "4c40c020-fb08-4a8d-a2ea-e0092eb50ec6", "Asset": { "AssetId": "d88c3f4e-e5b4-4fad-9b02-618a82d5baca", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cc358fb7-94fd-4af3-83a8-281e61ee0deb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "87256a6b-5577-48c7-8ed8-0e54aafe60ac", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "293ca260-b015-4c9b-8faf-ddbf38d6c3dc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7eae1899-19d3-4868-bc6e-04c019b039b6", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d34af6a5-d86a-436d-946c-b18e169cb90a", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "376ece88-fe3c-4b5c-a96d-f9785dcd233e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cc358fb7-94fd-4af3-83a8-281e61ee0deb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "87256a6b-5577-48c7-8ed8-0e54aafe60ac", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "Fields": [ { "FormTypeFieldId": "69324905-5b63-4a34-8e07-7a9550e91df4", "Section": { "FormTypeSectionId": "e19c5b87-e847-49b4-abaf-3f4963a87cc5", "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": "6fe50353-34bf-4eeb-8cfb-42361029a8d1", "Name": "sample string 1" }, "Unit": { "UnitId": "4df0cf71-3e1d-40ed-8944-10618ae62bf1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb4dfa6b-0cd1-43c0-a920-87fa851f1dc4", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "69324905-5b63-4a34-8e07-7a9550e91df4", "Section": { "FormTypeSectionId": "e19c5b87-e847-49b4-abaf-3f4963a87cc5", "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": "6fe50353-34bf-4eeb-8cfb-42361029a8d1", "Name": "sample string 1" }, "Unit": { "UnitId": "4df0cf71-3e1d-40ed-8944-10618ae62bf1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb4dfa6b-0cd1-43c0-a920-87fa851f1dc4", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "d72d219a-e783-4ed7-9afe-430e5d3b9af4", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-25T06:11:21.9290643-07:00", "Location": "sample string 1", "TaskId": "d80c1a32-3bf0-4db3-8801-1209f029430d", "Values": [ { "FormFieldValueId": "aa6128ec-fc0d-4cb3-ad0d-ffc66a340216", "FormTypeField": { "FormTypeFieldId": "69324905-5b63-4a34-8e07-7a9550e91df4", "Section": { "FormTypeSectionId": "e19c5b87-e847-49b4-abaf-3f4963a87cc5", "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": "6fe50353-34bf-4eeb-8cfb-42361029a8d1", "Name": "sample string 1" }, "Unit": { "UnitId": "4df0cf71-3e1d-40ed-8944-10618ae62bf1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb4dfa6b-0cd1-43c0-a920-87fa851f1dc4", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "aa6128ec-fc0d-4cb3-ad0d-ffc66a340216", "FormTypeField": { "FormTypeFieldId": "69324905-5b63-4a34-8e07-7a9550e91df4", "Section": { "FormTypeSectionId": "e19c5b87-e847-49b4-abaf-3f4963a87cc5", "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": "6fe50353-34bf-4eeb-8cfb-42361029a8d1", "Name": "sample string 1" }, "Unit": { "UnitId": "4df0cf71-3e1d-40ed-8944-10618ae62bf1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb4dfa6b-0cd1-43c0-a920-87fa851f1dc4", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "6006808c-75ea-43a0-960a-3efda0b7e44d", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }