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": "3e157d92-23ab-47d8-aa41-15ce5c028a6e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "df25db97-0a49-4079-98ac-7ed420decc54",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bf97549b-0d8f-4c28-8dfe-3c4ce7a9689e",
"CreateDate": "2026-04-27T20:31:00.3206628-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:31:00.3206628-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T20:31:00.3206628-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "1d5fcef7-a9e4-4420-91c3-7b4af4f04fe5",
"Section": {
"FormTypeSectionId": "b8be030f-3812-4435-96e2-7408eceefc70",
"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": "49f8fbf9-5857-403b-bdfd-69cadd95d12d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7003b2f0-6248-4ae3-9223-d7faa5381992",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cfac238d-0225-40b8-8520-dbd1ee21d020",
"CreateDate": "2026-04-27T20:31:00.3206628-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:31:00.3206628-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "29e5e493-4f04-44e3-bfd6-bd2d0f6d16a9",
"FieldId": "b64aa928-d46b-417b-8873-708b6acedcb5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "29e5e493-4f04-44e3-bfd6-bd2d0f6d16a9",
"FieldId": "b64aa928-d46b-417b-8873-708b6acedcb5",
"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": "1d5fcef7-a9e4-4420-91c3-7b4af4f04fe5",
"Section": {
"FormTypeSectionId": "b8be030f-3812-4435-96e2-7408eceefc70",
"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": "49f8fbf9-5857-403b-bdfd-69cadd95d12d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7003b2f0-6248-4ae3-9223-d7faa5381992",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cfac238d-0225-40b8-8520-dbd1ee21d020",
"CreateDate": "2026-04-27T20:31:00.3206628-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:31:00.3206628-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "29e5e493-4f04-44e3-bfd6-bd2d0f6d16a9",
"FieldId": "b64aa928-d46b-417b-8873-708b6acedcb5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "29e5e493-4f04-44e3-bfd6-bd2d0f6d16a9",
"FieldId": "b64aa928-d46b-417b-8873-708b6acedcb5",
"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": "9e8ab081-3bb2-4ee2-89dd-7eba87378571",
"CreateDate": "2026-04-27T20:31:00.3206628-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:31:00.3206628-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"
}