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": "8261d9a5-6ae2-41d6-b140-864ee725753f", "Asset": { "AssetId": "b2b5bfd9-6011-47b6-aa1b-c75dbc20cd97", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "bb2d61ed-2b8e-4279-a957-79a4e9b8fabd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a7e5831e-8449-4320-b69f-d4021aee6f51", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "ce5021be-18f4-42e9-974c-5f3ea838d5f6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T04:29:41.7793831-07:00", "MeasurementValueNeededDate": "2024-04-28T04:29:41.7793831-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d1eca3cc-b8cd-4c02-886b-1af7b8863f6d", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "e34785d2-7a85-411f-bd26-84af6ca5ae66", "EffectiveDate": "2024-04-28T04:29:41.7793831-07:00", "StateType": { "StateTypeId": "ca3604c9-f4a1-49d0-9783-d1ac5e62a6a3", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "bb2d61ed-2b8e-4279-a957-79a4e9b8fabd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a7e5831e-8449-4320-b69f-d4021aee6f51", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "22bbf7c3-aa1b-46f4-81f4-a266fee0a2e2", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "adae8e83-be9c-4533-a034-0395a785c0a2", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5e2dee15-488e-4483-a30c-7d516e435b7c", "EffectiveDate": "2024-04-28T04:29:41.7793831-07:00", "StatusType": { "StatusTypeId": "ca2e770c-cf07-4f87-b672-6cd8fc6314ce", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "bb2d61ed-2b8e-4279-a957-79a4e9b8fabd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a7e5831e-8449-4320-b69f-d4021aee6f51", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "961341c3-588f-4502-9dbc-b215c2364641", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0d4bb5cb-3f78-47e2-89b5-aa3a22bcd2a9", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "20d72caf-f86f-4c16-ac17-f323cc59acb3", "EffectiveDate": "2024-04-28T04:29:41.7793831-07:00", "WellPurposeType": { "WellPurposeTypeId": "16751489-b98c-42e0-a72a-b22a2b3b3003", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4be28423-6375-4e86-a295-6770d14b010f", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "83ecd7a2-e8d4-497f-994d-57a9d6e3f9ec", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T04:29:41.7793831-07:00", "MeasurementValueNeededDate": "2024-04-28T04:29:41.7793831-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a8ccab25-7bc1-4f20-b21c-7181aad383a7", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "2e02abf4-c42f-4768-a56a-809139fe30b2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bb2d61ed-2b8e-4279-a957-79a4e9b8fabd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a7e5831e-8449-4320-b69f-d4021aee6f51", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T04:29:41.7793831-07:00", "Fields": [ { "FormTypeFieldId": "8e50effe-950b-4ccd-9c54-0427f140e9bf", "Section": { "FormTypeSectionId": "264c9aa4-3685-4ee1-b05b-971f288d6d11", "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": "44649d59-eac1-4370-97f2-abb700c22417", "Name": "sample string 1" }, "Unit": { "UnitId": "42e034e2-a836-4536-a954-dba009569ce7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b69a431e-26ce-4fac-931d-b3fabe5792a4", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-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": "8e50effe-950b-4ccd-9c54-0427f140e9bf", "Section": { "FormTypeSectionId": "264c9aa4-3685-4ee1-b05b-971f288d6d11", "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": "44649d59-eac1-4370-97f2-abb700c22417", "Name": "sample string 1" }, "Unit": { "UnitId": "42e034e2-a836-4536-a954-dba009569ce7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b69a431e-26ce-4fac-931d-b3fabe5792a4", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-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": "ec5d71c8-da5d-4f88-8072-fa9b579bc970", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-28T04:29:41.7793831-07:00", "Location": "sample string 1", "Values": [ { "FormFieldValueId": "2eb2b9c3-0e4f-4868-b2db-9e459a89d4bb", "FormTypeField": { "FormTypeFieldId": "8e50effe-950b-4ccd-9c54-0427f140e9bf", "Section": { "FormTypeSectionId": "264c9aa4-3685-4ee1-b05b-971f288d6d11", "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": "44649d59-eac1-4370-97f2-abb700c22417", "Name": "sample string 1" }, "Unit": { "UnitId": "42e034e2-a836-4536-a954-dba009569ce7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b69a431e-26ce-4fac-931d-b3fabe5792a4", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-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": "2eb2b9c3-0e4f-4868-b2db-9e459a89d4bb", "FormTypeField": { "FormTypeFieldId": "8e50effe-950b-4ccd-9c54-0427f140e9bf", "Section": { "FormTypeSectionId": "264c9aa4-3685-4ee1-b05b-971f288d6d11", "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": "44649d59-eac1-4370-97f2-abb700c22417", "Name": "sample string 1" }, "Unit": { "UnitId": "42e034e2-a836-4536-a954-dba009569ce7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b69a431e-26ce-4fac-931d-b3fabe5792a4", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:41.7793831-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": "9931adbf-d603-4a2e-89a5-567f3eac3160", "CreateDate": "2024-04-28T04:29:41.7793831-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T04:29:41.7793831-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" }