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": "27f2a7ee-53b6-47e7-b7b1-3a4da06aceb1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5d04944c-04c5-4e6c-9283-34a86112cf86",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "937a72be-42b7-4edc-8872-e0ea79412c71",
"CreateDate": "2026-03-15T17:59:27.1661012-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:59:27.1661012-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-15T17:59:27.1661012-07:00",
"Fields": [
{
"FormTypeFieldId": "69be70b5-58df-4d97-a9db-e9b66cc3ab10",
"Section": {
"FormTypeSectionId": "ab2e2c5b-7559-46eb-abb4-40f18dbf5a58",
"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": "24eed43d-d4ab-43b7-8329-faefe6e06201",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1ce1fa6e-176b-4fdf-83d8-69df92018b4b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "95a171dc-999b-431a-b16b-bdc5623bdea1",
"CreateDate": "2026-03-15T17:59:27.1661012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:27.1661012-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "86f94c63-91fe-49d3-b473-2f52f7c21eaf",
"FieldId": "e93fec80-eb74-4ad0-95e7-7e9da06518ca",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "86f94c63-91fe-49d3-b473-2f52f7c21eaf",
"FieldId": "e93fec80-eb74-4ad0-95e7-7e9da06518ca",
"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": "69be70b5-58df-4d97-a9db-e9b66cc3ab10",
"Section": {
"FormTypeSectionId": "ab2e2c5b-7559-46eb-abb4-40f18dbf5a58",
"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": "24eed43d-d4ab-43b7-8329-faefe6e06201",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1ce1fa6e-176b-4fdf-83d8-69df92018b4b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "95a171dc-999b-431a-b16b-bdc5623bdea1",
"CreateDate": "2026-03-15T17:59:27.1661012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:27.1661012-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "86f94c63-91fe-49d3-b473-2f52f7c21eaf",
"FieldId": "e93fec80-eb74-4ad0-95e7-7e9da06518ca",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "86f94c63-91fe-49d3-b473-2f52f7c21eaf",
"FieldId": "e93fec80-eb74-4ad0-95e7-7e9da06518ca",
"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": "f9017136-c166-4db1-b0d2-d0fef127db40",
"CreateDate": "2026-03-15T17:59:27.1661012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:27.1661012-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"
}