DELETE FormTypes
Deletes the given form type, including all forms of that type.
Request Information
URI Parameters
None.
Body Parameters
Form type to delete
FormType| Name | Description | Type | Additional information |
|---|---|---|---|
| FormTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| AssetType | AssetType |
None. |
|
| FrequencyNeeded | integer |
None. |
|
| ValueNeededDate | date |
None. |
|
| Fields | Collection of FormTypeField |
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:
{
"FormTypeId": "6d932664-5276-4fae-bbe3-846f437afb04",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "856e3a9c-2dcd-434f-806e-bbdf0147709e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5f5dc31d-c6db-4ca1-87fa-4dc9cdc2f352",
"CreateDate": "2026-08-24T21:34:47.041696-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:34:47.041696-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-24T21:34:47.041696-07:00",
"Fields": [
{
"FormTypeFieldId": "ee641519-ef19-4036-85d9-a8b7f065b513",
"Section": {
"FormTypeSectionId": "e511434c-36a4-49f0-9f0a-f79e88da9a88",
"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": "d2ef8fe4-f687-4895-bc0a-b49d76992f61",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2acdce75-0b80-45f9-95db-76f2d567af11",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b44b6ce-488f-4545-9632-fd9cc81a829b",
"CreateDate": "2026-08-24T21:34:47.041696-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:47.041696-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "256847b6-1997-48fe-8fe8-61a86073dd9c",
"FieldId": "9f360751-d481-44f8-8f0f-3328a5670690",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "256847b6-1997-48fe-8fe8-61a86073dd9c",
"FieldId": "9f360751-d481-44f8-8f0f-3328a5670690",
"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": "ee641519-ef19-4036-85d9-a8b7f065b513",
"Section": {
"FormTypeSectionId": "e511434c-36a4-49f0-9f0a-f79e88da9a88",
"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": "d2ef8fe4-f687-4895-bc0a-b49d76992f61",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2acdce75-0b80-45f9-95db-76f2d567af11",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b44b6ce-488f-4545-9632-fd9cc81a829b",
"CreateDate": "2026-08-24T21:34:47.041696-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:47.041696-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "256847b6-1997-48fe-8fe8-61a86073dd9c",
"FieldId": "9f360751-d481-44f8-8f0f-3328a5670690",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "256847b6-1997-48fe-8fe8-61a86073dd9c",
"FieldId": "9f360751-d481-44f8-8f0f-3328a5670690",
"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": "c0088030-6f84-4d14-a17f-0c3469c00853",
"CreateDate": "2026-08-24T21:34:47.041696-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:34:47.041696-07:00",
"LastModifiedUser": "sample string 6"
}
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"
}