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": "ff3f8ce8-907c-4a4e-a0a8-00c7c6a198f1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "182dbeb7-2613-4883-b898-9122c24ccff8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cc05a38f-404b-4ced-81ee-e933b716d474",
"CreateDate": "2026-08-02T14:41:07.3656523-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T14:41:07.3656523-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-02T14:41:07.3656523-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "5576eb2b-beaf-4969-8e1d-5a8e903a8545",
"Section": {
"FormTypeSectionId": "c4dd2615-f0ee-4e6b-82b9-00a4fbab66aa",
"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": "c6a7e1f9-668b-48bf-967d-12e04cb9515e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "20e99f26-0b17-4648-9c1b-f71c34b19e98",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "79006c74-3f37-4130-8862-1e386bf164ff",
"CreateDate": "2026-08-02T14:41:07.3656523-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T14:41:07.3656523-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "98bd6371-887f-4f54-9800-181c35df21a0",
"FieldId": "be506917-ef89-4193-95b6-3ba7bc3aab0e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "98bd6371-887f-4f54-9800-181c35df21a0",
"FieldId": "be506917-ef89-4193-95b6-3ba7bc3aab0e",
"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": "5576eb2b-beaf-4969-8e1d-5a8e903a8545",
"Section": {
"FormTypeSectionId": "c4dd2615-f0ee-4e6b-82b9-00a4fbab66aa",
"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": "c6a7e1f9-668b-48bf-967d-12e04cb9515e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "20e99f26-0b17-4648-9c1b-f71c34b19e98",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "79006c74-3f37-4130-8862-1e386bf164ff",
"CreateDate": "2026-08-02T14:41:07.3656523-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T14:41:07.3656523-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "98bd6371-887f-4f54-9800-181c35df21a0",
"FieldId": "be506917-ef89-4193-95b6-3ba7bc3aab0e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "98bd6371-887f-4f54-9800-181c35df21a0",
"FieldId": "be506917-ef89-4193-95b6-3ba7bc3aab0e",
"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": "08556d7d-70b3-4ff5-b8e0-29cbec15154b",
"CreateDate": "2026-08-02T14:41:07.3656523-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T14:41:07.3656523-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"
}