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": "d5d8f609-e058-4e89-95a5-cd403fb03638", "Asset": { "AssetId": "39ac5739-1f07-49f1-9c1a-dd498091c8b0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9b35336f-9118-455e-8734-6b191fa166ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85d0f556-1b43-4515-88c2-9157e6e3134b", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "78482211-eebf-4112-91a6-6f0ad82fb3a2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T21:02:00.0458197-07:00", "MeasurementValueNeededDate": "2025-05-08T21:02:00.0458197-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4799caac-aeaa-4b26-a0a7-52108d76bd6b", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T21:02:00.0458197-07:00", "MeasurementValueNeededDate": "2025-05-08T21:02:00.0458197-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9dcbb12d-68c2-4f29-9b01-0f45fa92a281", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6eac985b-2002-4823-9a54-cc20cdaa67e7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9b35336f-9118-455e-8734-6b191fa166ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85d0f556-1b43-4515-88c2-9157e6e3134b", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T21:02:00.0458197-07:00", "Fields": [ { "FormTypeFieldId": "dda05fa0-c5db-4b13-a77c-23101baca76d", "Section": { "FormTypeSectionId": "db9829e0-3fe8-4c07-a6bb-589d7ff9a523", "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": "63b78e4e-65cd-413a-8dd9-8ac46df67267", "Name": "sample string 1" }, "Unit": { "UnitId": "7026af5e-b8c7-447a-a830-ad5b8c0273f3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09bc2631-a038-41a4-87b5-f6ca170505a2", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-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": "dda05fa0-c5db-4b13-a77c-23101baca76d", "Section": { "FormTypeSectionId": "db9829e0-3fe8-4c07-a6bb-589d7ff9a523", "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": "63b78e4e-65cd-413a-8dd9-8ac46df67267", "Name": "sample string 1" }, "Unit": { "UnitId": "7026af5e-b8c7-447a-a830-ad5b8c0273f3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09bc2631-a038-41a4-87b5-f6ca170505a2", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-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": "abcd1b5f-86b9-46ec-9967-229da305400d", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-08T21:02:00.0458197-07:00", "Location": "sample string 1", "TaskId": "7be0d6e4-2f13-46c5-a99d-ad2cd338c645", "Values": [ { "FormFieldValueId": "a97480a9-6720-468d-be76-9b1292d042ec", "FormTypeField": { "FormTypeFieldId": "dda05fa0-c5db-4b13-a77c-23101baca76d", "Section": { "FormTypeSectionId": "db9829e0-3fe8-4c07-a6bb-589d7ff9a523", "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": "63b78e4e-65cd-413a-8dd9-8ac46df67267", "Name": "sample string 1" }, "Unit": { "UnitId": "7026af5e-b8c7-447a-a830-ad5b8c0273f3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09bc2631-a038-41a4-87b5-f6ca170505a2", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-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": "a97480a9-6720-468d-be76-9b1292d042ec", "FormTypeField": { "FormTypeFieldId": "dda05fa0-c5db-4b13-a77c-23101baca76d", "Section": { "FormTypeSectionId": "db9829e0-3fe8-4c07-a6bb-589d7ff9a523", "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": "63b78e4e-65cd-413a-8dd9-8ac46df67267", "Name": "sample string 1" }, "Unit": { "UnitId": "7026af5e-b8c7-447a-a830-ad5b8c0273f3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09bc2631-a038-41a4-87b5-f6ca170505a2", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T21:02:00.0458197-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": "9c79300b-88cf-44ad-9aaa-6484defa8c9a", "CreateDate": "2025-05-08T21:02:00.0458197-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T21:02:00.0458197-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }