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": "20faca7e-723a-4648-b153-b51ee4de0739",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "51f0808c-4203-46ba-969f-0b9aee9c0298",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9d3cff6e-e1ed-4c50-bb45-1432200d0eeb",
"CreateDate": "2026-07-27T12:03:58.6752801-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-27T12:03:58.6752801-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-27T12:03:58.6752801-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8fc39cb8-7a01-4e35-925d-716cf9725565",
"Section": {
"FormTypeSectionId": "632c3d8b-fb6d-4063-a163-c8649ba4c9ce",
"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": "2c160fb9-6c2a-4e1a-a627-212ef030163a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9469db23-3c1f-4c57-a5d3-b657064eb3a0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b78e77cc-398f-4442-864d-7cffacdda171",
"CreateDate": "2026-07-27T12:03:58.6752801-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-27T12:03:58.6752801-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9b678690-b226-43d9-a160-36504a4c8617",
"FieldId": "ed2945dd-e34d-4615-910c-639b39d12fee",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9b678690-b226-43d9-a160-36504a4c8617",
"FieldId": "ed2945dd-e34d-4615-910c-639b39d12fee",
"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": "8fc39cb8-7a01-4e35-925d-716cf9725565",
"Section": {
"FormTypeSectionId": "632c3d8b-fb6d-4063-a163-c8649ba4c9ce",
"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": "2c160fb9-6c2a-4e1a-a627-212ef030163a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9469db23-3c1f-4c57-a5d3-b657064eb3a0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b78e77cc-398f-4442-864d-7cffacdda171",
"CreateDate": "2026-07-27T12:03:58.6752801-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-27T12:03:58.6752801-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9b678690-b226-43d9-a160-36504a4c8617",
"FieldId": "ed2945dd-e34d-4615-910c-639b39d12fee",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9b678690-b226-43d9-a160-36504a4c8617",
"FieldId": "ed2945dd-e34d-4615-910c-639b39d12fee",
"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": "693b5b3d-c939-4bae-aae7-112943c9bdde",
"CreateDate": "2026-07-27T12:03:58.6752801-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-27T12:03:58.6752801-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"
}