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": "336853ed-355f-403e-ad21-bab1829349c3", "Asset": { "AssetId": "287948ec-6ff2-4a09-98ba-b3f71b5c41cc", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7a4a708b-9e31-45a7-86a4-67d3b893c4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "16074991-7eb1-49c2-af52-9700b61a3730", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e0de13d9-12a4-427b-b632-4a7d49520d90", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "MeasurementValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "SourceSystemId": "sample string 3", "CompanyId": "64b6b451-1c37-4d4b-8974-a46e561db9d1", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "MeasurementValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dfd81992-a3d8-4d04-b77f-5d8121be26fe", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "c858945a-a28e-40a5-9c8e-b33b0cca239a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7a4a708b-9e31-45a7-86a4-67d3b893c4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "16074991-7eb1-49c2-af52-9700b61a3730", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "28eecb5b-cab7-4934-a66e-9656c1fc1fc5", "Section": { "FormTypeSectionId": "c02a9adc-4f1d-4a56-be00-2f1476d5f3ab", "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": "840990ff-ced5-4d1c-9d05-b1bb138c151a", "Name": "sample string 1" }, "Unit": { "UnitId": "e4b5d165-508c-4aad-9965-524157310f15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4f14db7b-25b5-46e7-bc8a-348a1aea14a1", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "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": "28eecb5b-cab7-4934-a66e-9656c1fc1fc5", "Section": { "FormTypeSectionId": "c02a9adc-4f1d-4a56-be00-2f1476d5f3ab", "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": "840990ff-ced5-4d1c-9d05-b1bb138c151a", "Name": "sample string 1" }, "Unit": { "UnitId": "e4b5d165-508c-4aad-9965-524157310f15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4f14db7b-25b5-46e7-bc8a-348a1aea14a1", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "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": "f10e6f8b-6bf6-400f-b9a2-21f85d12f2e6", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-08-24T10:15:10.4793461-07:00", "Location": "sample string 1", "TaskId": "ffaeb7bf-4e4f-434f-8245-59f101a2ee04", "Values": [ { "FormFieldValueId": "59790b58-38e4-4f13-9f36-3e80bcae354e", "FormId": "1b6ab6f6-837a-4209-aa07-6743bc39a845", "FormTypeField": { "FormTypeFieldId": "28eecb5b-cab7-4934-a66e-9656c1fc1fc5", "FormType": { "FormTypeId": "c858945a-a28e-40a5-9c8e-b33b0cca239a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7a4a708b-9e31-45a7-86a4-67d3b893c4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "16074991-7eb1-49c2-af52-9700b61a3730", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "f10e6f8b-6bf6-400f-b9a2-21f85d12f2e6", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "c02a9adc-4f1d-4a56-be00-2f1476d5f3ab", "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": "840990ff-ced5-4d1c-9d05-b1bb138c151a", "Name": "sample string 1" }, "Unit": { "UnitId": "e4b5d165-508c-4aad-9965-524157310f15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4f14db7b-25b5-46e7-bc8a-348a1aea14a1", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "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": "59790b58-38e4-4f13-9f36-3e80bcae354e", "FormId": "1b6ab6f6-837a-4209-aa07-6743bc39a845", "FormTypeField": { "FormTypeFieldId": "28eecb5b-cab7-4934-a66e-9656c1fc1fc5", "FormType": { "FormTypeId": "c858945a-a28e-40a5-9c8e-b33b0cca239a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7a4a708b-9e31-45a7-86a4-67d3b893c4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "16074991-7eb1-49c2-af52-9700b61a3730", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:15:10.4793461-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "f10e6f8b-6bf6-400f-b9a2-21f85d12f2e6", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "c02a9adc-4f1d-4a56-be00-2f1476d5f3ab", "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": "840990ff-ced5-4d1c-9d05-b1bb138c151a", "Name": "sample string 1" }, "Unit": { "UnitId": "e4b5d165-508c-4aad-9965-524157310f15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4f14db7b-25b5-46e7-bc8a-348a1aea14a1", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ade3fb5-46cf-43a5-a2e2-0df95411c3af", "FieldId": "4ca6305b-fbc9-4727-b12c-9ed579eca9d2", "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": "56a40d0c-ebc3-4f0c-a3c6-093ab1489888", "CreateDate": "2025-08-24T10:15:10.4793461-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-24T10:15:10.4793461-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }