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": "c5e6b042-e8fb-42f3-9f99-5e13544f8f2c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "46e7a657-1540-4da2-b4c5-4dfa777dd175",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1cb7bd3-37a0-4c45-8d06-d9d6c379043e",
"CreateDate": "2026-07-21T10:38:17.5370779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T10:38:17.5370779-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-21T10:38:17.5370779-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "60268823-c0d8-4741-b8ad-90433fd465be",
"Section": {
"FormTypeSectionId": "f5fa1a29-c1ae-4c44-bc93-87c494ceb5b4",
"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": "82b7e366-c1bd-4567-a86a-0eceab0ae577",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bd3f9533-a5c3-439c-8522-4ad86fbe7f19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1d26f619-9b4b-4bc1-8ffc-c8de18f2feb0",
"CreateDate": "2026-07-21T10:38:17.5370779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T10:38:17.5370779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "10f48b23-29df-47b3-857f-af7b3baf64ca",
"FieldId": "25a50ac5-92cf-422f-828f-9414f33ed536",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "10f48b23-29df-47b3-857f-af7b3baf64ca",
"FieldId": "25a50ac5-92cf-422f-828f-9414f33ed536",
"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": "60268823-c0d8-4741-b8ad-90433fd465be",
"Section": {
"FormTypeSectionId": "f5fa1a29-c1ae-4c44-bc93-87c494ceb5b4",
"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": "82b7e366-c1bd-4567-a86a-0eceab0ae577",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bd3f9533-a5c3-439c-8522-4ad86fbe7f19",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1d26f619-9b4b-4bc1-8ffc-c8de18f2feb0",
"CreateDate": "2026-07-21T10:38:17.5370779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T10:38:17.5370779-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "10f48b23-29df-47b3-857f-af7b3baf64ca",
"FieldId": "25a50ac5-92cf-422f-828f-9414f33ed536",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "10f48b23-29df-47b3-857f-af7b3baf64ca",
"FieldId": "25a50ac5-92cf-422f-828f-9414f33ed536",
"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": "bcce1a11-f062-4c4f-95c0-3e4cd350afae",
"CreateDate": "2026-07-21T10:38:17.5370779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T10:38:17.5370779-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"
}