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": "7a341dae-694f-43f7-a8b7-538a7f9a8b97", "Asset": { "AssetId": "c80a859a-d52c-489d-9d4b-51170bbb0a73", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e282f87d-07e7-4fc4-afff-010c40203681", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b25b356a-5a07-4485-a2f5-9fb9fb57f90b", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "42f6d506-6bd9-48f2-bebd-5b45745145a6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-17T05:10:22.9241562-07:00", "MeasurementValueNeededDate": "2025-05-17T05:10:22.9241562-07:00", "SourceSystemId": "sample string 3", "CompanyId": "71fffd48-dfd4-44a1-ad14-979f2043cbe6", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-17T05:10:22.9241562-07:00", "MeasurementValueNeededDate": "2025-05-17T05:10:22.9241562-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ccd8a406-ca24-4b55-a9cc-94f3310f7154", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "48a61874-b319-4672-90a3-ecea8caa5844", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e282f87d-07e7-4fc4-afff-010c40203681", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b25b356a-5a07-4485-a2f5-9fb9fb57f90b", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-17T05:10:22.9241562-07:00", "Fields": [ { "FormTypeFieldId": "82f00e1f-db2a-4ffc-b9fc-19b8ffc88531", "Section": { "FormTypeSectionId": "aafb5fdc-c883-4af7-a615-6ed130b677ae", "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": "efd9228c-0021-4bc4-a6ef-335e1d220ecb", "Name": "sample string 1" }, "Unit": { "UnitId": "d772f5bd-c232-407b-bcf5-ce4220390e1d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c958ec13-4ae2-4fbd-9600-38de3fb6a957", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-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": "82f00e1f-db2a-4ffc-b9fc-19b8ffc88531", "Section": { "FormTypeSectionId": "aafb5fdc-c883-4af7-a615-6ed130b677ae", "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": "efd9228c-0021-4bc4-a6ef-335e1d220ecb", "Name": "sample string 1" }, "Unit": { "UnitId": "d772f5bd-c232-407b-bcf5-ce4220390e1d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c958ec13-4ae2-4fbd-9600-38de3fb6a957", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-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": "5ee7abaa-9d7f-4a2c-8766-8f71642115e9", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-17T05:10:22.9241562-07:00", "Location": "sample string 1", "TaskId": "e68abf6d-68f2-4a0c-826a-55fa47f5a803", "Values": [ { "FormFieldValueId": "0b8848f9-4681-4147-9188-3bf439530743", "FormTypeField": { "FormTypeFieldId": "82f00e1f-db2a-4ffc-b9fc-19b8ffc88531", "Section": { "FormTypeSectionId": "aafb5fdc-c883-4af7-a615-6ed130b677ae", "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": "efd9228c-0021-4bc4-a6ef-335e1d220ecb", "Name": "sample string 1" }, "Unit": { "UnitId": "d772f5bd-c232-407b-bcf5-ce4220390e1d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c958ec13-4ae2-4fbd-9600-38de3fb6a957", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-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": "0b8848f9-4681-4147-9188-3bf439530743", "FormTypeField": { "FormTypeFieldId": "82f00e1f-db2a-4ffc-b9fc-19b8ffc88531", "Section": { "FormTypeSectionId": "aafb5fdc-c883-4af7-a615-6ed130b677ae", "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": "efd9228c-0021-4bc4-a6ef-335e1d220ecb", "Name": "sample string 1" }, "Unit": { "UnitId": "d772f5bd-c232-407b-bcf5-ce4220390e1d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c958ec13-4ae2-4fbd-9600-38de3fb6a957", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-17T05:10:22.9241562-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": "2b7a3958-3531-4616-a47b-6d12cea35bd1", "CreateDate": "2025-05-17T05:10:22.9241562-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-17T05:10:22.9241562-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }