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. |
|
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": "ad30116d-c589-4ccf-8d81-90f77dbcb4f3", "Asset": { "AssetId": "541053b0-7f0c-490f-84a2-8f33bec8a3d2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "844342db-3c95-4d69-8fc5-2ae393b14a6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff68ac50-7edb-4476-9162-7a597c27e978", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0dcf15ed-3703-4072-9eb9-8f9c8a4e7acc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T04:58:19.7393057-07:00", "MeasurementValueNeededDate": "2024-03-29T04:58:19.7393057-07:00", "SourceSystemId": "sample string 3", "CompanyId": "83906f9c-d6af-4a8a-973f-60f7eb46badd", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fdf97afe-df54-4445-bdf4-48def050ee96", "EffectiveDate": "2024-03-29T04:58:19.7393057-07:00", "StateType": { "StateTypeId": "b104f042-4096-4dc2-b096-94c4e9e26067", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "844342db-3c95-4d69-8fc5-2ae393b14a6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff68ac50-7edb-4476-9162-7a597c27e978", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "2026cc91-9be6-4b33-9317-f612241c5e92", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "899d004f-b117-4b19-833c-d07b7c667506", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "811c9cb1-2692-4c2f-9c10-14b6d49d69bd", "EffectiveDate": "2024-03-29T04:58:19.7393057-07:00", "StatusType": { "StatusTypeId": "4041c3e4-ad99-4ac4-8b18-bc3e65d0b5fe", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "844342db-3c95-4d69-8fc5-2ae393b14a6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff68ac50-7edb-4476-9162-7a597c27e978", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "eb266a3c-4db1-40e3-8c2f-5aa659e37738", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ae907ec0-dae2-4874-b098-3f8bce402c53", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b53331b1-75f9-42fa-b42f-9a5b7077cfe4", "EffectiveDate": "2024-03-29T04:58:19.7393057-07:00", "WellPurposeType": { "WellPurposeTypeId": "9af3429b-768f-4b33-9a98-25871b0a520a", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d6d844ef-3d9c-49b6-b999-d46b28b53b75", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c962ebea-39d3-436f-8e88-65f7bcceed1f", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-03-29T04:58:19.7393057-07:00", "MeasurementValueNeededDate": "2024-03-29T04:58:19.7393057-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4690a156-95fe-40cd-91bb-9a513a98c7b4", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "d39a02f0-9c6d-4b02-8e17-7dead688108d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "844342db-3c95-4d69-8fc5-2ae393b14a6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff68ac50-7edb-4476-9162-7a597c27e978", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T04:58:19.7393057-07:00", "Fields": [ { "FormTypeFieldId": "57756ec5-8bf6-4f01-aafb-b7b689da8543", "Section": { "FormTypeSectionId": "8df6cd16-7bb3-4c0e-bbce-7892298332f4", "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": "8c32a50f-da80-423a-baea-aa86bf365a80", "Name": "sample string 1" }, "Unit": { "UnitId": "17cae921-c6ab-41c2-ba4d-1b6b52a52942", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c4ed423-33ea-46c2-bdba-7373077a1b4a", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "57756ec5-8bf6-4f01-aafb-b7b689da8543", "Section": { "FormTypeSectionId": "8df6cd16-7bb3-4c0e-bbce-7892298332f4", "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": "8c32a50f-da80-423a-baea-aa86bf365a80", "Name": "sample string 1" }, "Unit": { "UnitId": "17cae921-c6ab-41c2-ba4d-1b6b52a52942", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c4ed423-33ea-46c2-bdba-7373077a1b4a", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "d63ff286-d71c-4e5a-9ca2-fcb5d9adf9a6", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-03-29T04:58:19.7393057-07:00", "Location": "sample string 1", "Values": [ { "FormFieldValueId": "4187b91d-f4f7-46ae-b983-4be1428d94ad", "FormTypeField": { "FormTypeFieldId": "57756ec5-8bf6-4f01-aafb-b7b689da8543", "Section": { "FormTypeSectionId": "8df6cd16-7bb3-4c0e-bbce-7892298332f4", "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": "8c32a50f-da80-423a-baea-aa86bf365a80", "Name": "sample string 1" }, "Unit": { "UnitId": "17cae921-c6ab-41c2-ba4d-1b6b52a52942", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c4ed423-33ea-46c2-bdba-7373077a1b4a", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "4187b91d-f4f7-46ae-b983-4be1428d94ad", "FormTypeField": { "FormTypeFieldId": "57756ec5-8bf6-4f01-aafb-b7b689da8543", "Section": { "FormTypeSectionId": "8df6cd16-7bb3-4c0e-bbce-7892298332f4", "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": "8c32a50f-da80-423a-baea-aa86bf365a80", "Name": "sample string 1" }, "Unit": { "UnitId": "17cae921-c6ab-41c2-ba4d-1b6b52a52942", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c4ed423-33ea-46c2-bdba-7373077a1b4a", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:58:19.7393057-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "32756d08-5cc3-41ff-842e-037e5e66d606", "CreateDate": "2024-03-29T04:58:19.7393057-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T04:58:19.7393057-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" }