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": "0ffc337d-bdcb-4a44-ac0a-62878b1dae3c", "Asset": { "AssetId": "e27f87fb-bb4f-406f-a3e6-15d667cf9b2e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e58dd234-c118-406b-9b63-7aeaf71288d3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76bd86d6-8070-476e-bbd7-6398ff9364da", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "593eabde-ca7f-48e4-acf8-62cb7b4c45b8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "MeasurementValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "SourceSystemId": "sample string 3", "CompanyId": "da63842c-55d4-4edf-b525-f51c5273c3cc", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "MeasurementValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50d9ca6e-7194-4396-a544-089965a2a8d9", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "71647b09-6886-4fbb-9fba-58275d97c8bc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e58dd234-c118-406b-9b63-7aeaf71288d3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76bd86d6-8070-476e-bbd7-6398ff9364da", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "Fields": [ { "FormTypeFieldId": "98b33b9b-565d-4689-97b1-a0b0fff7f4c4", "Section": { "FormTypeSectionId": "8859a4c2-1ad5-4396-bdb2-bf0eb236f459", "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": "35ae7b62-1d5d-49d5-a010-521fd88e53be", "Name": "sample string 1" }, "Unit": { "UnitId": "051cc03d-c21b-4cfc-bb24-2521c32d41f5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe2ea091-38d0-458a-bd8f-d12a2cd03e11", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "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": "98b33b9b-565d-4689-97b1-a0b0fff7f4c4", "Section": { "FormTypeSectionId": "8859a4c2-1ad5-4396-bdb2-bf0eb236f459", "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": "35ae7b62-1d5d-49d5-a010-521fd88e53be", "Name": "sample string 1" }, "Unit": { "UnitId": "051cc03d-c21b-4cfc-bb24-2521c32d41f5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe2ea091-38d0-458a-bd8f-d12a2cd03e11", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "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": "96fbfcab-1008-450e-b682-cb4aa57f56e6", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-12-09T01:59:26.3647126-08:00", "Location": "sample string 1", "TaskId": "8ea1a81e-3638-48ca-8eea-324f61791882", "Values": [ { "FormFieldValueId": "6d6af63a-1a99-4f7d-bf65-69df90ef8a3a", "FormId": "6778b899-0cba-4edb-b7f6-29f2c3348b92", "FormTypeField": { "FormTypeFieldId": "98b33b9b-565d-4689-97b1-a0b0fff7f4c4", "FormType": { "FormTypeId": "71647b09-6886-4fbb-9fba-58275d97c8bc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e58dd234-c118-406b-9b63-7aeaf71288d3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76bd86d6-8070-476e-bbd7-6398ff9364da", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "96fbfcab-1008-450e-b682-cb4aa57f56e6", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "8859a4c2-1ad5-4396-bdb2-bf0eb236f459", "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": "35ae7b62-1d5d-49d5-a010-521fd88e53be", "Name": "sample string 1" }, "Unit": { "UnitId": "051cc03d-c21b-4cfc-bb24-2521c32d41f5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe2ea091-38d0-458a-bd8f-d12a2cd03e11", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "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": "6d6af63a-1a99-4f7d-bf65-69df90ef8a3a", "FormId": "6778b899-0cba-4edb-b7f6-29f2c3348b92", "FormTypeField": { "FormTypeFieldId": "98b33b9b-565d-4689-97b1-a0b0fff7f4c4", "FormType": { "FormTypeId": "71647b09-6886-4fbb-9fba-58275d97c8bc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e58dd234-c118-406b-9b63-7aeaf71288d3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "76bd86d6-8070-476e-bbd7-6398ff9364da", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-09T01:59:26.3647126-08:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "96fbfcab-1008-450e-b682-cb4aa57f56e6", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "8859a4c2-1ad5-4396-bdb2-bf0eb236f459", "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": "35ae7b62-1d5d-49d5-a010-521fd88e53be", "Name": "sample string 1" }, "Unit": { "UnitId": "051cc03d-c21b-4cfc-bb24-2521c32d41f5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe2ea091-38d0-458a-bd8f-d12a2cd03e11", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a70965e8-abca-46c2-808c-f78525d5ff78", "FieldId": "9743bdc5-b184-44ef-b349-5f6f564e6e2b", "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": "f01a0c47-b460-4112-a2ac-37a30b22f934", "CreateDate": "2024-12-09T01:59:26.3647126-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-09T01:59:26.3647126-08:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }