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": "24e5ab3a-96f6-4a5f-8115-4cd687551d72",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "147f3f43-41c8-4de1-9b74-88b34e24362d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8b8155b6-59ce-4ebc-a020-8f67fbbf3beb",
"CreateDate": "2026-10-23T19:48:58.4869365-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-23T19:48:58.4869365-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-23T19:48:58.4869365-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ddab7091-3b37-411d-a121-30b30a042776",
"Section": {
"FormTypeSectionId": "0559c509-4eb9-41be-8be6-fe6fba8d5640",
"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": "7d81eb67-20ac-4300-885f-b5ea204532c9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "38f9d25c-824b-48ae-9791-dcbf163eb4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "348a882d-cc12-40a5-a0da-40f5d0659fc4",
"CreateDate": "2026-10-23T19:48:58.4869365-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T19:48:58.4869365-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "917c8c16-1fa6-4ad4-8248-2bf7b9d2c9e4",
"FieldId": "19e9a21a-2e57-4008-bdd6-d062b43aee20",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "917c8c16-1fa6-4ad4-8248-2bf7b9d2c9e4",
"FieldId": "19e9a21a-2e57-4008-bdd6-d062b43aee20",
"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": "ddab7091-3b37-411d-a121-30b30a042776",
"Section": {
"FormTypeSectionId": "0559c509-4eb9-41be-8be6-fe6fba8d5640",
"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": "7d81eb67-20ac-4300-885f-b5ea204532c9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "38f9d25c-824b-48ae-9791-dcbf163eb4e4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "348a882d-cc12-40a5-a0da-40f5d0659fc4",
"CreateDate": "2026-10-23T19:48:58.4869365-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T19:48:58.4869365-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "917c8c16-1fa6-4ad4-8248-2bf7b9d2c9e4",
"FieldId": "19e9a21a-2e57-4008-bdd6-d062b43aee20",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "917c8c16-1fa6-4ad4-8248-2bf7b9d2c9e4",
"FieldId": "19e9a21a-2e57-4008-bdd6-d062b43aee20",
"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": "342c1b74-9489-4c7a-84a8-aca6b0239257",
"CreateDate": "2026-10-23T19:48:58.4869365-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-23T19:48:58.4869365-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"
}