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": "c6ff436f-0737-4233-9c0c-16649690d661", "Asset": { "AssetId": "cb6c293e-ae24-4a13-8177-c561da33026b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "96d9ebb7-9842-4dfa-a179-8bb7beffcdeb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "MeasurementValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "SourceSystemId": "sample string 3", "CompanyId": "4196c1df-21df-49c9-a023-d9a81f3d699d", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "438aacdd-5650-4569-9624-cecb11979825", "EffectiveDate": "2025-06-02T15:05:00.3661162-07:00", "StateType": { "StateTypeId": "bbf71c39-638b-4a65-947b-ad84ef4209fe", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "b87b4497-7aa3-4356-900d-a9f8a852a5e9", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "11ad03c0-6053-43a3-8936-c2d2bdabf54e", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c276f4fd-1a53-41db-a677-201719728bf6", "EffectiveDate": "2025-06-02T15:05:00.3661162-07:00", "StatusType": { "StatusTypeId": "11ef1e86-d1d0-4425-91af-236a551e2188", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "a7c8cc86-1d28-4f2f-8428-1899e2add0d5", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1815efe5-ecb9-40db-82f9-905be75af606", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "4480c677-64f4-42ba-88cc-121ca10f933c", "EffectiveDate": "2025-06-02T15:05:00.3661162-07:00", "WellPurposeType": { "WellPurposeTypeId": "6cd96b58-c452-4585-8d52-b519c945246c", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e77537c1-7f01-4547-9993-bf23952fa438", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "559c22ba-731f-414f-a644-1bcaf2a871a5", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "MeasurementValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9a0266be-6b00-459b-9dcb-d246fe873461", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "5b1c2733-4aec-45df-be15-c870fe31650c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "Fields": [ { "FormTypeFieldId": "c12f7add-b0fe-4ce6-89ab-7320c2d0c792", "Section": { "FormTypeSectionId": "cba51b69-3ca5-4d9a-a352-db1e21118373", "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": "620bf3cb-4149-4e89-a6d9-1bd88c1447f9", "Name": "sample string 1" }, "Unit": { "UnitId": "b2231453-a249-492a-a34d-39c967e22dfc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb9e8d0b-7e05-4708-90b5-c5b060bdedfd", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "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": "c12f7add-b0fe-4ce6-89ab-7320c2d0c792", "Section": { "FormTypeSectionId": "cba51b69-3ca5-4d9a-a352-db1e21118373", "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": "620bf3cb-4149-4e89-a6d9-1bd88c1447f9", "Name": "sample string 1" }, "Unit": { "UnitId": "b2231453-a249-492a-a34d-39c967e22dfc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb9e8d0b-7e05-4708-90b5-c5b060bdedfd", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "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": "73f681c4-c7f8-4615-ae01-5145013179ba", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-02T15:05:00.3661162-07:00", "Location": "sample string 1", "TaskId": "09a6fcef-9cc6-4511-ad92-86ad8f7b6a9c", "Values": [ { "FormFieldValueId": "e5bc9959-b808-43a7-8a0b-ecd9ab785869", "FormId": "5c21d280-39df-4d4f-aea4-43b193e97654", "FormTypeField": { "FormTypeFieldId": "c12f7add-b0fe-4ce6-89ab-7320c2d0c792", "FormType": { "FormTypeId": "5b1c2733-4aec-45df-be15-c870fe31650c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "73f681c4-c7f8-4615-ae01-5145013179ba", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "cba51b69-3ca5-4d9a-a352-db1e21118373", "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": "620bf3cb-4149-4e89-a6d9-1bd88c1447f9", "Name": "sample string 1" }, "Unit": { "UnitId": "b2231453-a249-492a-a34d-39c967e22dfc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb9e8d0b-7e05-4708-90b5-c5b060bdedfd", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "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": "e5bc9959-b808-43a7-8a0b-ecd9ab785869", "FormId": "5c21d280-39df-4d4f-aea4-43b193e97654", "FormTypeField": { "FormTypeFieldId": "c12f7add-b0fe-4ce6-89ab-7320c2d0c792", "FormType": { "FormTypeId": "5b1c2733-4aec-45df-be15-c870fe31650c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "eaa0d1a7-745d-4aab-a055-6fcdc5cd1a9f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "29498463-9cf7-4783-b5fa-9da2beaf7a27", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T15:05:00.3661162-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "73f681c4-c7f8-4615-ae01-5145013179ba", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "cba51b69-3ca5-4d9a-a352-db1e21118373", "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": "620bf3cb-4149-4e89-a6d9-1bd88c1447f9", "Name": "sample string 1" }, "Unit": { "UnitId": "b2231453-a249-492a-a34d-39c967e22dfc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb9e8d0b-7e05-4708-90b5-c5b060bdedfd", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:05:00.3661162-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6fd0ccf-d224-4630-8f35-01417494d713", "FieldId": "6f139edd-164d-4b86-8714-ca5c8aedcff5", "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": "d8c1834a-5f2d-4fa4-abd7-fc4f9d58605a", "CreateDate": "2025-06-02T15:05:00.3661162-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T15:05:00.3661162-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" }