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": "dbe64ddc-9a96-4629-baa4-fa2b11f41d40",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1aeb1b31-6a96-4311-86ae-7722bfb6981d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4171c4c8-33a3-430b-bed7-5e05369ea571",
"CreateDate": "2026-10-27T21:44:41.5091049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T21:44:41.5091049-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T21:44:41.5091049-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "774ac49b-5ccd-4af0-8e00-45e0528630b9",
"Section": {
"FormTypeSectionId": "e79c622a-afd5-429b-8476-ef642bd4b15e",
"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": "2b34c3d6-3f90-4e73-998e-8e3e898aabb2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cbac7927-39b1-42e0-a597-6cddb388677c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e3e2ea8b-cc3d-4653-9932-e437589cf4bf",
"CreateDate": "2026-10-27T21:44:41.5091049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T21:44:41.5091049-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5ba638df-eeb2-4f68-9fd7-19900c6c395a",
"FieldId": "efdd6c2c-4901-42e2-8d17-897247203280",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5ba638df-eeb2-4f68-9fd7-19900c6c395a",
"FieldId": "efdd6c2c-4901-42e2-8d17-897247203280",
"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": "774ac49b-5ccd-4af0-8e00-45e0528630b9",
"Section": {
"FormTypeSectionId": "e79c622a-afd5-429b-8476-ef642bd4b15e",
"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": "2b34c3d6-3f90-4e73-998e-8e3e898aabb2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cbac7927-39b1-42e0-a597-6cddb388677c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e3e2ea8b-cc3d-4653-9932-e437589cf4bf",
"CreateDate": "2026-10-27T21:44:41.5091049-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T21:44:41.5091049-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5ba638df-eeb2-4f68-9fd7-19900c6c395a",
"FieldId": "efdd6c2c-4901-42e2-8d17-897247203280",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5ba638df-eeb2-4f68-9fd7-19900c6c395a",
"FieldId": "efdd6c2c-4901-42e2-8d17-897247203280",
"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": "3f3c2ab8-5bc5-41c4-bb59-44656cac250b",
"CreateDate": "2026-10-27T21:44:41.5091049-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T21:44:41.5091049-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"
}