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": "33212e03-378e-4c80-a878-68fef5233012", "Asset": { "AssetId": "6f118f1f-83e6-4621-bc2b-8cb58c422658", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c6415717-7c87-4d7f-81d5-3ae5856219fd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6c8ed93d-5e98-4ff6-a4a2-fba8536fa29b", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "2694aa58-6a3a-4d27-a1ce-9105539f8f40", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:59:05.0329301-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:05.0329301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f3788b5d-46be-4414-b60c-521a2693d15a", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-30T12:59:05.0329301-07:00", "MeasurementValueNeededDate": "2025-08-30T12:59:05.0329301-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e92cfdc7-4c3e-47e5-909a-b413fdfb02e4", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "270495b6-8df3-4ee6-8840-01d03304e0f6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c6415717-7c87-4d7f-81d5-3ae5856219fd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6c8ed93d-5e98-4ff6-a4a2-fba8536fa29b", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:59:05.0329301-07:00", "Fields": [ { "FormTypeFieldId": "8c08b82b-f347-40d0-977c-f64569266b2b", "Section": { "FormTypeSectionId": "d7b02781-eb1d-448d-bf3e-d50abed5773c", "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": "bd02529b-3519-48ac-96ed-cd22dc253662", "Name": "sample string 1" }, "Unit": { "UnitId": "a15f52ce-b842-434d-8379-dc47d5b30803", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d30e8215-77ea-40ca-8534-2656c71d565f", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-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": "8c08b82b-f347-40d0-977c-f64569266b2b", "Section": { "FormTypeSectionId": "d7b02781-eb1d-448d-bf3e-d50abed5773c", "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": "bd02529b-3519-48ac-96ed-cd22dc253662", "Name": "sample string 1" }, "Unit": { "UnitId": "a15f52ce-b842-434d-8379-dc47d5b30803", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d30e8215-77ea-40ca-8534-2656c71d565f", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-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": "8a56fc62-2505-4f51-b264-f71f23791c0f", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-30T12:59:05.0329301-07:00", "Location": "sample string 1", "TaskId": "cae4c0a1-a41d-49ed-870f-ccc30668aaa8", "Values": [ { "FormFieldValueId": "d42a599e-53df-469a-ad88-f7ca8860594f", "FormTypeField": { "FormTypeFieldId": "8c08b82b-f347-40d0-977c-f64569266b2b", "Section": { "FormTypeSectionId": "d7b02781-eb1d-448d-bf3e-d50abed5773c", "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": "bd02529b-3519-48ac-96ed-cd22dc253662", "Name": "sample string 1" }, "Unit": { "UnitId": "a15f52ce-b842-434d-8379-dc47d5b30803", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d30e8215-77ea-40ca-8534-2656c71d565f", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-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": "d42a599e-53df-469a-ad88-f7ca8860594f", "FormTypeField": { "FormTypeFieldId": "8c08b82b-f347-40d0-977c-f64569266b2b", "Section": { "FormTypeSectionId": "d7b02781-eb1d-448d-bf3e-d50abed5773c", "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": "bd02529b-3519-48ac-96ed-cd22dc253662", "Name": "sample string 1" }, "Unit": { "UnitId": "a15f52ce-b842-434d-8379-dc47d5b30803", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d30e8215-77ea-40ca-8534-2656c71d565f", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:59:05.0329301-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": "74f0a2a5-cbaa-476f-8410-4036dce65693", "CreateDate": "2025-08-30T12:59:05.0329301-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-30T12:59:05.0329301-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }