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": "ae848fe9-f9b5-42f3-8e2e-cb626ca88eb1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ae332356-eb10-4cee-b491-34600f3ded3b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4771ecc8-7b23-4a50-be4e-df26e5d789ce",
"CreateDate": "2026-10-20T19:22:21.5065948-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T19:22:21.5065948-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-20T19:22:21.5065948-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "c1c1d913-1a84-4d98-9393-16a4862a0acf",
"Section": {
"FormTypeSectionId": "32bd5c70-6357-44ae-9cef-f90b007351f3",
"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": "4ee44507-72be-49ee-96f8-f2c52aeaa49b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dbfa8c01-addf-4b8a-8918-1c30b29176d7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "344532f7-6d88-491f-8ca6-02f4c6bd15e7",
"CreateDate": "2026-10-20T19:22:21.5065948-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T19:22:21.5065948-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "16fe9228-5f94-4b25-a00d-92cbe8911f8c",
"FieldId": "11115bca-87dc-4dcb-811d-c380a9b8ff91",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "16fe9228-5f94-4b25-a00d-92cbe8911f8c",
"FieldId": "11115bca-87dc-4dcb-811d-c380a9b8ff91",
"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": "c1c1d913-1a84-4d98-9393-16a4862a0acf",
"Section": {
"FormTypeSectionId": "32bd5c70-6357-44ae-9cef-f90b007351f3",
"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": "4ee44507-72be-49ee-96f8-f2c52aeaa49b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dbfa8c01-addf-4b8a-8918-1c30b29176d7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "344532f7-6d88-491f-8ca6-02f4c6bd15e7",
"CreateDate": "2026-10-20T19:22:21.5065948-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T19:22:21.5065948-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "16fe9228-5f94-4b25-a00d-92cbe8911f8c",
"FieldId": "11115bca-87dc-4dcb-811d-c380a9b8ff91",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "16fe9228-5f94-4b25-a00d-92cbe8911f8c",
"FieldId": "11115bca-87dc-4dcb-811d-c380a9b8ff91",
"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": "dda3b74f-6252-4d94-81f8-a56d3e993db8",
"CreateDate": "2026-10-20T19:22:21.5065948-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T19:22:21.5065948-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"
}