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": "f96293c2-bfde-4078-88af-0d0517202f38", "Asset": { "AssetId": "72bfc6d2-2044-4a14-bd70-c74b9a3782b2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a524d480-7357-493a-a792-458d62c88d9b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "MeasurementValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8aec1709-9eb7-4367-8aa7-9d97d06b3ab1", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "55cf7624-2efa-4a9a-bd8d-32570b6f69ef", "EffectiveDate": "2025-07-19T00:33:33.8188878-07:00", "StateType": { "StateTypeId": "200ca719-b7be-4744-b9b0-344131be72b8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "fc18f220-c134-4900-8652-cbb38fb0b626", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c5ec56ec-ffdd-4ce0-aa59-5e147fed535c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "b1eda987-9aff-4446-a188-20e062f81eb9", "EffectiveDate": "2025-07-19T00:33:33.8188878-07:00", "StatusType": { "StatusTypeId": "d23aa577-5a22-4169-824d-487c4b339d92", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "834fe9aa-872c-45cb-b07c-a52da366f83a", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b0d9d055-642a-4999-b703-dfdfc310d47a", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "86f602fe-d937-4e13-81e9-04e7a4363860", "EffectiveDate": "2025-07-19T00:33:33.8188878-07:00", "WellPurposeType": { "WellPurposeTypeId": "339d234f-5d3d-4f03-ae68-3f7f7d11d469", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0134d0f3-97cf-4508-ac58-ab42e64bc4bc", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8f35b764-a59a-41d3-8a40-1466dc3101ff", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "MeasurementValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9c193c21-98e7-4545-b6a9-de518f9b5d2f", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "e64887f3-2e24-4c03-a34c-9a5399f44ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "Fields": [ { "FormTypeFieldId": "23ccf10c-d3e1-4aff-8892-378d80ad9b5b", "Section": { "FormTypeSectionId": "e33716d3-2ec2-42ae-b1f7-dc85402277ed", "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": "6d6dc2b7-637b-460a-91f1-05f46d6a5863", "Name": "sample string 1" }, "Unit": { "UnitId": "3699c4cd-8e61-4cd4-a9fb-4ef8c2b70584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6b76ff8-ef8c-4fc4-8987-6ef56f398ffb", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "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": "23ccf10c-d3e1-4aff-8892-378d80ad9b5b", "Section": { "FormTypeSectionId": "e33716d3-2ec2-42ae-b1f7-dc85402277ed", "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": "6d6dc2b7-637b-460a-91f1-05f46d6a5863", "Name": "sample string 1" }, "Unit": { "UnitId": "3699c4cd-8e61-4cd4-a9fb-4ef8c2b70584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6b76ff8-ef8c-4fc4-8987-6ef56f398ffb", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "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": "bc55d42f-314c-46e9-b2e4-16deee5a1d84", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-19T00:33:33.8188878-07:00", "Location": "sample string 1", "TaskId": "611f5aa6-adee-497c-8e51-1a24c8381759", "Values": [ { "FormFieldValueId": "ba31c0ff-b7e0-4e8b-bc97-6d16a0b89c0f", "FormId": "7fa46d84-8b4c-4efd-b346-4be4eccc3310", "FormTypeField": { "FormTypeFieldId": "23ccf10c-d3e1-4aff-8892-378d80ad9b5b", "FormType": { "FormTypeId": "e64887f3-2e24-4c03-a34c-9a5399f44ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "bc55d42f-314c-46e9-b2e4-16deee5a1d84", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "e33716d3-2ec2-42ae-b1f7-dc85402277ed", "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": "6d6dc2b7-637b-460a-91f1-05f46d6a5863", "Name": "sample string 1" }, "Unit": { "UnitId": "3699c4cd-8e61-4cd4-a9fb-4ef8c2b70584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6b76ff8-ef8c-4fc4-8987-6ef56f398ffb", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "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": "ba31c0ff-b7e0-4e8b-bc97-6d16a0b89c0f", "FormId": "7fa46d84-8b4c-4efd-b346-4be4eccc3310", "FormTypeField": { "FormTypeFieldId": "23ccf10c-d3e1-4aff-8892-378d80ad9b5b", "FormType": { "FormTypeId": "e64887f3-2e24-4c03-a34c-9a5399f44ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb67ab69-9aab-4ce6-8cc0-c18a1a7fa74b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "21d4ee97-17d2-4fa2-ab73-29a6a68cf47c", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-19T00:33:33.8188878-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "bc55d42f-314c-46e9-b2e4-16deee5a1d84", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "e33716d3-2ec2-42ae-b1f7-dc85402277ed", "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": "6d6dc2b7-637b-460a-91f1-05f46d6a5863", "Name": "sample string 1" }, "Unit": { "UnitId": "3699c4cd-8e61-4cd4-a9fb-4ef8c2b70584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e6b76ff8-ef8c-4fc4-8987-6ef56f398ffb", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:33:33.8188878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a7d91a9a-9fac-4b9a-889e-ce2be0fbd6dd", "FieldId": "9e11ef8b-eb3c-4ecd-8d09-1b4da21e78e4", "FieldName": "sample string 1", "FieldLable": "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": "f58f084a-faf7-4192-b650-60db6a3a713b", "CreateDate": "2025-07-19T00:33:33.8188878-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-19T00:33:33.8188878-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" }