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": "e25a173d-8873-4c79-871c-57cfe19310d9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a9105c8e-415f-467a-b0e2-96325958e342",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8515e5dc-7942-4cda-ac64-54fa03bc289d",
"CreateDate": "2026-05-18T12:45:27.8586118-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-18T12:45:27.8586118-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-18T12:45:27.8586118-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "f8e6d65f-c84f-4ccb-bdd4-ff096bedc951",
"Section": {
"FormTypeSectionId": "d64970e1-009d-41b7-88b2-c69f7adbfc58",
"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": "fa7d215f-6e0a-4d22-9592-23246f27a11d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "36be7e92-2ac3-4193-832f-9a68fc7b3033",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3610d071-e07a-4f2b-bcee-a6ba2e8c0e57",
"CreateDate": "2026-05-18T12:45:27.8586118-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-18T12:45:27.8586118-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6961cc62-62db-43af-a04d-6a97a3b16b4a",
"FieldId": "c42a7fdd-5f0f-4842-93b4-3fee9e7de062",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6961cc62-62db-43af-a04d-6a97a3b16b4a",
"FieldId": "c42a7fdd-5f0f-4842-93b4-3fee9e7de062",
"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": "f8e6d65f-c84f-4ccb-bdd4-ff096bedc951",
"Section": {
"FormTypeSectionId": "d64970e1-009d-41b7-88b2-c69f7adbfc58",
"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": "fa7d215f-6e0a-4d22-9592-23246f27a11d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "36be7e92-2ac3-4193-832f-9a68fc7b3033",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3610d071-e07a-4f2b-bcee-a6ba2e8c0e57",
"CreateDate": "2026-05-18T12:45:27.8586118-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-18T12:45:27.8586118-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6961cc62-62db-43af-a04d-6a97a3b16b4a",
"FieldId": "c42a7fdd-5f0f-4842-93b4-3fee9e7de062",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6961cc62-62db-43af-a04d-6a97a3b16b4a",
"FieldId": "c42a7fdd-5f0f-4842-93b4-3fee9e7de062",
"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": "f41e41d3-88d6-4fb6-a063-db48df44f132",
"CreateDate": "2026-05-18T12:45:27.8586118-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-18T12:45:27.8586118-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"
}