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": "f45bbec8-b3a4-4ad7-a924-edf85d1a2c74",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9ba0fb1c-3711-4555-9e36-87629bcecd74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "080fb6c5-cc6e-441a-8184-c37f97bceeb5",
"CreateDate": "2026-10-29T21:40:31.8015849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-29T21:40:31.8015849-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-29T21:40:31.8015849-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ceb1e68e-b13d-43f6-8ea1-c24fe680791c",
"Section": {
"FormTypeSectionId": "dc7596f8-b88d-4d3b-a518-7320fe0870c7",
"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": "d440420a-a995-46f6-86c9-09971cd54bfb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2246dcf3-e2cf-4b43-809f-baa6a57c7917",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f479a803-69c1-4664-a32c-c5ae36299f7d",
"CreateDate": "2026-10-29T21:40:31.8015849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-29T21:40:31.8015849-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d067c87b-5678-4d69-b23f-7dce0aece34d",
"FieldId": "a2b1bcf2-231f-4a40-9911-94d07b7136e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d067c87b-5678-4d69-b23f-7dce0aece34d",
"FieldId": "a2b1bcf2-231f-4a40-9911-94d07b7136e1",
"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": "ceb1e68e-b13d-43f6-8ea1-c24fe680791c",
"Section": {
"FormTypeSectionId": "dc7596f8-b88d-4d3b-a518-7320fe0870c7",
"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": "d440420a-a995-46f6-86c9-09971cd54bfb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2246dcf3-e2cf-4b43-809f-baa6a57c7917",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f479a803-69c1-4664-a32c-c5ae36299f7d",
"CreateDate": "2026-10-29T21:40:31.8015849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-29T21:40:31.8015849-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d067c87b-5678-4d69-b23f-7dce0aece34d",
"FieldId": "a2b1bcf2-231f-4a40-9911-94d07b7136e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d067c87b-5678-4d69-b23f-7dce0aece34d",
"FieldId": "a2b1bcf2-231f-4a40-9911-94d07b7136e1",
"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": "62576254-a28e-457b-b246-6f160b16bbc7",
"CreateDate": "2026-10-29T21:40:31.8015849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-29T21:40:31.8015849-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"
}