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": "44013718-4241-4458-a57b-eca95ed4a172", "Asset": { "AssetId": "0f3cc541-d0ec-424c-a778-dc15ae3be34d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8f24e62a-b927-4b3f-b6c1-f44730f992de", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f804298c-439b-4e4b-a33f-09472f46fb47", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "0d68cd74-0f56-4651-8164-a4a32443401c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T18:06:14.4598974-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.4598974-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7ae1a849-7d8b-45f7-b6c9-56ac7c1e36be", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T18:06:14.4598974-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.4598974-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "343a9681-2dd5-4411-808c-6a2c0fae4856", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "5710f2d4-6da4-4b6e-a86c-4365cc49150a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8f24e62a-b927-4b3f-b6c1-f44730f992de", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f804298c-439b-4e4b-a33f-09472f46fb47", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T18:06:14.4598974-07:00", "Fields": [ { "FormTypeFieldId": "762249f4-dd87-43c8-9bd9-327af4019c61", "Section": { "FormTypeSectionId": "88d9f03b-1b0d-40e7-ba74-ad46f95d51e9", "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": "ad4d8b50-2a79-43e9-b823-43886b628d84", "Name": "sample string 1" }, "Unit": { "UnitId": "d2ccf71e-63f2-4705-8565-2fdfe3fc61d7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a113ac82-cc85-4669-a53e-3af3168d7439", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-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": "762249f4-dd87-43c8-9bd9-327af4019c61", "Section": { "FormTypeSectionId": "88d9f03b-1b0d-40e7-ba74-ad46f95d51e9", "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": "ad4d8b50-2a79-43e9-b823-43886b628d84", "Name": "sample string 1" }, "Unit": { "UnitId": "d2ccf71e-63f2-4705-8565-2fdfe3fc61d7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a113ac82-cc85-4669-a53e-3af3168d7439", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-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": "7bf4d2a8-bf1d-4fe2-8e2f-b7abe09abdca", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T18:06:14.4598974-07:00", "Location": "sample string 1", "TaskId": "6eb1fffa-b50d-4db3-80b2-e11882f464ea", "Values": [ { "FormFieldValueId": "86d39dae-26ce-4989-ae7c-b8dd456243b0", "FormTypeField": { "FormTypeFieldId": "762249f4-dd87-43c8-9bd9-327af4019c61", "Section": { "FormTypeSectionId": "88d9f03b-1b0d-40e7-ba74-ad46f95d51e9", "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": "ad4d8b50-2a79-43e9-b823-43886b628d84", "Name": "sample string 1" }, "Unit": { "UnitId": "d2ccf71e-63f2-4705-8565-2fdfe3fc61d7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a113ac82-cc85-4669-a53e-3af3168d7439", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-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": "86d39dae-26ce-4989-ae7c-b8dd456243b0", "FormTypeField": { "FormTypeFieldId": "762249f4-dd87-43c8-9bd9-327af4019c61", "Section": { "FormTypeSectionId": "88d9f03b-1b0d-40e7-ba74-ad46f95d51e9", "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": "ad4d8b50-2a79-43e9-b823-43886b628d84", "Name": "sample string 1" }, "Unit": { "UnitId": "d2ccf71e-63f2-4705-8565-2fdfe3fc61d7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a113ac82-cc85-4669-a53e-3af3168d7439", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.4598974-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": "9efff364-ca1f-4529-9a2a-643218e1ba05", "CreateDate": "2025-10-13T18:06:14.4598974-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T18:06:14.4598974-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }