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": "09240e4f-6244-4afc-8941-1a8e4615f014", "Asset": { "AssetId": "eb311214-2bf1-45fb-bf17-b685f7fbbc01", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "75e07a6c-185f-4db7-ac81-73bd3f5576a7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4e3bf85f-396a-475e-9f60-7ca50f4fde64", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "82b2f4c1-3f3b-4cc2-8194-486d7258de35", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T22:18:39.0853443-07:00", "MeasurementValueNeededDate": "2025-06-26T22:18:39.0853443-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f8004d8a-ae1d-47fb-b0bb-a4e639146360", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-26T22:18:39.0853443-07:00", "MeasurementValueNeededDate": "2025-06-26T22:18:39.0853443-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3a694845-0079-4947-b654-d3bf94b186ac", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b7e9c5f1-8cd1-468d-8e39-100b93e825cb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "75e07a6c-185f-4db7-ac81-73bd3f5576a7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4e3bf85f-396a-475e-9f60-7ca50f4fde64", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-26T22:18:39.0853443-07:00", "Fields": [ { "FormTypeFieldId": "fe68a6d8-b869-43b1-aa75-c8e38cd5bf67", "Section": { "FormTypeSectionId": "4a111feb-41e2-4826-9156-1a574d057e31", "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": "122e9f1f-4636-467d-8c9c-fe65913e576b", "Name": "sample string 1" }, "Unit": { "UnitId": "c10036db-7875-47e5-b5cf-e27a9a9a9a0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f37fb666-050d-424d-95dd-01f813dcdae5", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-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": "fe68a6d8-b869-43b1-aa75-c8e38cd5bf67", "Section": { "FormTypeSectionId": "4a111feb-41e2-4826-9156-1a574d057e31", "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": "122e9f1f-4636-467d-8c9c-fe65913e576b", "Name": "sample string 1" }, "Unit": { "UnitId": "c10036db-7875-47e5-b5cf-e27a9a9a9a0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f37fb666-050d-424d-95dd-01f813dcdae5", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-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": "c35f06ab-f17a-43ef-8548-74c8f53eb29a", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-26T22:18:39.0853443-07:00", "Location": "sample string 1", "TaskId": "7bb05d6a-6f1d-4014-8e80-983a958895a6", "Values": [ { "FormFieldValueId": "5181ae5b-c7e2-45a3-8e28-42fe8378eb5e", "FormTypeField": { "FormTypeFieldId": "fe68a6d8-b869-43b1-aa75-c8e38cd5bf67", "Section": { "FormTypeSectionId": "4a111feb-41e2-4826-9156-1a574d057e31", "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": "122e9f1f-4636-467d-8c9c-fe65913e576b", "Name": "sample string 1" }, "Unit": { "UnitId": "c10036db-7875-47e5-b5cf-e27a9a9a9a0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f37fb666-050d-424d-95dd-01f813dcdae5", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-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": "5181ae5b-c7e2-45a3-8e28-42fe8378eb5e", "FormTypeField": { "FormTypeFieldId": "fe68a6d8-b869-43b1-aa75-c8e38cd5bf67", "Section": { "FormTypeSectionId": "4a111feb-41e2-4826-9156-1a574d057e31", "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": "122e9f1f-4636-467d-8c9c-fe65913e576b", "Name": "sample string 1" }, "Unit": { "UnitId": "c10036db-7875-47e5-b5cf-e27a9a9a9a0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f37fb666-050d-424d-95dd-01f813dcdae5", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T22:18:39.0853443-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": "c32c1dd0-a66b-4d23-9a0c-1e5d76780374", "CreateDate": "2025-06-26T22:18:39.0853443-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-26T22:18:39.0853443-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }