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": "af2bcc26-9e47-4635-a544-6076169ec9bf",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "89e04872-9a21-4163-b72c-fc8c7358590f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e55fef9f-04e7-447a-9867-df34bb0217c7",
"CreateDate": "2026-09-29T09:22:53.8310592-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-29T09:22:53.8310592-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-29T09:22:53.8310592-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "d6de49ea-5230-48aa-bd2b-72eca9484deb",
"Section": {
"FormTypeSectionId": "9b677812-2f6c-47f5-9ddb-0d175556b7d2",
"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": "61e1e4be-5b6a-4a17-90dc-063c28ae7864",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "587ca6a9-9138-4f8c-a3d8-702ba0ea6ab3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c7c9ad96-d0db-4d50-8a92-db2c30a05862",
"CreateDate": "2026-09-29T09:22:53.8310592-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-29T09:22:53.8310592-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "be2ec0d8-1ac1-4055-bc27-72c3ab435ba8",
"FieldId": "18044d0d-e8a5-432e-abee-695c17b0ebbf",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "be2ec0d8-1ac1-4055-bc27-72c3ab435ba8",
"FieldId": "18044d0d-e8a5-432e-abee-695c17b0ebbf",
"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": "d6de49ea-5230-48aa-bd2b-72eca9484deb",
"Section": {
"FormTypeSectionId": "9b677812-2f6c-47f5-9ddb-0d175556b7d2",
"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": "61e1e4be-5b6a-4a17-90dc-063c28ae7864",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "587ca6a9-9138-4f8c-a3d8-702ba0ea6ab3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c7c9ad96-d0db-4d50-8a92-db2c30a05862",
"CreateDate": "2026-09-29T09:22:53.8310592-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-29T09:22:53.8310592-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "be2ec0d8-1ac1-4055-bc27-72c3ab435ba8",
"FieldId": "18044d0d-e8a5-432e-abee-695c17b0ebbf",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "be2ec0d8-1ac1-4055-bc27-72c3ab435ba8",
"FieldId": "18044d0d-e8a5-432e-abee-695c17b0ebbf",
"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": "0284570a-5120-45a1-9870-af65bb674bec",
"CreateDate": "2026-09-29T09:22:53.8310592-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-29T09:22:53.8310592-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"
}