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": "76216b36-591d-4fc9-aab0-17929a069e09",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "094e2355-d112-4e4b-95de-adbc8bb55e54",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ce4e402-a233-49a3-b9dd-e7dbbb3c78c4",
"CreateDate": "2026-02-07T13:14:14.8359605-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-07T13:14:14.8359605-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-07T13:14:14.8359605-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8d94343f-881e-435f-8917-1665169393ea",
"Section": {
"FormTypeSectionId": "ba467021-5a2e-4c3a-95f8-60a697af4b57",
"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": "786b236b-198e-4d85-a676-2fcb8dd60979",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "96f4d609-c3fc-434e-a440-1c73cb5c2001",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "95045bd2-bec7-4df0-b029-b646e616eb16",
"CreateDate": "2026-02-07T13:14:14.8359605-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-07T13:14:14.8359605-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e09f2c18-6853-4d28-ba9d-72b5816231d5",
"FieldId": "f73281c5-6ca8-4354-a1b1-073d3d772ac2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e09f2c18-6853-4d28-ba9d-72b5816231d5",
"FieldId": "f73281c5-6ca8-4354-a1b1-073d3d772ac2",
"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": "8d94343f-881e-435f-8917-1665169393ea",
"Section": {
"FormTypeSectionId": "ba467021-5a2e-4c3a-95f8-60a697af4b57",
"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": "786b236b-198e-4d85-a676-2fcb8dd60979",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "96f4d609-c3fc-434e-a440-1c73cb5c2001",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "95045bd2-bec7-4df0-b029-b646e616eb16",
"CreateDate": "2026-02-07T13:14:14.8359605-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-07T13:14:14.8359605-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e09f2c18-6853-4d28-ba9d-72b5816231d5",
"FieldId": "f73281c5-6ca8-4354-a1b1-073d3d772ac2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e09f2c18-6853-4d28-ba9d-72b5816231d5",
"FieldId": "f73281c5-6ca8-4354-a1b1-073d3d772ac2",
"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": "918e3956-da0a-4529-ba67-2e17bc2554d7",
"CreateDate": "2026-02-07T13:14:14.8359605-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-07T13:14:14.8359605-08: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"
}