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": "a8a11b58-6a99-49a2-812a-d1839ddc99b3", "Asset": { "AssetId": "b2fa2ae3-8a6f-4efa-a9ec-4e7a17c70aae", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "36f2a521-2a40-4a6a-968b-5ead3b599aa1", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "57a402c0-5119-41c7-ab65-a303a162f6b4", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "dbbade35-9cf3-4400-b3a3-f8ccec2d4536", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T15:42:29.7201519-07:00", "MeasurementValueNeededDate": "2025-07-05T15:42:29.7201519-07:00", "SourceSystemId": "sample string 3", "CompanyId": "98adaeb5-7931-45ee-a746-44f675c6cb10", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-05T15:42:29.7201519-07:00", "MeasurementValueNeededDate": "2025-07-05T15:42:29.7201519-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "466197b5-65a6-49c4-b1c8-beebbdffceab", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6e0674b9-5267-4f56-8308-96894a812509", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "36f2a521-2a40-4a6a-968b-5ead3b599aa1", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "57a402c0-5119-41c7-ab65-a303a162f6b4", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-05T15:42:29.7201519-07:00", "Fields": [ { "FormTypeFieldId": "9c67f43e-d6e0-41e8-81b7-2838315b8cd8", "Section": { "FormTypeSectionId": "11639bb8-1c5b-4fd2-a1fb-b075090f3d0b", "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": "b084c538-495e-4ad6-80e3-842c86154e88", "Name": "sample string 1" }, "Unit": { "UnitId": "3058d34e-45d7-4c32-9ac5-3432cb46f26a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "43824142-c3cf-496f-89d6-4cb092cf0a59", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-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": "9c67f43e-d6e0-41e8-81b7-2838315b8cd8", "Section": { "FormTypeSectionId": "11639bb8-1c5b-4fd2-a1fb-b075090f3d0b", "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": "b084c538-495e-4ad6-80e3-842c86154e88", "Name": "sample string 1" }, "Unit": { "UnitId": "3058d34e-45d7-4c32-9ac5-3432cb46f26a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "43824142-c3cf-496f-89d6-4cb092cf0a59", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-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": "280bd39b-26d4-4f8e-9f03-1985f1fd3c18", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-05T15:42:29.7201519-07:00", "Location": "sample string 1", "TaskId": "138c299e-4158-40d0-bcfb-23f679dfcd43", "Values": [ { "FormFieldValueId": "336e31da-c2c8-430b-a93a-ccc001aa89a2", "FormTypeField": { "FormTypeFieldId": "9c67f43e-d6e0-41e8-81b7-2838315b8cd8", "Section": { "FormTypeSectionId": "11639bb8-1c5b-4fd2-a1fb-b075090f3d0b", "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": "b084c538-495e-4ad6-80e3-842c86154e88", "Name": "sample string 1" }, "Unit": { "UnitId": "3058d34e-45d7-4c32-9ac5-3432cb46f26a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "43824142-c3cf-496f-89d6-4cb092cf0a59", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-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": "336e31da-c2c8-430b-a93a-ccc001aa89a2", "FormTypeField": { "FormTypeFieldId": "9c67f43e-d6e0-41e8-81b7-2838315b8cd8", "Section": { "FormTypeSectionId": "11639bb8-1c5b-4fd2-a1fb-b075090f3d0b", "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": "b084c538-495e-4ad6-80e3-842c86154e88", "Name": "sample string 1" }, "Unit": { "UnitId": "3058d34e-45d7-4c32-9ac5-3432cb46f26a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "43824142-c3cf-496f-89d6-4cb092cf0a59", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T15:42:29.7201519-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": "6446f56e-c029-46f0-aaec-893ec4e9d30e", "CreateDate": "2025-07-05T15:42:29.7201519-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-05T15:42:29.7201519-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }