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": "2e4f4245-30a4-4d8b-bcb5-e74e5e57516e", "Asset": { "AssetId": "3b14e8fc-3a88-4f13-9743-6d1697522519", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "027e269d-d416-4216-bf1c-d4e53cd8d99b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3b30a25b-257e-4547-97f7-46ff96d2fef6", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "67bdcac1-22d3-43cc-89db-9eea16aa3f40", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:46:38.9348083-07:00", "MeasurementValueNeededDate": "2025-09-16T23:46:38.9348083-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e80eb554-6046-4db4-a0c4-4d6036129fbd", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T23:46:38.9348083-07:00", "MeasurementValueNeededDate": "2025-09-16T23:46:38.9348083-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9e8a1220-057b-4f84-9fc6-24e6c1f68230", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "64e0c351-5051-4ff3-8444-cf25cb069759", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "027e269d-d416-4216-bf1c-d4e53cd8d99b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3b30a25b-257e-4547-97f7-46ff96d2fef6", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T23:46:38.9348083-07:00", "Fields": [ { "FormTypeFieldId": "cd9d99e0-55d2-45b9-ba0b-29b01c8b5e12", "Section": { "FormTypeSectionId": "49786ef6-8164-499c-969d-57f54d6519b7", "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": "1a2ebd37-524c-481d-b4b1-60afc22bfedf", "Name": "sample string 1" }, "Unit": { "UnitId": "13085ea1-5edc-436b-ac95-5036086bc082", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ec1c4f6-9a76-47d9-ab8b-8bbd0f80f884", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-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": "cd9d99e0-55d2-45b9-ba0b-29b01c8b5e12", "Section": { "FormTypeSectionId": "49786ef6-8164-499c-969d-57f54d6519b7", "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": "1a2ebd37-524c-481d-b4b1-60afc22bfedf", "Name": "sample string 1" }, "Unit": { "UnitId": "13085ea1-5edc-436b-ac95-5036086bc082", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ec1c4f6-9a76-47d9-ab8b-8bbd0f80f884", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-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": "68e8016d-87fc-4360-bdba-6ff63067581b", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T23:46:38.9348083-07:00", "Location": "sample string 1", "TaskId": "a3d4008b-3f65-49c1-a8eb-1d159ea0ef36", "Values": [ { "FormFieldValueId": "d5c82cf6-a2f5-4932-9d53-44242ba10d8c", "FormTypeField": { "FormTypeFieldId": "cd9d99e0-55d2-45b9-ba0b-29b01c8b5e12", "Section": { "FormTypeSectionId": "49786ef6-8164-499c-969d-57f54d6519b7", "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": "1a2ebd37-524c-481d-b4b1-60afc22bfedf", "Name": "sample string 1" }, "Unit": { "UnitId": "13085ea1-5edc-436b-ac95-5036086bc082", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ec1c4f6-9a76-47d9-ab8b-8bbd0f80f884", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-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": "d5c82cf6-a2f5-4932-9d53-44242ba10d8c", "FormTypeField": { "FormTypeFieldId": "cd9d99e0-55d2-45b9-ba0b-29b01c8b5e12", "Section": { "FormTypeSectionId": "49786ef6-8164-499c-969d-57f54d6519b7", "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": "1a2ebd37-524c-481d-b4b1-60afc22bfedf", "Name": "sample string 1" }, "Unit": { "UnitId": "13085ea1-5edc-436b-ac95-5036086bc082", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ec1c4f6-9a76-47d9-ab8b-8bbd0f80f884", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:46:38.9348083-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": "a2a5ef2b-cc54-49a5-b458-4d0d40c89d25", "CreateDate": "2025-09-16T23:46:38.9348083-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T23:46:38.9348083-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }