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": "2a949ea1-8f5e-4625-bcab-1c796937c43b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d7b87189-2afc-44d2-ac6d-b69c4d2eb647",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0141eced-aaa9-42d6-b212-9bfaec04f1b6",
"CreateDate": "2026-07-30T12:42:18.9020412-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-30T12:42:18.9020412-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-30T12:42:18.9020412-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "31df13f5-ee6a-42dd-9db1-08cea0f19f87",
"Section": {
"FormTypeSectionId": "2fd1e1f1-800d-4054-80b0-88bd1ed0ec77",
"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": "b62dfa93-1cc7-493b-8e91-a621dc16a50d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "263abe09-2385-402c-969b-2dafa252fdb1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5e40895f-cb15-4fef-975a-b74e373f6d74",
"CreateDate": "2026-07-30T12:42:18.9020412-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-30T12:42:18.9020412-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ac73cc61-f6a8-4c67-b246-51f5672a9e94",
"FieldId": "28dd419e-a48f-4b51-acc3-3be6478affc3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ac73cc61-f6a8-4c67-b246-51f5672a9e94",
"FieldId": "28dd419e-a48f-4b51-acc3-3be6478affc3",
"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": "31df13f5-ee6a-42dd-9db1-08cea0f19f87",
"Section": {
"FormTypeSectionId": "2fd1e1f1-800d-4054-80b0-88bd1ed0ec77",
"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": "b62dfa93-1cc7-493b-8e91-a621dc16a50d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "263abe09-2385-402c-969b-2dafa252fdb1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5e40895f-cb15-4fef-975a-b74e373f6d74",
"CreateDate": "2026-07-30T12:42:18.9020412-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-30T12:42:18.9020412-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ac73cc61-f6a8-4c67-b246-51f5672a9e94",
"FieldId": "28dd419e-a48f-4b51-acc3-3be6478affc3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ac73cc61-f6a8-4c67-b246-51f5672a9e94",
"FieldId": "28dd419e-a48f-4b51-acc3-3be6478affc3",
"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": "9ac1dbde-f23b-493b-b247-807a14fe8b41",
"CreateDate": "2026-07-30T12:42:18.9020412-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-30T12:42:18.9020412-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"
}