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": "46aa0606-06ff-4174-b6ba-479b046d7cf9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dea3a6b9-2601-4610-a3cd-128ad15a73e1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f51d41a6-a36b-4b36-9490-e61246351709",
"CreateDate": "2026-01-24T09:33:12.2566316-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-24T09:33:12.2566316-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-24T09:33:12.2566316-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "9c8523bc-6d1e-4b2f-93aa-2fdfa977ac03",
"Section": {
"FormTypeSectionId": "8d1cafd7-3823-4061-8bcf-cfe81d948687",
"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": "ddd3a3b1-2e00-4445-a548-eaf569fdddd9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a6dda2d4-d609-4b83-ae75-24d89ed70f75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "786766af-6d46-4524-ac4e-5165b15dab8c",
"CreateDate": "2026-01-24T09:33:12.2566316-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T09:33:12.2566316-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b4e5345c-ae89-4973-8685-d44baf8601f6",
"FieldId": "cb339489-525a-45c4-966b-a14da521a0cb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b4e5345c-ae89-4973-8685-d44baf8601f6",
"FieldId": "cb339489-525a-45c4-966b-a14da521a0cb",
"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": "9c8523bc-6d1e-4b2f-93aa-2fdfa977ac03",
"Section": {
"FormTypeSectionId": "8d1cafd7-3823-4061-8bcf-cfe81d948687",
"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": "ddd3a3b1-2e00-4445-a548-eaf569fdddd9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a6dda2d4-d609-4b83-ae75-24d89ed70f75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "786766af-6d46-4524-ac4e-5165b15dab8c",
"CreateDate": "2026-01-24T09:33:12.2566316-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-24T09:33:12.2566316-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b4e5345c-ae89-4973-8685-d44baf8601f6",
"FieldId": "cb339489-525a-45c4-966b-a14da521a0cb",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b4e5345c-ae89-4973-8685-d44baf8601f6",
"FieldId": "cb339489-525a-45c4-966b-a14da521a0cb",
"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": "9d2af16d-ba73-4574-8ef6-665ffec0d519",
"CreateDate": "2026-01-24T09:33:12.2566316-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-24T09:33:12.2566316-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"
}