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": "c030adca-ee3f-40d7-8c38-9c099ac7f77a", "Asset": { "AssetId": "828ddee4-4e58-49ce-947b-f023441affb9", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f5897ad3-1d21-42ac-907e-b600aba8af73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dded56d1-8aba-4389-9d96-e7046ca079f3", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "066a7e3f-efc4-4a76-9760-4edb7cd5185a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T18:03:22.7436129-07:00", "MeasurementValueNeededDate": "2025-07-31T18:03:22.7436129-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d1d7fdfe-2108-402c-8ce6-cba0e33ac24a", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T18:03:22.7436129-07:00", "MeasurementValueNeededDate": "2025-07-31T18:03:22.7436129-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "43c27e9b-7e5f-45e3-8926-e2429705e27e", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7c5ae4e7-cae3-4b57-8f0c-045a7bc0f8b6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f5897ad3-1d21-42ac-907e-b600aba8af73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dded56d1-8aba-4389-9d96-e7046ca079f3", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T18:03:22.7436129-07:00", "Fields": [ { "FormTypeFieldId": "526b3e6b-416c-4a72-a569-7625142f0ab3", "Section": { "FormTypeSectionId": "cf23bb9b-e9cc-4619-8699-7a71dd19e55c", "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": "3842a738-358d-45ab-8d7b-76799f773b89", "Name": "sample string 1" }, "Unit": { "UnitId": "653a026f-5264-4ca9-80ce-1a96ec1f687a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d829d32e-e1b9-4d90-b035-b5725d72b8df", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-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": "526b3e6b-416c-4a72-a569-7625142f0ab3", "Section": { "FormTypeSectionId": "cf23bb9b-e9cc-4619-8699-7a71dd19e55c", "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": "3842a738-358d-45ab-8d7b-76799f773b89", "Name": "sample string 1" }, "Unit": { "UnitId": "653a026f-5264-4ca9-80ce-1a96ec1f687a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d829d32e-e1b9-4d90-b035-b5725d72b8df", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-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": "0d44fb0a-8aa8-433b-90e1-0b30e4f167c0", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T18:03:22.7436129-07:00", "Location": "sample string 1", "TaskId": "b650bea8-a49c-458c-8582-3d270d936d73", "Values": [ { "FormFieldValueId": "f7e15d83-25c8-4a3f-805b-41439a4472fb", "FormTypeField": { "FormTypeFieldId": "526b3e6b-416c-4a72-a569-7625142f0ab3", "Section": { "FormTypeSectionId": "cf23bb9b-e9cc-4619-8699-7a71dd19e55c", "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": "3842a738-358d-45ab-8d7b-76799f773b89", "Name": "sample string 1" }, "Unit": { "UnitId": "653a026f-5264-4ca9-80ce-1a96ec1f687a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d829d32e-e1b9-4d90-b035-b5725d72b8df", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-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": "f7e15d83-25c8-4a3f-805b-41439a4472fb", "FormTypeField": { "FormTypeFieldId": "526b3e6b-416c-4a72-a569-7625142f0ab3", "Section": { "FormTypeSectionId": "cf23bb9b-e9cc-4619-8699-7a71dd19e55c", "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": "3842a738-358d-45ab-8d7b-76799f773b89", "Name": "sample string 1" }, "Unit": { "UnitId": "653a026f-5264-4ca9-80ce-1a96ec1f687a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d829d32e-e1b9-4d90-b035-b5725d72b8df", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:03:22.7436129-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": "e94da224-63fa-47d8-9a83-a720369769f7", "CreateDate": "2025-07-31T18:03:22.7436129-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T18:03:22.7436129-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }