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": "2cbe5228-23a1-4741-a51f-ee1bb183e442",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ad5ee66d-73d8-47ce-b3e1-e8eb3d2c11ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42e87a9b-7919-44de-b866-6da481669d1c",
"CreateDate": "2026-08-26T20:10:48.6610354-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-26T20:10:48.6610354-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-26T20:10:48.6610354-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "efbc6c19-e0eb-4030-bad8-35124105c74e",
"Section": {
"FormTypeSectionId": "1dfead5d-a635-48c1-8182-91b0b857a5f8",
"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": "7572f628-ee06-4c81-b599-95a41f45b68c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7294f1d1-d5fa-454a-9c4c-51c62995c209",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "545dabb0-8698-40b2-b094-ef423e02c676",
"CreateDate": "2026-08-26T20:10:48.6610354-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T20:10:48.6610354-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c6652187-d23b-4380-a764-4d0a6ed7bbc0",
"FieldId": "857a7446-7ab7-417a-b29d-55619446e61e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c6652187-d23b-4380-a764-4d0a6ed7bbc0",
"FieldId": "857a7446-7ab7-417a-b29d-55619446e61e",
"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": "efbc6c19-e0eb-4030-bad8-35124105c74e",
"Section": {
"FormTypeSectionId": "1dfead5d-a635-48c1-8182-91b0b857a5f8",
"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": "7572f628-ee06-4c81-b599-95a41f45b68c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7294f1d1-d5fa-454a-9c4c-51c62995c209",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "545dabb0-8698-40b2-b094-ef423e02c676",
"CreateDate": "2026-08-26T20:10:48.6610354-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-26T20:10:48.6610354-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c6652187-d23b-4380-a764-4d0a6ed7bbc0",
"FieldId": "857a7446-7ab7-417a-b29d-55619446e61e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c6652187-d23b-4380-a764-4d0a6ed7bbc0",
"FieldId": "857a7446-7ab7-417a-b29d-55619446e61e",
"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": "1361d955-7a5b-49e9-bd37-6e98f929c005",
"CreateDate": "2026-08-26T20:10:48.6610354-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-26T20:10:48.6610354-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"
}