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": "bad1a620-f609-4221-ba7b-41a837190727", "Asset": { "AssetId": "6e32524c-ad7d-4594-b4fd-874b3b710d79", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "91f1f5c2-1c94-4059-a30e-53be3298fb1f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2e376a1b-f3dc-45fe-a258-beedc27cba9d", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e550e35a-1ae0-41c7-aae5-208ec953d670", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3fcf9a5d-6c5b-4a3e-a10c-76cf976ecb2c", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2ca66cf5-e768-4dcd-b702-1554600dcbe3", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7ec8c321-3b30-4ee9-87e0-bac8c48f1b86", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "91f1f5c2-1c94-4059-a30e-53be3298fb1f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2e376a1b-f3dc-45fe-a258-beedc27cba9d", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "596f86df-b598-44df-be21-6280cf7f9316", "Section": { "FormTypeSectionId": "99164076-6a33-45fd-8ad0-ed2663cecabc", "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": "e6092f41-ab45-451c-8d9c-d91e662bb12a", "Name": "sample string 1" }, "Unit": { "UnitId": "20254499-76d4-4362-af18-7a9d33e8b58d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f9342d57-1776-4c5c-bf7f-0843779c2d9c", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "596f86df-b598-44df-be21-6280cf7f9316", "Section": { "FormTypeSectionId": "99164076-6a33-45fd-8ad0-ed2663cecabc", "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": "e6092f41-ab45-451c-8d9c-d91e662bb12a", "Name": "sample string 1" }, "Unit": { "UnitId": "20254499-76d4-4362-af18-7a9d33e8b58d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f9342d57-1776-4c5c-bf7f-0843779c2d9c", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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 4", "CompanyId": "7223b010-4ffd-424b-b0e6-9d9d54384175", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-06-30T20:38:55.8773862-07:00", "Location": "sample string 1", "TaskId": "afff49ec-5e90-4d9a-ba64-6a48febd05fe", "Values": [ { "FormFieldValueId": "2f612288-80b6-4d1a-a568-1c58f0608722", "FormId": "6f02c28e-a89d-4601-8da7-c6929bca8bd7", "FormTypeField": { "FormTypeFieldId": "596f86df-b598-44df-be21-6280cf7f9316", "FormType": { "FormTypeId": "7ec8c321-3b30-4ee9-87e0-bac8c48f1b86", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "91f1f5c2-1c94-4059-a30e-53be3298fb1f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2e376a1b-f3dc-45fe-a258-beedc27cba9d", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "7223b010-4ffd-424b-b0e6-9d9d54384175", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "99164076-6a33-45fd-8ad0-ed2663cecabc", "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": "e6092f41-ab45-451c-8d9c-d91e662bb12a", "Name": "sample string 1" }, "Unit": { "UnitId": "20254499-76d4-4362-af18-7a9d33e8b58d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f9342d57-1776-4c5c-bf7f-0843779c2d9c", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "2f612288-80b6-4d1a-a568-1c58f0608722", "FormId": "6f02c28e-a89d-4601-8da7-c6929bca8bd7", "FormTypeField": { "FormTypeFieldId": "596f86df-b598-44df-be21-6280cf7f9316", "FormType": { "FormTypeId": "7ec8c321-3b30-4ee9-87e0-bac8c48f1b86", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "91f1f5c2-1c94-4059-a30e-53be3298fb1f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2e376a1b-f3dc-45fe-a258-beedc27cba9d", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T20:38:55.8773862-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "7223b010-4ffd-424b-b0e6-9d9d54384175", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "99164076-6a33-45fd-8ad0-ed2663cecabc", "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": "e6092f41-ab45-451c-8d9c-d91e662bb12a", "Name": "sample string 1" }, "Unit": { "UnitId": "20254499-76d4-4362-af18-7a9d33e8b58d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f9342d57-1776-4c5c-bf7f-0843779c2d9c", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e12a2c82-c05e-4bb5-8fc8-e65b1b3dc6a3", "FieldId": "462b536c-0161-49d8-8e35-f4927e90583f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "10dfd37b-321f-4bad-a71d-dd0ab40f7b5f", "CreateDate": "2025-06-30T20:38:55.8773862-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-30T20:38:55.8773862-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }