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": "62e302b3-69f6-4fbb-9ce2-b604df9778bd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "602aa5b9-3c39-4b50-a45c-f80b7884bfc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "39ef08dc-980f-48a1-bdb5-d44317508f28",
"CreateDate": "2026-06-21T04:57:10.0111357-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T04:57:10.0111357-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-21T04:57:10.0111357-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ec818e9e-881e-4938-a185-30585fde41b6",
"Section": {
"FormTypeSectionId": "16194379-9253-4ad0-9989-2cdb5384c96e",
"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": "8cc1a024-8c4b-448e-8c47-5cf001e39c7a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7a4fd20-36e9-446d-9551-599ffd027ab5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "280b7dfa-c889-42ec-8959-1b1436fda1c6",
"CreateDate": "2026-06-21T04:57:10.0111357-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T04:57:10.0111357-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "df3fa3e8-c7a9-483e-bffd-8bc50250f3d4",
"FieldId": "405441ad-a9ea-4129-9f7f-c9624308d15f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "df3fa3e8-c7a9-483e-bffd-8bc50250f3d4",
"FieldId": "405441ad-a9ea-4129-9f7f-c9624308d15f",
"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": "ec818e9e-881e-4938-a185-30585fde41b6",
"Section": {
"FormTypeSectionId": "16194379-9253-4ad0-9989-2cdb5384c96e",
"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": "8cc1a024-8c4b-448e-8c47-5cf001e39c7a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7a4fd20-36e9-446d-9551-599ffd027ab5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "280b7dfa-c889-42ec-8959-1b1436fda1c6",
"CreateDate": "2026-06-21T04:57:10.0111357-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T04:57:10.0111357-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "df3fa3e8-c7a9-483e-bffd-8bc50250f3d4",
"FieldId": "405441ad-a9ea-4129-9f7f-c9624308d15f",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "df3fa3e8-c7a9-483e-bffd-8bc50250f3d4",
"FieldId": "405441ad-a9ea-4129-9f7f-c9624308d15f",
"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": "47e02171-d7b4-4b6e-9b9a-5d3e6751ffd8",
"CreateDate": "2026-06-21T04:57:10.0111357-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T04:57:10.0111357-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"
}