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": "ef2448a7-f76f-4d6d-9f8c-0c89cf91d66d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ed6367ea-42f8-45b1-9f65-85036e653cfc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62610b8b-ab4d-4c94-b4e8-2c63cb7ba35c",
"CreateDate": "2026-05-12T17:06:28.820093-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:06:28.820093-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-12T17:06:28.820093-07:00",
"Fields": [
{
"FormTypeFieldId": "39170992-fe56-4836-8e51-f005acd28bc7",
"Section": {
"FormTypeSectionId": "cb3dae14-8ea9-4975-a74f-5310599d0269",
"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": "734cf30a-a787-47b6-bb6b-49e3ab02722f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e44d425d-0fc3-4a22-9ab3-0586667a7300",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49e14b9-8d52-41de-a172-b161dd285aa5",
"CreateDate": "2026-05-12T17:06:28.820093-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:28.820093-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ff9ae3c-1f52-44eb-a8af-f0ca716ed41b",
"FieldId": "2975ef1b-7135-4924-9693-c374a93d2963",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ff9ae3c-1f52-44eb-a8af-f0ca716ed41b",
"FieldId": "2975ef1b-7135-4924-9693-c374a93d2963",
"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": "39170992-fe56-4836-8e51-f005acd28bc7",
"Section": {
"FormTypeSectionId": "cb3dae14-8ea9-4975-a74f-5310599d0269",
"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": "734cf30a-a787-47b6-bb6b-49e3ab02722f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e44d425d-0fc3-4a22-9ab3-0586667a7300",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a49e14b9-8d52-41de-a172-b161dd285aa5",
"CreateDate": "2026-05-12T17:06:28.820093-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:28.820093-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ff9ae3c-1f52-44eb-a8af-f0ca716ed41b",
"FieldId": "2975ef1b-7135-4924-9693-c374a93d2963",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ff9ae3c-1f52-44eb-a8af-f0ca716ed41b",
"FieldId": "2975ef1b-7135-4924-9693-c374a93d2963",
"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": "9be4b051-9ccd-4812-ac72-799f472205ca",
"CreateDate": "2026-05-12T17:06:28.820093-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:06:28.820093-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"
}