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": "8dd2badc-5af5-4040-b3bf-89e86768d069", "Asset": { "AssetId": "2fe3d580-5773-413b-888a-62db1b5bd831", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2b6ce1d5-e2c8-440d-8afa-1844f50c087d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "151049c6-a84a-4bb9-83e9-76eebd5a7744", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "b3e75b39-471f-48ec-8200-797c500ac461", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "MeasurementValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1ce76d9e-b48b-4af8-be61-c379433cd505", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "MeasurementValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "bd8f66be-4b8b-4e2b-8192-f0a8d5d21753", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "be95182c-fc37-42ff-8bae-22ebb3e58286", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2b6ce1d5-e2c8-440d-8afa-1844f50c087d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "151049c6-a84a-4bb9-83e9-76eebd5a7744", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "78fdaa19-9f80-453e-a3ff-dbddefc3c17f", "Section": { "FormTypeSectionId": "9a80acc9-e9c2-4a97-9b58-08ffa7224170", "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": "1e94deb0-9ec5-4f35-9eca-7bda5a356ee9", "Name": "sample string 1" }, "Unit": { "UnitId": "02e83e22-a740-49f4-902d-f0f952992322", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "684c1e71-1ace-4d9f-bdf6-38bb4e665c15", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "78fdaa19-9f80-453e-a3ff-dbddefc3c17f", "Section": { "FormTypeSectionId": "9a80acc9-e9c2-4a97-9b58-08ffa7224170", "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": "1e94deb0-9ec5-4f35-9eca-7bda5a356ee9", "Name": "sample string 1" }, "Unit": { "UnitId": "02e83e22-a740-49f4-902d-f0f952992322", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "684c1e71-1ace-4d9f-bdf6-38bb4e665c15", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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 4", "CompanyId": "3ce7144b-6f45-49bd-be25-12b1b25da9ee", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-08-23T22:44:31.7067014-07:00", "Location": "sample string 1", "TaskId": "dfade7b5-0a89-4134-8242-826b5bbddfce", "Values": [ { "FormFieldValueId": "5f101e7f-fe5b-4d53-98da-c36689421e79", "FormId": "431e6ccd-ea80-4582-90ba-014f9929322a", "FormTypeField": { "FormTypeFieldId": "78fdaa19-9f80-453e-a3ff-dbddefc3c17f", "FormType": { "FormTypeId": "be95182c-fc37-42ff-8bae-22ebb3e58286", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2b6ce1d5-e2c8-440d-8afa-1844f50c087d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "151049c6-a84a-4bb9-83e9-76eebd5a7744", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "3ce7144b-6f45-49bd-be25-12b1b25da9ee", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "9a80acc9-e9c2-4a97-9b58-08ffa7224170", "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": "1e94deb0-9ec5-4f35-9eca-7bda5a356ee9", "Name": "sample string 1" }, "Unit": { "UnitId": "02e83e22-a740-49f4-902d-f0f952992322", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "684c1e71-1ace-4d9f-bdf6-38bb4e665c15", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "5f101e7f-fe5b-4d53-98da-c36689421e79", "FormId": "431e6ccd-ea80-4582-90ba-014f9929322a", "FormTypeField": { "FormTypeFieldId": "78fdaa19-9f80-453e-a3ff-dbddefc3c17f", "FormType": { "FormTypeId": "be95182c-fc37-42ff-8bae-22ebb3e58286", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2b6ce1d5-e2c8-440d-8afa-1844f50c087d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "151049c6-a84a-4bb9-83e9-76eebd5a7744", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-23T22:44:31.7067014-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "3ce7144b-6f45-49bd-be25-12b1b25da9ee", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "9a80acc9-e9c2-4a97-9b58-08ffa7224170", "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": "1e94deb0-9ec5-4f35-9eca-7bda5a356ee9", "Name": "sample string 1" }, "Unit": { "UnitId": "02e83e22-a740-49f4-902d-f0f952992322", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "684c1e71-1ace-4d9f-bdf6-38bb4e665c15", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f56c4969-0ef6-4445-b7e6-4ff20f9c3ff0", "FieldId": "ee83f634-4ad0-49d7-b90d-ac10da08582a", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "91b046f0-4cfd-451d-9b38-453b4a9999c2", "CreateDate": "2025-08-23T22:44:31.7067014-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-23T22:44:31.7067014-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }