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": "02c79ee2-0505-43ba-94a7-31b44da5453a", "Asset": { "AssetId": "8d9eb382-c20a-4796-8e62-43dc876ff172", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "df34972c-1145-479c-9c57-d7ce446f7a53", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "MeasurementValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1f6e6b42-6145-416c-bbbd-3cf0676ef7fb", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "581fa86c-942a-4471-8566-d2387c20dc9c", "EffectiveDate": "2025-07-30T23:22:18.6127189-07:00", "StateType": { "StateTypeId": "d7079e2f-eac7-4e9b-8496-8d050b781dff", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a01b848a-f176-4e97-9e2e-c7d1707175ac", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "fb4d552c-b58b-482f-b87e-3efe7a4f8dd2", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "31872d2e-074b-4771-9909-053f2645dd3e", "EffectiveDate": "2025-07-30T23:22:18.6127189-07:00", "StatusType": { "StatusTypeId": "62646729-c95b-41c5-9219-6304cf49701c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "fb5de166-d4ba-4b67-9f51-3a1ef0f1146a", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7cc613b7-d55e-429f-af08-8df89d366e5e", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c5f0d4ea-cf71-4efd-8795-c1602745408b", "EffectiveDate": "2025-07-30T23:22:18.6127189-07:00", "WellPurposeType": { "WellPurposeTypeId": "d0f98ba7-902f-4421-9656-d770411dd944", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b15f1957-d587-41a4-9eca-23536cc4d262", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a68936a7-0101-4c19-a1a9-73a3457f6812", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "MeasurementValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "6595235b-402f-4b9a-888b-5ee07ef2f038", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "5bdaebf4-0df7-4de9-b5b8-2cdfcc43eeae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "Fields": [ { "FormTypeFieldId": "4315055d-ac44-421d-9dd0-ebe68a141338", "Section": { "FormTypeSectionId": "432d95f4-1eec-4ea1-8a38-809c9e3788c9", "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": "8ffd4861-b496-4267-b792-dd2b83de4fb4", "Name": "sample string 1" }, "Unit": { "UnitId": "53785ed8-70d2-47c5-a784-673ea3dc8584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c1358072-ef5c-4f60-b1db-210d9da17ed1", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "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": "4315055d-ac44-421d-9dd0-ebe68a141338", "Section": { "FormTypeSectionId": "432d95f4-1eec-4ea1-8a38-809c9e3788c9", "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": "8ffd4861-b496-4267-b792-dd2b83de4fb4", "Name": "sample string 1" }, "Unit": { "UnitId": "53785ed8-70d2-47c5-a784-673ea3dc8584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c1358072-ef5c-4f60-b1db-210d9da17ed1", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "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": "638073ed-1851-44e7-80bd-7c4bcce17325", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-30T23:22:18.6127189-07:00", "Location": "sample string 1", "TaskId": "c1d81e74-0c7a-4780-a434-8789493a658a", "Values": [ { "FormFieldValueId": "0bcc6e13-d76a-41c8-bcc0-d5f5d841880c", "FormId": "14aaed92-d7b6-4ea3-ad6c-9a5642c01d0e", "FormTypeField": { "FormTypeFieldId": "4315055d-ac44-421d-9dd0-ebe68a141338", "FormType": { "FormTypeId": "5bdaebf4-0df7-4de9-b5b8-2cdfcc43eeae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "638073ed-1851-44e7-80bd-7c4bcce17325", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "432d95f4-1eec-4ea1-8a38-809c9e3788c9", "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": "8ffd4861-b496-4267-b792-dd2b83de4fb4", "Name": "sample string 1" }, "Unit": { "UnitId": "53785ed8-70d2-47c5-a784-673ea3dc8584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c1358072-ef5c-4f60-b1db-210d9da17ed1", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "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": "0bcc6e13-d76a-41c8-bcc0-d5f5d841880c", "FormId": "14aaed92-d7b6-4ea3-ad6c-9a5642c01d0e", "FormTypeField": { "FormTypeFieldId": "4315055d-ac44-421d-9dd0-ebe68a141338", "FormType": { "FormTypeId": "5bdaebf4-0df7-4de9-b5b8-2cdfcc43eeae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d6a205ee-277f-43dc-ad08-b57ccdb1849b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b9442233-2f47-412a-9012-b94f158c1eef", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T23:22:18.6127189-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "638073ed-1851-44e7-80bd-7c4bcce17325", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "432d95f4-1eec-4ea1-8a38-809c9e3788c9", "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": "8ffd4861-b496-4267-b792-dd2b83de4fb4", "Name": "sample string 1" }, "Unit": { "UnitId": "53785ed8-70d2-47c5-a784-673ea3dc8584", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c1358072-ef5c-4f60-b1db-210d9da17ed1", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:22:18.6127189-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e04544e3-d093-4339-bbe7-e90bd98ba638", "FieldId": "22ab0b95-6e9a-4a2b-8d2e-be372cb5e425", "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": "66b86499-93c2-42ec-ab8f-d548c11902a7", "CreateDate": "2025-07-30T23:22:18.6127189-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:22:18.6127189-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" }