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": "344fe7b2-ec34-4ecd-9f88-be986a561900",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "48a98470-6896-445d-baf3-5f37d7ac9b0c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "04ca444a-12e4-4852-b079-162dd9d8ee51",
"CreateDate": "2026-08-14T18:49:36.4588732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-14T18:49:36.4588732-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-14T18:49:36.4588732-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "078ed71f-4ea0-40c0-877e-34ae54582aaf",
"Section": {
"FormTypeSectionId": "1bd1a9d6-9fbc-4d13-a780-38402893f3f0",
"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": "f29b8ab5-1139-435a-8c77-8ab02472fb4f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2c425177-fafb-42b0-a38e-47f18192c686",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "699ade67-a790-47c5-8863-433c514bcf2a",
"CreateDate": "2026-08-14T18:49:36.4588732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-14T18:49:36.4588732-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7f73848b-ce59-4179-8cc6-cad3e6660270",
"FieldId": "ac95f0da-a2a3-4ff4-a1c5-0879775bd0c8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7f73848b-ce59-4179-8cc6-cad3e6660270",
"FieldId": "ac95f0da-a2a3-4ff4-a1c5-0879775bd0c8",
"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": "078ed71f-4ea0-40c0-877e-34ae54582aaf",
"Section": {
"FormTypeSectionId": "1bd1a9d6-9fbc-4d13-a780-38402893f3f0",
"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": "f29b8ab5-1139-435a-8c77-8ab02472fb4f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2c425177-fafb-42b0-a38e-47f18192c686",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "699ade67-a790-47c5-8863-433c514bcf2a",
"CreateDate": "2026-08-14T18:49:36.4588732-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-14T18:49:36.4588732-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7f73848b-ce59-4179-8cc6-cad3e6660270",
"FieldId": "ac95f0da-a2a3-4ff4-a1c5-0879775bd0c8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7f73848b-ce59-4179-8cc6-cad3e6660270",
"FieldId": "ac95f0da-a2a3-4ff4-a1c5-0879775bd0c8",
"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": "097602d2-81e9-4024-b02a-2fce70835f79",
"CreateDate": "2026-08-14T18:49:36.4588732-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-14T18:49:36.4588732-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"
}