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": "313bf220-8b64-4c4b-98eb-792e54ffc737",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bdbcdfe4-dbad-4181-b993-22bce265c7b5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8778f17e-172e-49d1-ac5b-bacf5983a939",
"CreateDate": "2026-11-20T01:36:10.9732884-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-20T01:36:10.9732884-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-20T01:36:10.9732884-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "72196450-9a65-4450-b36d-eae000cc8e26",
"Section": {
"FormTypeSectionId": "25ab323d-84ca-4b74-b9de-3791ed0a42ab",
"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": "86e379c9-1395-4d93-8da3-ee7f0344c635",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b1bb354-dfb0-42a6-ab06-8753c825e612",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5380a78e-6435-4b51-976e-ac5301277451",
"CreateDate": "2026-11-20T01:36:10.9732884-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-20T01:36:10.9732884-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "608a0dfb-7877-45c6-bca7-471e4418f72c",
"FieldId": "441c2ecc-63f4-4f6b-8238-9eafd06baa23",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "608a0dfb-7877-45c6-bca7-471e4418f72c",
"FieldId": "441c2ecc-63f4-4f6b-8238-9eafd06baa23",
"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": "72196450-9a65-4450-b36d-eae000cc8e26",
"Section": {
"FormTypeSectionId": "25ab323d-84ca-4b74-b9de-3791ed0a42ab",
"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": "86e379c9-1395-4d93-8da3-ee7f0344c635",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0b1bb354-dfb0-42a6-ab06-8753c825e612",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5380a78e-6435-4b51-976e-ac5301277451",
"CreateDate": "2026-11-20T01:36:10.9732884-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-20T01:36:10.9732884-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "608a0dfb-7877-45c6-bca7-471e4418f72c",
"FieldId": "441c2ecc-63f4-4f6b-8238-9eafd06baa23",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "608a0dfb-7877-45c6-bca7-471e4418f72c",
"FieldId": "441c2ecc-63f4-4f6b-8238-9eafd06baa23",
"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": "83dcbef9-4f09-453d-bd68-77c32d33d4f2",
"CreateDate": "2026-11-20T01:36:10.9732884-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-20T01:36:10.9732884-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"
}