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": "ed5005b5-ad80-445d-9057-6da665514f6f", "Asset": { "AssetId": "1a6e8451-9b4e-48df-be2a-8e452452a79f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8b14a3ba-5b70-47cf-b490-97641d25d3d7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2383a097-9a62-41fb-9456-d35301e3319d", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "34210756-18c1-42e4-81d3-474c453516c7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "MeasurementValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5e541a8f-3598-4d33-9932-5009c0b4bbed", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "MeasurementValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "33553e04-1c2f-4ef8-b293-ffeedb81df01", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6a64f93e-f45f-47d3-8b32-f58e3373d062", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8b14a3ba-5b70-47cf-b490-97641d25d3d7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2383a097-9a62-41fb-9456-d35301e3319d", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "Fields": [ { "FormTypeFieldId": "eb64f0fc-3c4e-44ec-b736-77bde41ec586", "Section": { "FormTypeSectionId": "5519d9af-3b22-4340-8ce3-37c13fec8866", "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": "7abe974c-5d38-4811-a1aa-21f2d3d17502", "Name": "sample string 1" }, "Unit": { "UnitId": "003b3973-570b-46f5-89de-df3c9ed5d051", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fcc9a57f-0b63-4f8a-9a71-2960297c5b22", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "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": "eb64f0fc-3c4e-44ec-b736-77bde41ec586", "Section": { "FormTypeSectionId": "5519d9af-3b22-4340-8ce3-37c13fec8866", "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": "7abe974c-5d38-4811-a1aa-21f2d3d17502", "Name": "sample string 1" }, "Unit": { "UnitId": "003b3973-570b-46f5-89de-df3c9ed5d051", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fcc9a57f-0b63-4f8a-9a71-2960297c5b22", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "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 3", "CompanyId": "41f2d2f5-d935-488d-9daf-fbda815b9662", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-30T14:03:59.7862493-07:00", "Location": "sample string 1", "TaskId": "334a03fe-591a-4575-af84-b0a434be7b78", "Values": [ { "FormFieldValueId": "1f7cbd90-d225-4a7a-8c4a-e92116dcdd3d", "FormId": "60e657dc-1b50-499f-a3b5-7f56d37743af", "FormTypeField": { "FormTypeFieldId": "eb64f0fc-3c4e-44ec-b736-77bde41ec586", "FormType": { "FormTypeId": "6a64f93e-f45f-47d3-8b32-f58e3373d062", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8b14a3ba-5b70-47cf-b490-97641d25d3d7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2383a097-9a62-41fb-9456-d35301e3319d", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "41f2d2f5-d935-488d-9daf-fbda815b9662", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "5519d9af-3b22-4340-8ce3-37c13fec8866", "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": "7abe974c-5d38-4811-a1aa-21f2d3d17502", "Name": "sample string 1" }, "Unit": { "UnitId": "003b3973-570b-46f5-89de-df3c9ed5d051", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fcc9a57f-0b63-4f8a-9a71-2960297c5b22", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "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": "1f7cbd90-d225-4a7a-8c4a-e92116dcdd3d", "FormId": "60e657dc-1b50-499f-a3b5-7f56d37743af", "FormTypeField": { "FormTypeFieldId": "eb64f0fc-3c4e-44ec-b736-77bde41ec586", "FormType": { "FormTypeId": "6a64f93e-f45f-47d3-8b32-f58e3373d062", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8b14a3ba-5b70-47cf-b490-97641d25d3d7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2383a097-9a62-41fb-9456-d35301e3319d", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:03:59.7862493-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "41f2d2f5-d935-488d-9daf-fbda815b9662", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "5519d9af-3b22-4340-8ce3-37c13fec8866", "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": "7abe974c-5d38-4811-a1aa-21f2d3d17502", "Name": "sample string 1" }, "Unit": { "UnitId": "003b3973-570b-46f5-89de-df3c9ed5d051", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fcc9a57f-0b63-4f8a-9a71-2960297c5b22", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7d4e0b6c-1f6a-4507-9dde-ab6ef42899eb", "FieldId": "996d3b42-67ff-48ae-9e87-db314ff6f570", "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": "7d7e1a22-33e5-4ab0-a0f9-e0fb666ced5d", "CreateDate": "2025-04-30T14:03:59.7862493-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-30T14:03:59.7862493-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }