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": "35712f27-91fb-441b-9cae-62492bc18cd8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8cf57e83-fe6c-4f41-9f8a-a047bc2f64c2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c59f4645-cb66-4ccc-bc39-61cdd3912e0f",
"CreateDate": "2026-04-19T19:20:06.0730205-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-19T19:20:06.0730205-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-19T19:20:06.0730205-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "46193ead-e9e6-4949-899d-927a3779eb0c",
"Section": {
"FormTypeSectionId": "9e30d3f1-bcb4-44dd-8598-7101e28cb998",
"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": "7b87a582-104f-4407-90ee-914a064b8411",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1f2f86bf-17d7-418f-a24c-e6e230890e10",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49ce8e25-e48e-4f1f-8d46-e23e6e89878f",
"CreateDate": "2026-04-19T19:20:06.0730205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-19T19:20:06.0730205-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d487850d-d8bd-40ee-8b20-b00982f11286",
"FieldId": "14c60efc-f53d-43d1-b413-7d8cd2ba4c84",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d487850d-d8bd-40ee-8b20-b00982f11286",
"FieldId": "14c60efc-f53d-43d1-b413-7d8cd2ba4c84",
"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": "46193ead-e9e6-4949-899d-927a3779eb0c",
"Section": {
"FormTypeSectionId": "9e30d3f1-bcb4-44dd-8598-7101e28cb998",
"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": "7b87a582-104f-4407-90ee-914a064b8411",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1f2f86bf-17d7-418f-a24c-e6e230890e10",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "49ce8e25-e48e-4f1f-8d46-e23e6e89878f",
"CreateDate": "2026-04-19T19:20:06.0730205-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-19T19:20:06.0730205-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d487850d-d8bd-40ee-8b20-b00982f11286",
"FieldId": "14c60efc-f53d-43d1-b413-7d8cd2ba4c84",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d487850d-d8bd-40ee-8b20-b00982f11286",
"FieldId": "14c60efc-f53d-43d1-b413-7d8cd2ba4c84",
"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": "cb95f1fc-9008-4342-8865-6799177e3fa8",
"CreateDate": "2026-04-19T19:20:06.0730205-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-19T19:20:06.0730205-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"
}