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": "82be4e35-8034-4db4-a90b-2c04cb66b4de", "Asset": { "AssetId": "2eaea5a5-64a5-4a2f-8284-ddeacc019758", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e30ef2a7-6cbc-4de9-9d59-886e90f11b95", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "MeasurementValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "SourceSystemId": "sample string 3", "CompanyId": "76ecb6e2-112a-4adb-b475-1ed42a535d15", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "054c99ed-9ea9-4d62-a0f8-8c14e5a26df3", "EffectiveDate": "2025-05-09T15:42:34.6230563-07:00", "StateType": { "StateTypeId": "ba659888-c659-4386-917c-2df9606d29c7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "3df648e7-f5cc-4eef-b4d0-16fbaa73ea01", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "fb1e6df4-2696-48e2-873e-6a2455c938e1", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "6ce31564-1f8b-4f8f-be8f-ec5ae8cb93f0", "EffectiveDate": "2025-05-09T15:42:34.6230563-07:00", "StatusType": { "StatusTypeId": "af9e9b98-9b3c-494b-b945-218ab2af0de3", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "448fb68b-2b72-4ccb-b830-5e1d2cdbd14e", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "29629df6-8bfb-42c8-a720-0c2ab702511e", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "ecbc5d74-b518-4100-8746-9ae4fb1d228a", "EffectiveDate": "2025-05-09T15:42:34.6230563-07:00", "WellPurposeType": { "WellPurposeTypeId": "0e97477d-8f60-4413-a739-5122a2607612", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "de598153-0d2a-4a68-8446-bbfc32f02181", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "55ba34b9-7173-4d8b-a87a-e99590eb419d", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "MeasurementValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a1c259b1-ebcc-43fc-9e3d-bd2dd9aa5351", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "27610336-ef75-4341-8755-70d6a0bcbfae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "Fields": [ { "FormTypeFieldId": "ac2424bd-9bbc-4f81-875a-29c597315414", "Section": { "FormTypeSectionId": "c1f4801a-039a-4b09-ace3-19d5c2565027", "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": "e4c07dfa-77a8-4587-a7d1-aa47905d4dae", "Name": "sample string 1" }, "Unit": { "UnitId": "a407dae3-fdc6-4de2-b7a0-1e17852a0b48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f1663245-c963-43bd-905a-81a482b89e37", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "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": "ac2424bd-9bbc-4f81-875a-29c597315414", "Section": { "FormTypeSectionId": "c1f4801a-039a-4b09-ace3-19d5c2565027", "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": "e4c07dfa-77a8-4587-a7d1-aa47905d4dae", "Name": "sample string 1" }, "Unit": { "UnitId": "a407dae3-fdc6-4de2-b7a0-1e17852a0b48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f1663245-c963-43bd-905a-81a482b89e37", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "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": "f860e593-e5cb-4efb-9ea8-467ec0e81691", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T15:42:34.6230563-07:00", "Location": "sample string 1", "TaskId": "077080d1-0b8d-4f1f-a186-a7c7ce85f0d8", "Values": [ { "FormFieldValueId": "ee1ba2f6-a920-40d0-8767-03c25652bf53", "FormId": "922d0b43-04b7-4f2c-8b96-1003ac44939a", "FormTypeField": { "FormTypeFieldId": "ac2424bd-9bbc-4f81-875a-29c597315414", "FormType": { "FormTypeId": "27610336-ef75-4341-8755-70d6a0bcbfae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "f860e593-e5cb-4efb-9ea8-467ec0e81691", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "c1f4801a-039a-4b09-ace3-19d5c2565027", "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": "e4c07dfa-77a8-4587-a7d1-aa47905d4dae", "Name": "sample string 1" }, "Unit": { "UnitId": "a407dae3-fdc6-4de2-b7a0-1e17852a0b48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f1663245-c963-43bd-905a-81a482b89e37", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "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": "ee1ba2f6-a920-40d0-8767-03c25652bf53", "FormId": "922d0b43-04b7-4f2c-8b96-1003ac44939a", "FormTypeField": { "FormTypeFieldId": "ac2424bd-9bbc-4f81-875a-29c597315414", "FormType": { "FormTypeId": "27610336-ef75-4341-8755-70d6a0bcbfae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "50f13b70-0e0a-419c-8ee9-372130a398c3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "248e937c-8101-4ad8-a607-600d675e39fd", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T15:42:34.6230563-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "f860e593-e5cb-4efb-9ea8-467ec0e81691", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "c1f4801a-039a-4b09-ace3-19d5c2565027", "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": "e4c07dfa-77a8-4587-a7d1-aa47905d4dae", "Name": "sample string 1" }, "Unit": { "UnitId": "a407dae3-fdc6-4de2-b7a0-1e17852a0b48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f1663245-c963-43bd-905a-81a482b89e37", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T15:42:34.6230563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3ca314bd-16ce-413c-950a-3fa761df04b3", "FieldId": "c132c903-8f5c-4640-8f66-165c0a65c452", "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": "a6c0b8e6-f416-4561-9523-26a1c136cae4", "CreateDate": "2025-05-09T15:42:34.6230563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T15:42:34.6230563-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" }