DELETE Forms
Deletes the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to delete.
FormName | Description | Type | Additional information |
---|---|---|---|
FormId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
FormType | FormType |
None. |
|
EffectiveDate | date |
None. |
|
Location | string |
None. |
|
TaskId | globally unique identifier |
None. |
|
Values | Collection of FormFieldValue |
None. |
|
SourceSystemId | string |
None. |
|
CompanyId | globally unique identifier |
None. |
|
CreateDate | date |
None. |
|
CreateUser | string |
None. |
|
LastModifiedDate | date |
None. |
|
LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormId": "c57098d8-6e24-442b-9da9-049e9e394e72", "Asset": { "AssetId": "a9d2b715-d244-463e-aa55-aba46b52acf4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "48963605-6eeb-4deb-9565-48cdda4f1cb9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7dfa1ea7-e436-4b20-9bce-423741b65a7d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4a179621-da44-4b0f-818f-aa6403fcebdb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "MeasurementValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f5e3afe2-e7e0-4004-a3f7-9ec817b8691c", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "MeasurementValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9f85800d-82a0-40ac-9f7e-afcd47b9b26d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "050911e2-cf67-4031-9c71-16d8b1b1c335", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "48963605-6eeb-4deb-9565-48cdda4f1cb9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7dfa1ea7-e436-4b20-9bce-423741b65a7d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "eb65f58a-76c5-4e71-a94e-e3e400452ddb", "Section": { "FormTypeSectionId": "e88fd684-0ad7-456c-96a8-eaac706f880b", "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": "6b94d015-869e-430d-b12f-df23f0999273", "Name": "sample string 1" }, "Unit": { "UnitId": "f9d2dc80-4e8d-4183-aa11-c621b8b259e7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e143ca99-f931-476e-92e7-4b7b1bbc840d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "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": "eb65f58a-76c5-4e71-a94e-e3e400452ddb", "Section": { "FormTypeSectionId": "e88fd684-0ad7-456c-96a8-eaac706f880b", "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": "6b94d015-869e-430d-b12f-df23f0999273", "Name": "sample string 1" }, "Unit": { "UnitId": "f9d2dc80-4e8d-4183-aa11-c621b8b259e7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e143ca99-f931-476e-92e7-4b7b1bbc840d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "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": "57fff77d-b95e-45bd-aee7-3680bbf26481", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-09-13T21:07:42.2438358-07:00", "Location": "sample string 1", "TaskId": "a8c03684-0e49-45fc-b06a-9cff9f084c00", "Values": [ { "FormFieldValueId": "07a62f8f-e68f-4837-9558-ee815d177470", "FormId": "0ed3119b-e45c-4206-918f-a85a5985f438", "FormTypeField": { "FormTypeFieldId": "eb65f58a-76c5-4e71-a94e-e3e400452ddb", "FormType": { "FormTypeId": "050911e2-cf67-4031-9c71-16d8b1b1c335", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "48963605-6eeb-4deb-9565-48cdda4f1cb9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7dfa1ea7-e436-4b20-9bce-423741b65a7d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "57fff77d-b95e-45bd-aee7-3680bbf26481", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "e88fd684-0ad7-456c-96a8-eaac706f880b", "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": "6b94d015-869e-430d-b12f-df23f0999273", "Name": "sample string 1" }, "Unit": { "UnitId": "f9d2dc80-4e8d-4183-aa11-c621b8b259e7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e143ca99-f931-476e-92e7-4b7b1bbc840d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "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": "07a62f8f-e68f-4837-9558-ee815d177470", "FormId": "0ed3119b-e45c-4206-918f-a85a5985f438", "FormTypeField": { "FormTypeFieldId": "eb65f58a-76c5-4e71-a94e-e3e400452ddb", "FormType": { "FormTypeId": "050911e2-cf67-4031-9c71-16d8b1b1c335", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "48963605-6eeb-4deb-9565-48cdda4f1cb9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7dfa1ea7-e436-4b20-9bce-423741b65a7d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:07:42.2438358-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "57fff77d-b95e-45bd-aee7-3680bbf26481", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "e88fd684-0ad7-456c-96a8-eaac706f880b", "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": "6b94d015-869e-430d-b12f-df23f0999273", "Name": "sample string 1" }, "Unit": { "UnitId": "f9d2dc80-4e8d-4183-aa11-c621b8b259e7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e143ca99-f931-476e-92e7-4b7b1bbc840d", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1ac31632-1be6-4ee6-950e-22b5a31a0daf", "FieldId": "e4987b5d-4a09-4fd3-9cbf-13628ea53857", "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": "dcaf5f55-bf2a-41e9-93ad-c56ac6d6cb49", "CreateDate": "2025-09-13T21:07:42.2438358-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:07:42.2438358-07:00", "LastModifiedUser": "sample string 5" }
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
Data | Object |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": {}, "Total": 1, "Message": "sample string 2" }