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": "ec7ab01c-f7f2-4c77-9119-dfcbc5b13c3b", "Asset": { "AssetId": "0d49b5af-52f1-43ad-83b6-f05e631b25e0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "bddbf625-7f51-4d85-abde-b89b8c580b15", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "518a7e7c-d2b7-48d6-af98-7df021072021", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fc5ad035-c649-45b3-ba3d-c91620c45f00", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T08:10:43.7409205-07:00", "MeasurementValueNeededDate": "2025-06-02T08:10:43.7409205-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bc2c136b-715d-45f7-8ca5-2126e95c6d16", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-02T08:10:43.7409205-07:00", "MeasurementValueNeededDate": "2025-06-02T08:10:43.7409205-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "bc956052-35ca-42e7-a615-4b6cffe929e4", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "e0bd87ff-7ea2-46ac-9b9c-682902b1b3a9", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bddbf625-7f51-4d85-abde-b89b8c580b15", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "518a7e7c-d2b7-48d6-af98-7df021072021", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T08:10:43.7409205-07:00", "Fields": [ { "FormTypeFieldId": "12781dce-13df-4669-b1a1-387bbba97aff", "Section": { "FormTypeSectionId": "9e5d0624-ccb3-4d42-9c75-1e4352f3733a", "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": "a093efe7-f348-4a17-9869-bcb336cbf7cd", "Name": "sample string 1" }, "Unit": { "UnitId": "a8e0e6e3-8de6-4463-b2c6-f2397c384e6f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1392c343-4e86-4fe2-8f95-cb0ca0ef2f5c", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-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": "12781dce-13df-4669-b1a1-387bbba97aff", "Section": { "FormTypeSectionId": "9e5d0624-ccb3-4d42-9c75-1e4352f3733a", "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": "a093efe7-f348-4a17-9869-bcb336cbf7cd", "Name": "sample string 1" }, "Unit": { "UnitId": "a8e0e6e3-8de6-4463-b2c6-f2397c384e6f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1392c343-4e86-4fe2-8f95-cb0ca0ef2f5c", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-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": "d77bb8bc-a3db-49a4-8a24-d5a3fe98b7d8", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-02T08:10:43.7409205-07:00", "Location": "sample string 1", "TaskId": "305d7a45-fade-4bb7-9776-632c19707bc6", "Values": [ { "FormFieldValueId": "9127ad0d-e4dd-44ec-a767-007af516ae8c", "FormTypeField": { "FormTypeFieldId": "12781dce-13df-4669-b1a1-387bbba97aff", "Section": { "FormTypeSectionId": "9e5d0624-ccb3-4d42-9c75-1e4352f3733a", "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": "a093efe7-f348-4a17-9869-bcb336cbf7cd", "Name": "sample string 1" }, "Unit": { "UnitId": "a8e0e6e3-8de6-4463-b2c6-f2397c384e6f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1392c343-4e86-4fe2-8f95-cb0ca0ef2f5c", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-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": "9127ad0d-e4dd-44ec-a767-007af516ae8c", "FormTypeField": { "FormTypeFieldId": "12781dce-13df-4669-b1a1-387bbba97aff", "Section": { "FormTypeSectionId": "9e5d0624-ccb3-4d42-9c75-1e4352f3733a", "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": "a093efe7-f348-4a17-9869-bcb336cbf7cd", "Name": "sample string 1" }, "Unit": { "UnitId": "a8e0e6e3-8de6-4463-b2c6-f2397c384e6f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1392c343-4e86-4fe2-8f95-cb0ca0ef2f5c", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T08:10:43.7409205-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": "e01af447-c87b-4dff-b75b-47f0315516c2", "CreateDate": "2025-06-02T08:10:43.7409205-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T08:10:43.7409205-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }