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": "30bc1824-0684-433d-9081-f1782d349a43", "Asset": { "AssetId": "6ed49c5b-be86-4f03-b979-5da336f6b974", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "544607df-424f-4315-ae45-1af02bd19e76", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a2b61131-59ab-40a9-8a0e-8b20c2eca214", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "2fccd1bc-0ff9-49b2-a05f-3d84405f0e71", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "MeasurementValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ab60da2d-29c3-440c-bdf9-8d75e73cfcf7", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "MeasurementValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e90479f7-68ed-4352-a057-c3ce496bfe9b", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "078ce0d4-73b7-4869-b1e2-f99b39fbb10b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "544607df-424f-4315-ae45-1af02bd19e76", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a2b61131-59ab-40a9-8a0e-8b20c2eca214", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "Fields": [ { "FormTypeFieldId": "c1e63935-df8d-4884-8fbb-f4bb785cb506", "Section": { "FormTypeSectionId": "60cb13ad-4412-4bf3-be8d-e1b5f883dc59", "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": "c1a8181b-b110-4cd8-b3f4-c08fd7abb101", "Name": "sample string 1" }, "Unit": { "UnitId": "6642713a-612c-465d-bf46-f09ed970d407", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a6119e5-bbf1-45ad-8e5d-616f3de40fa1", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "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": "c1e63935-df8d-4884-8fbb-f4bb785cb506", "Section": { "FormTypeSectionId": "60cb13ad-4412-4bf3-be8d-e1b5f883dc59", "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": "c1a8181b-b110-4cd8-b3f4-c08fd7abb101", "Name": "sample string 1" }, "Unit": { "UnitId": "6642713a-612c-465d-bf46-f09ed970d407", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a6119e5-bbf1-45ad-8e5d-616f3de40fa1", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "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": "e7154285-2966-4647-a0c1-440999f3f7c8", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-24T12:58:08.3700903-07:00", "Location": "sample string 1", "TaskId": "da967c31-875d-4e87-a6b2-858e168d7ae6", "Values": [ { "FormFieldValueId": "1e5a3b23-128c-41ee-a240-64567bddc463", "FormId": "b3e8480d-da39-4656-b01f-5d40776083eb", "FormTypeField": { "FormTypeFieldId": "c1e63935-df8d-4884-8fbb-f4bb785cb506", "FormType": { "FormTypeId": "078ce0d4-73b7-4869-b1e2-f99b39fbb10b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "544607df-424f-4315-ae45-1af02bd19e76", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a2b61131-59ab-40a9-8a0e-8b20c2eca214", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "e7154285-2966-4647-a0c1-440999f3f7c8", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "60cb13ad-4412-4bf3-be8d-e1b5f883dc59", "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": "c1a8181b-b110-4cd8-b3f4-c08fd7abb101", "Name": "sample string 1" }, "Unit": { "UnitId": "6642713a-612c-465d-bf46-f09ed970d407", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a6119e5-bbf1-45ad-8e5d-616f3de40fa1", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "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": "1e5a3b23-128c-41ee-a240-64567bddc463", "FormId": "b3e8480d-da39-4656-b01f-5d40776083eb", "FormTypeField": { "FormTypeFieldId": "c1e63935-df8d-4884-8fbb-f4bb785cb506", "FormType": { "FormTypeId": "078ce0d4-73b7-4869-b1e2-f99b39fbb10b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "544607df-424f-4315-ae45-1af02bd19e76", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a2b61131-59ab-40a9-8a0e-8b20c2eca214", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T12:58:08.3700903-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "e7154285-2966-4647-a0c1-440999f3f7c8", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "60cb13ad-4412-4bf3-be8d-e1b5f883dc59", "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": "c1a8181b-b110-4cd8-b3f4-c08fd7abb101", "Name": "sample string 1" }, "Unit": { "UnitId": "6642713a-612c-465d-bf46-f09ed970d407", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a6119e5-bbf1-45ad-8e5d-616f3de40fa1", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c40c5c9a-3522-4e9f-9c51-a0e1a0652173", "FieldId": "54ecf07b-a85d-4a87-9273-4f770365e8bd", "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": "5f1482cb-4795-468d-9660-4cc7f73cba9a", "CreateDate": "2025-04-24T12:58:08.3700903-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-24T12:58:08.3700903-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }