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": "2d172fb7-58e5-4c85-a2da-5561d874ac3d", "Asset": { "AssetId": "854196ec-326e-4bd4-81f7-a0d3a07c823b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "26d3802d-b05b-43f8-8797-dd385c8ed62b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3d2bc4e7-9a5d-4895-bfaf-0d188e1569b7", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "7bf3a548-9f50-49bf-8ef5-2617f6691ef9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T01:55:19.0593653-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.0593653-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d31d7ab8-080b-412f-b7df-99a9e5863daf", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T01:55:19.0593653-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.0593653-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ab6b211a-623f-4f76-863d-bee52efd49a0", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "4c0b30d3-21ee-45c4-92e8-162a5ddcd0f7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "26d3802d-b05b-43f8-8797-dd385c8ed62b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3d2bc4e7-9a5d-4895-bfaf-0d188e1569b7", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T01:55:19.0593653-07:00", "Fields": [ { "FormTypeFieldId": "c5638d76-9f2f-4ddc-82a3-7e38ccb37f6b", "Section": { "FormTypeSectionId": "ef9983fe-b87d-429b-b627-673528ef6cd5", "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": "24f15512-7377-48cd-919e-f505db5ccf12", "Name": "sample string 1" }, "Unit": { "UnitId": "60a69c7f-3739-4fc6-a397-0e2a2c61a92a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "37dc220d-da2a-4667-9446-c58bcfa4fbbf", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "c5638d76-9f2f-4ddc-82a3-7e38ccb37f6b", "Section": { "FormTypeSectionId": "ef9983fe-b87d-429b-b627-673528ef6cd5", "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": "24f15512-7377-48cd-919e-f505db5ccf12", "Name": "sample string 1" }, "Unit": { "UnitId": "60a69c7f-3739-4fc6-a397-0e2a2c61a92a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "37dc220d-da2a-4667-9446-c58bcfa4fbbf", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "8681fbc1-96d9-4417-aac0-ba12436b1cab", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T01:55:19.0593653-07:00", "Location": "sample string 1", "TaskId": "47fd6746-0271-4ea7-ad6c-5ff120daefc2", "Values": [ { "FormFieldValueId": "56895c7c-f234-4fb4-bc63-e676699f10bf", "FormTypeField": { "FormTypeFieldId": "c5638d76-9f2f-4ddc-82a3-7e38ccb37f6b", "Section": { "FormTypeSectionId": "ef9983fe-b87d-429b-b627-673528ef6cd5", "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": "24f15512-7377-48cd-919e-f505db5ccf12", "Name": "sample string 1" }, "Unit": { "UnitId": "60a69c7f-3739-4fc6-a397-0e2a2c61a92a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "37dc220d-da2a-4667-9446-c58bcfa4fbbf", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "56895c7c-f234-4fb4-bc63-e676699f10bf", "FormTypeField": { "FormTypeFieldId": "c5638d76-9f2f-4ddc-82a3-7e38ccb37f6b", "Section": { "FormTypeSectionId": "ef9983fe-b87d-429b-b627-673528ef6cd5", "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": "24f15512-7377-48cd-919e-f505db5ccf12", "Name": "sample string 1" }, "Unit": { "UnitId": "60a69c7f-3739-4fc6-a397-0e2a2c61a92a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "37dc220d-da2a-4667-9446-c58bcfa4fbbf", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "c08807a8-c71c-432c-9495-c9376024cb02", "CreateDate": "2025-09-16T01:55:19.0593653-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T01:55:19.0593653-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }