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": "c1f635b5-4661-4230-8199-c32c6c64b9e7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bea99879-0a97-4fc0-8679-a74e4f1552ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "43203663-75c5-4974-b19c-c9237dde2cde",
"CreateDate": "2026-06-15T03:40:47.5682878-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-15T03:40:47.5682878-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-15T03:40:47.5682878-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "f055c813-0ad2-4535-a442-027c8d685519",
"Section": {
"FormTypeSectionId": "e1356681-aef7-4875-b0c6-7e5446306d42",
"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": "a68ff92b-e15b-4907-ad12-5c8f2bab9664",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2a438d80-4c01-414b-8860-3587b9b55e2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "934e66e7-a80d-44e6-92a2-5acf28567ed3",
"CreateDate": "2026-06-15T03:40:47.5682878-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-15T03:40:47.5682878-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d49360c5-0030-4687-9bf8-a7d57d2cb8e6",
"FieldId": "3bc85a5f-85f7-47c6-a846-c21be13678dd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d49360c5-0030-4687-9bf8-a7d57d2cb8e6",
"FieldId": "3bc85a5f-85f7-47c6-a846-c21be13678dd",
"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": "f055c813-0ad2-4535-a442-027c8d685519",
"Section": {
"FormTypeSectionId": "e1356681-aef7-4875-b0c6-7e5446306d42",
"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": "a68ff92b-e15b-4907-ad12-5c8f2bab9664",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2a438d80-4c01-414b-8860-3587b9b55e2d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "934e66e7-a80d-44e6-92a2-5acf28567ed3",
"CreateDate": "2026-06-15T03:40:47.5682878-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-15T03:40:47.5682878-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d49360c5-0030-4687-9bf8-a7d57d2cb8e6",
"FieldId": "3bc85a5f-85f7-47c6-a846-c21be13678dd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d49360c5-0030-4687-9bf8-a7d57d2cb8e6",
"FieldId": "3bc85a5f-85f7-47c6-a846-c21be13678dd",
"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": "68c3eec4-fb70-4588-b4ae-48b80550ef41",
"CreateDate": "2026-06-15T03:40:47.5682878-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-15T03:40:47.5682878-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"
}