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": "3337eff7-b748-4079-beea-9d3e03d6c449",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e89e674-31da-4125-9cc4-c7e5a6aaf6e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "62849e11-2d5a-4c85-a672-d4d973d97bae",
"CreateDate": "2026-08-29T21:51:27.2603025-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T21:51:27.2603025-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-29T21:51:27.2603025-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "4875944c-b3f3-4423-a4bf-6a13b5316332",
"Section": {
"FormTypeSectionId": "4e1f13ea-18e6-4664-9150-1becfe6440c4",
"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": "5731d9ab-a88a-4cd7-b33d-eb90fc4b96a7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "50d6e937-87c3-4489-b489-68c91ba1086d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a689267b-1406-4760-bed3-45ea1c0ba192",
"CreateDate": "2026-08-29T21:51:27.2603025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:51:27.2603025-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "061f7577-89f8-4f65-8ff8-9e72403a90b1",
"FieldId": "f9611a23-26ee-466b-ae88-6a27370fb348",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "061f7577-89f8-4f65-8ff8-9e72403a90b1",
"FieldId": "f9611a23-26ee-466b-ae88-6a27370fb348",
"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": "4875944c-b3f3-4423-a4bf-6a13b5316332",
"Section": {
"FormTypeSectionId": "4e1f13ea-18e6-4664-9150-1becfe6440c4",
"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": "5731d9ab-a88a-4cd7-b33d-eb90fc4b96a7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "50d6e937-87c3-4489-b489-68c91ba1086d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a689267b-1406-4760-bed3-45ea1c0ba192",
"CreateDate": "2026-08-29T21:51:27.2603025-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-29T21:51:27.2603025-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "061f7577-89f8-4f65-8ff8-9e72403a90b1",
"FieldId": "f9611a23-26ee-466b-ae88-6a27370fb348",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "061f7577-89f8-4f65-8ff8-9e72403a90b1",
"FieldId": "f9611a23-26ee-466b-ae88-6a27370fb348",
"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": "0dfa8f8e-27b4-4756-92c5-166cdb1af588",
"CreateDate": "2026-08-29T21:51:27.2603025-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-29T21:51:27.2603025-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"
}