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. |
|
| Active | boolean |
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": "b6d8b948-f462-4939-8d3e-8fbb53189bcf",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "20aa0626-ee4b-4a3e-8c20-4125426be450",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6616c9b2-fc87-4041-9599-4eb61ad7ec37",
"CreateDate": "2026-07-18T09:22:10.9387657-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-18T09:22:10.9387657-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-18T09:22:10.9387657-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "9d6bb3f0-477d-42e1-bb28-ffa05daf5d68",
"Section": {
"FormTypeSectionId": "9e075c9b-dc76-49d0-9e6f-b4d34888c23a",
"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": "b4690031-baab-42ce-a195-1aba40bad6d3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f68d754a-cb3a-4dc1-a8c3-c9aac95e8134",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fabef9ea-fecc-47c6-a5c1-5ec8327caf4d",
"CreateDate": "2026-07-18T09:22:10.9387657-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T09:22:10.9387657-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "72adc94c-67cf-4ea4-87f4-e30ccc13a7b4",
"FieldId": "beffbacb-4c49-467d-95f2-5891848939ed",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "72adc94c-67cf-4ea4-87f4-e30ccc13a7b4",
"FieldId": "beffbacb-4c49-467d-95f2-5891848939ed",
"FieldName": "sample string 1",
"FieldLabel": "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": "9d6bb3f0-477d-42e1-bb28-ffa05daf5d68",
"Section": {
"FormTypeSectionId": "9e075c9b-dc76-49d0-9e6f-b4d34888c23a",
"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": "b4690031-baab-42ce-a195-1aba40bad6d3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f68d754a-cb3a-4dc1-a8c3-c9aac95e8134",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fabef9ea-fecc-47c6-a5c1-5ec8327caf4d",
"CreateDate": "2026-07-18T09:22:10.9387657-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-18T09:22:10.9387657-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "72adc94c-67cf-4ea4-87f4-e30ccc13a7b4",
"FieldId": "beffbacb-4c49-467d-95f2-5891848939ed",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "72adc94c-67cf-4ea4-87f4-e30ccc13a7b4",
"FieldId": "beffbacb-4c49-467d-95f2-5891848939ed",
"FieldName": "sample string 1",
"FieldLabel": "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 4",
"CompanyId": "c548991d-1de7-49e3-814a-9630b8ebdec8",
"CreateDate": "2026-07-18T09:22:10.9387657-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-18T09:22:10.9387657-07:00",
"LastModifiedUser": "sample string 7"
}
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"
}