DELETE Forms
Deletes the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to delete.
Form| Name | 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": "4610da70-233e-40ce-8bc7-429b5fb43f1f",
"Asset": {
"AssetId": "a2d24d1f-55a7-42e6-9cb9-ab63f2766e13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "846ce0d2-e5cd-4288-ace5-3e2a93f36e3e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8a2556c3-98e0-4958-ba37-84a27f0c8179",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "06f23842-fe75-4b54-91e5-23de9d635c10",
"EffectiveDate": "2025-11-04T16:39:38.121798-08:00",
"StateType": {
"StateTypeId": "ec319173-7b21-4a07-9024-9eef919bf601",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e792c6f7-1dff-4f96-8da4-739c146215e1",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d1c195cb-564a-4882-9338-c99836d2dc1f",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fd232f1e-e882-446d-b6c1-7eeb7fac24d4",
"EffectiveDate": "2025-11-04T16:39:38.121798-08:00",
"StatusType": {
"StatusTypeId": "6ce445ae-38d5-4233-9497-9aa40905ac39",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "17f4a651-0566-4cd7-ac06-9e335eef25e0",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c256e31b-e548-46a6-b36e-8fd838e95aff",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1e33809e-2fa0-4ed6-834c-d9dadae1888c",
"EffectiveDate": "2025-11-04T16:39:38.121798-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "db0260c2-a141-4871-81fd-8ea10f05f573",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "67136c36-866d-4fa3-a235-df1ca346594f",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b31bd02a-672f-43c4-88bf-a70f2decb345",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"MeasurementValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4e10db6c-b8f8-4ce5-9993-b1bb9d97e638",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "fa5f4197-979c-4aad-84bd-37fbdb2a13b3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"Fields": [
{
"FormTypeFieldId": "75d90694-e686-4891-b2e9-b665ef28ab9c",
"Section": {
"FormTypeSectionId": "65d3e64e-3969-488f-9ab5-ad6508536b68",
"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": "882e74d1-c14c-43f9-91c8-31775e41189c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6bcf3f6e-f9e0-4d06-9a91-4a2d0a1d6a93",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96d41425-d383-43cc-8103-a3b45a4c0366",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"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": "75d90694-e686-4891-b2e9-b665ef28ab9c",
"Section": {
"FormTypeSectionId": "65d3e64e-3969-488f-9ab5-ad6508536b68",
"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": "882e74d1-c14c-43f9-91c8-31775e41189c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6bcf3f6e-f9e0-4d06-9a91-4a2d0a1d6a93",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96d41425-d383-43cc-8103-a3b45a4c0366",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"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": "feeff741-8777-4a74-8281-491fa0f5852a",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-04T16:39:38.121798-08:00",
"Location": "sample string 1",
"TaskId": "5e0293f7-4c43-4657-9589-cd4360ab98d6",
"Values": [
{
"FormFieldValueId": "d1e58c42-416b-473b-8ef9-60d6c62b22dc",
"FormId": "08f6aa62-87f2-4281-a7e0-66e675c1250f",
"FormTypeField": {
"FormTypeFieldId": "75d90694-e686-4891-b2e9-b665ef28ab9c",
"FormType": {
"FormTypeId": "fa5f4197-979c-4aad-84bd-37fbdb2a13b3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "feeff741-8777-4a74-8281-491fa0f5852a",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "65d3e64e-3969-488f-9ab5-ad6508536b68",
"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": "882e74d1-c14c-43f9-91c8-31775e41189c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6bcf3f6e-f9e0-4d06-9a91-4a2d0a1d6a93",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96d41425-d383-43cc-8103-a3b45a4c0366",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"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": "d1e58c42-416b-473b-8ef9-60d6c62b22dc",
"FormId": "08f6aa62-87f2-4281-a7e0-66e675c1250f",
"FormTypeField": {
"FormTypeFieldId": "75d90694-e686-4891-b2e9-b665ef28ab9c",
"FormType": {
"FormTypeId": "fa5f4197-979c-4aad-84bd-37fbdb2a13b3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1a8d93c3-5de5-4939-9584-dcfabc0c1c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1cf8858-b998-4a4b-b0c1-9d0d6edce72c",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-04T16:39:38.121798-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "feeff741-8777-4a74-8281-491fa0f5852a",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "65d3e64e-3969-488f-9ab5-ad6508536b68",
"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": "882e74d1-c14c-43f9-91c8-31775e41189c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6bcf3f6e-f9e0-4d06-9a91-4a2d0a1d6a93",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96d41425-d383-43cc-8103-a3b45a4c0366",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e68051f6-06cd-4221-aaf1-b11c63884575",
"FieldId": "9c469363-80c7-4b14-8e73-89d19638fab3",
"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": "761ab32b-5b5a-49c0-b4d3-e71143bb7ffa",
"CreateDate": "2025-11-04T16:39:38.121798-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-04T16:39:38.121798-08: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"
}