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": "93b17b76-1dca-4993-b614-e0191d66a76a", "Asset": { "AssetId": "f5176917-e1a4-4083-86c1-cbf7e74e7b5d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2efbc4bc-d310-4a49-a5fb-af4e7b9f7aa5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04215be8-6e02-4564-94ba-1f8fdc1030e4", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "5f075b31-7ddc-4c4c-9c50-718b199f66c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "MeasurementValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ad612dae-3366-48e5-84f6-808da9e6e429", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "MeasurementValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d7d733c6-85a0-41ac-bbae-badd0a78f51c", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "db331106-c258-4f4f-bccc-b4c28167f62e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2efbc4bc-d310-4a49-a5fb-af4e7b9f7aa5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04215be8-6e02-4564-94ba-1f8fdc1030e4", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "Fields": [ { "FormTypeFieldId": "28d43420-f5a0-496f-9d63-b00e4783e3d8", "Section": { "FormTypeSectionId": "94925ccf-f750-41b2-b8f0-21869cae0702", "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": "e6141f5c-6b9d-4c47-8460-caafcbaef9e4", "Name": "sample string 1" }, "Unit": { "UnitId": "9ee41c21-51e0-4fbe-a47d-91467ecf59e4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a63f3389-3e59-44b7-88f4-b0a7b9b634b8", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "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": "28d43420-f5a0-496f-9d63-b00e4783e3d8", "Section": { "FormTypeSectionId": "94925ccf-f750-41b2-b8f0-21869cae0702", "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": "e6141f5c-6b9d-4c47-8460-caafcbaef9e4", "Name": "sample string 1" }, "Unit": { "UnitId": "9ee41c21-51e0-4fbe-a47d-91467ecf59e4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a63f3389-3e59-44b7-88f4-b0a7b9b634b8", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "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": "7df17874-a768-4d34-b20f-e63eb7c043fb", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-03T15:16:55.806012-07:00", "Location": "sample string 1", "TaskId": "708d0876-d125-4323-a7b1-662f4410bca3", "Values": [ { "FormFieldValueId": "8ccef930-d915-46d7-afeb-1b5b0dcfe1f6", "FormId": "774849bf-176d-47ed-b333-113d65dd6938", "FormTypeField": { "FormTypeFieldId": "28d43420-f5a0-496f-9d63-b00e4783e3d8", "FormType": { "FormTypeId": "db331106-c258-4f4f-bccc-b4c28167f62e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2efbc4bc-d310-4a49-a5fb-af4e7b9f7aa5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04215be8-6e02-4564-94ba-1f8fdc1030e4", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "7df17874-a768-4d34-b20f-e63eb7c043fb", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "94925ccf-f750-41b2-b8f0-21869cae0702", "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": "e6141f5c-6b9d-4c47-8460-caafcbaef9e4", "Name": "sample string 1" }, "Unit": { "UnitId": "9ee41c21-51e0-4fbe-a47d-91467ecf59e4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a63f3389-3e59-44b7-88f4-b0a7b9b634b8", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "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": "8ccef930-d915-46d7-afeb-1b5b0dcfe1f6", "FormId": "774849bf-176d-47ed-b333-113d65dd6938", "FormTypeField": { "FormTypeFieldId": "28d43420-f5a0-496f-9d63-b00e4783e3d8", "FormType": { "FormTypeId": "db331106-c258-4f4f-bccc-b4c28167f62e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2efbc4bc-d310-4a49-a5fb-af4e7b9f7aa5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04215be8-6e02-4564-94ba-1f8fdc1030e4", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-03T15:16:55.806012-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "7df17874-a768-4d34-b20f-e63eb7c043fb", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "94925ccf-f750-41b2-b8f0-21869cae0702", "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": "e6141f5c-6b9d-4c47-8460-caafcbaef9e4", "Name": "sample string 1" }, "Unit": { "UnitId": "9ee41c21-51e0-4fbe-a47d-91467ecf59e4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a63f3389-3e59-44b7-88f4-b0a7b9b634b8", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca2ceb23-3a4c-4743-9511-d2f21bd29c26", "FieldId": "5cd65164-bf35-4e12-9a8d-ba62229daa8b", "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": "f4d07c70-13db-4c05-ad67-ed0ec83d6f4a", "CreateDate": "2025-04-03T15:16:55.806012-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-03T15:16:55.806012-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }