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": "1a94e65a-3674-4548-b60e-2aaede9b9e47",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29ed1a52-0587-4e55-8014-496a6d6edb3e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "69c64697-dd9c-4394-bb83-92875f208792",
"CreateDate": "2026-09-04T22:35:59.2944341-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-04T22:35:59.2944341-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-04T22:35:59.2944341-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "b20138f0-7b8b-45a7-9c00-99654478bf9c",
"Section": {
"FormTypeSectionId": "2292e2d4-ded8-4263-8849-cbf7e0e0cd2d",
"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": "a942a52e-fab2-466e-a841-30042ba49e5e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e8d6f778-e24a-4700-a6d9-e9670615fb58",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bf464db7-effd-456f-b028-7f6afc4a6a8b",
"CreateDate": "2026-09-04T22:35:59.2944341-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-04T22:35:59.2944341-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d3366efd-8f68-48d6-8690-1e5d029257a4",
"FieldId": "05765ad5-b60c-4d7d-9a18-59eab4403591",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d3366efd-8f68-48d6-8690-1e5d029257a4",
"FieldId": "05765ad5-b60c-4d7d-9a18-59eab4403591",
"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": "b20138f0-7b8b-45a7-9c00-99654478bf9c",
"Section": {
"FormTypeSectionId": "2292e2d4-ded8-4263-8849-cbf7e0e0cd2d",
"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": "a942a52e-fab2-466e-a841-30042ba49e5e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e8d6f778-e24a-4700-a6d9-e9670615fb58",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bf464db7-effd-456f-b028-7f6afc4a6a8b",
"CreateDate": "2026-09-04T22:35:59.2944341-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-04T22:35:59.2944341-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d3366efd-8f68-48d6-8690-1e5d029257a4",
"FieldId": "05765ad5-b60c-4d7d-9a18-59eab4403591",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d3366efd-8f68-48d6-8690-1e5d029257a4",
"FieldId": "05765ad5-b60c-4d7d-9a18-59eab4403591",
"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": "3599f09b-ab7f-460d-a351-9c4b387625a2",
"CreateDate": "2026-09-04T22:35:59.2944341-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-04T22:35:59.2944341-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"
}