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": "2c27b95d-62d0-4789-a263-d40a194e8bde", "Asset": { "AssetId": "841f991e-7b29-4632-9fa3-e7e8ad7cb1b3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6a245c68-3dcd-4e81-ad0d-4467d2b46a02", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "08f197a8-1a9a-464e-9ada-836ca91568b9", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "267024b9-7e15-4b5e-835a-5f508b7dddf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "MeasurementValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "SourceSystemId": "sample string 3", "CompanyId": "65abc71c-df4a-4906-aeb5-66fe3cf3a12d", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "MeasurementValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3e661de6-a887-467d-b090-be604d7f1807", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "d80feb24-599e-4c77-9565-0437b740b754", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6a245c68-3dcd-4e81-ad0d-4467d2b46a02", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "08f197a8-1a9a-464e-9ada-836ca91568b9", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f07d3989-af78-46ba-ac27-8454a644b6c8", "Section": { "FormTypeSectionId": "5cd23ffa-dc0d-4509-8b00-06ef37706088", "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": "84cec718-ae8a-42c2-9e9f-f8f098099bd2", "Name": "sample string 1" }, "Unit": { "UnitId": "cb57ad84-73e9-419f-a4f3-d5d4039d9002", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d68d8e9a-3bde-43e5-9c50-9ca3ffd61082", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "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": "f07d3989-af78-46ba-ac27-8454a644b6c8", "Section": { "FormTypeSectionId": "5cd23ffa-dc0d-4509-8b00-06ef37706088", "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": "84cec718-ae8a-42c2-9e9f-f8f098099bd2", "Name": "sample string 1" }, "Unit": { "UnitId": "cb57ad84-73e9-419f-a4f3-d5d4039d9002", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d68d8e9a-3bde-43e5-9c50-9ca3ffd61082", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "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": "925aac9f-a790-4002-beb1-87306906f848", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-06-22T23:05:34.1421051-07:00", "Location": "sample string 1", "TaskId": "b131eeca-e841-43e4-a091-eba71177c024", "Values": [ { "FormFieldValueId": "5759f07d-abf6-404b-9705-d8f2cc7b32a8", "FormId": "5290ab17-c1b6-4c0b-a00e-52dbad310a22", "FormTypeField": { "FormTypeFieldId": "f07d3989-af78-46ba-ac27-8454a644b6c8", "FormType": { "FormTypeId": "d80feb24-599e-4c77-9565-0437b740b754", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6a245c68-3dcd-4e81-ad0d-4467d2b46a02", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "08f197a8-1a9a-464e-9ada-836ca91568b9", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "925aac9f-a790-4002-beb1-87306906f848", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "5cd23ffa-dc0d-4509-8b00-06ef37706088", "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": "84cec718-ae8a-42c2-9e9f-f8f098099bd2", "Name": "sample string 1" }, "Unit": { "UnitId": "cb57ad84-73e9-419f-a4f3-d5d4039d9002", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d68d8e9a-3bde-43e5-9c50-9ca3ffd61082", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "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": "5759f07d-abf6-404b-9705-d8f2cc7b32a8", "FormId": "5290ab17-c1b6-4c0b-a00e-52dbad310a22", "FormTypeField": { "FormTypeFieldId": "f07d3989-af78-46ba-ac27-8454a644b6c8", "FormType": { "FormTypeId": "d80feb24-599e-4c77-9565-0437b740b754", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6a245c68-3dcd-4e81-ad0d-4467d2b46a02", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "08f197a8-1a9a-464e-9ada-836ca91568b9", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:05:34.1421051-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "925aac9f-a790-4002-beb1-87306906f848", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "5cd23ffa-dc0d-4509-8b00-06ef37706088", "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": "84cec718-ae8a-42c2-9e9f-f8f098099bd2", "Name": "sample string 1" }, "Unit": { "UnitId": "cb57ad84-73e9-419f-a4f3-d5d4039d9002", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d68d8e9a-3bde-43e5-9c50-9ca3ffd61082", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "fca9e4d7-fc82-4bb7-8a23-163bbceea5d0", "FieldId": "7bb13b32-cebe-4c6e-b073-fd6b14751c71", "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": "8ec37d2a-3f1c-423e-a268-ddf98daeb7fd", "CreateDate": "2025-06-22T23:05:34.1421051-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:05:34.1421051-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }