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": "57769617-29f3-4f88-a886-2c7a18a02818",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "de5e439d-71f6-4ebb-8d85-362f65f702bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "882f55af-3cbf-49a8-8540-41566d431ff1",
"CreateDate": "2026-03-23T15:44:58.425554-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-23T15:44:58.425554-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-23T15:44:58.425554-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8ad38064-673a-4c18-8dc6-9af57374e3ae",
"Section": {
"FormTypeSectionId": "364de6c2-e070-4aa5-bdb9-3773c13cdbee",
"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": "6927101e-d93d-4299-82b8-9f8d6ab63303",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dae38ab0-386b-430f-947d-aeec7bbefd97",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "75fb99cb-06db-48f6-adb2-0211bb3321f0",
"CreateDate": "2026-03-23T15:44:58.425554-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-23T15:44:58.425554-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "56b09301-fc25-4591-a90b-511a88471b64",
"FieldId": "c4873b9e-b309-48fd-8fe1-abe7053128e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "56b09301-fc25-4591-a90b-511a88471b64",
"FieldId": "c4873b9e-b309-48fd-8fe1-abe7053128e1",
"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": "8ad38064-673a-4c18-8dc6-9af57374e3ae",
"Section": {
"FormTypeSectionId": "364de6c2-e070-4aa5-bdb9-3773c13cdbee",
"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": "6927101e-d93d-4299-82b8-9f8d6ab63303",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dae38ab0-386b-430f-947d-aeec7bbefd97",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "75fb99cb-06db-48f6-adb2-0211bb3321f0",
"CreateDate": "2026-03-23T15:44:58.425554-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-23T15:44:58.425554-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "56b09301-fc25-4591-a90b-511a88471b64",
"FieldId": "c4873b9e-b309-48fd-8fe1-abe7053128e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "56b09301-fc25-4591-a90b-511a88471b64",
"FieldId": "c4873b9e-b309-48fd-8fe1-abe7053128e1",
"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": "9b5fc2b8-0a6e-4d34-a15a-fb7bdbbb96a0",
"CreateDate": "2026-03-23T15:44:58.425554-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-23T15:44:58.425554-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"
}