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": "6c23aff5-7384-4d58-90f7-8d32f3357383",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "67dcea58-9890-472f-ae05-7f30e4ea6bf8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0358188b-388f-420f-819a-fb8ba42fd854",
"CreateDate": "2026-06-08T15:39:39.5730953-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-08T15:39:39.5730953-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-08T15:39:39.5730953-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "13339251-3f3e-4ac1-90bf-aaa8f949fb46",
"Section": {
"FormTypeSectionId": "64dfe5f6-c5bf-493e-9cf0-5f5541cb52d2",
"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": "4d04f6fe-f394-4b1a-a71a-5059af6b092b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "533e9841-983d-4061-8a99-4929ba77d7b3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "21d4c7e4-0933-4bcf-9c51-6cae3bc43ccf",
"CreateDate": "2026-06-08T15:39:39.5730953-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-08T15:39:39.5730953-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bccf6b5c-915e-4a24-944b-ba6a3b662faf",
"FieldId": "f464621a-7a0c-4f63-88d4-284330c4bcd2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bccf6b5c-915e-4a24-944b-ba6a3b662faf",
"FieldId": "f464621a-7a0c-4f63-88d4-284330c4bcd2",
"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": "13339251-3f3e-4ac1-90bf-aaa8f949fb46",
"Section": {
"FormTypeSectionId": "64dfe5f6-c5bf-493e-9cf0-5f5541cb52d2",
"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": "4d04f6fe-f394-4b1a-a71a-5059af6b092b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "533e9841-983d-4061-8a99-4929ba77d7b3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "21d4c7e4-0933-4bcf-9c51-6cae3bc43ccf",
"CreateDate": "2026-06-08T15:39:39.5730953-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-08T15:39:39.5730953-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bccf6b5c-915e-4a24-944b-ba6a3b662faf",
"FieldId": "f464621a-7a0c-4f63-88d4-284330c4bcd2",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bccf6b5c-915e-4a24-944b-ba6a3b662faf",
"FieldId": "f464621a-7a0c-4f63-88d4-284330c4bcd2",
"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": "8bf7be21-6c78-4e46-85c8-c9585900823c",
"CreateDate": "2026-06-08T15:39:39.5730953-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-08T15:39:39.5730953-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"
}