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": "63147227-838b-4576-bfe6-8b47c89fa529",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "be658570-8d57-466a-9c14-add97fd14b63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5b9727d7-98a0-4366-9b76-56a7468d52e9",
"CreateDate": "2026-06-25T14:26:27.1514923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:26:27.1514923-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-25T14:26:27.1514923-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "c2ae7a74-208b-4708-9752-ff42dd69d774",
"Section": {
"FormTypeSectionId": "67a34aee-74ff-4896-abb3-1266a1251df4",
"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": "02990a13-a9e8-4204-9d46-000e3d0c23f1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46883b3f-d951-4cb3-8176-c55ec702c9ef",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca730828-83d3-46e4-9e5e-e0fafb37dbe8",
"CreateDate": "2026-06-25T14:26:27.1514923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:27.1514923-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6e8ed97-741e-4995-8c61-5debeb2e6085",
"FieldId": "6cad8158-98c6-4a1f-aa9e-443a1982f0b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6e8ed97-741e-4995-8c61-5debeb2e6085",
"FieldId": "6cad8158-98c6-4a1f-aa9e-443a1982f0b6",
"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": "c2ae7a74-208b-4708-9752-ff42dd69d774",
"Section": {
"FormTypeSectionId": "67a34aee-74ff-4896-abb3-1266a1251df4",
"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": "02990a13-a9e8-4204-9d46-000e3d0c23f1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46883b3f-d951-4cb3-8176-c55ec702c9ef",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca730828-83d3-46e4-9e5e-e0fafb37dbe8",
"CreateDate": "2026-06-25T14:26:27.1514923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:26:27.1514923-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6e8ed97-741e-4995-8c61-5debeb2e6085",
"FieldId": "6cad8158-98c6-4a1f-aa9e-443a1982f0b6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6e8ed97-741e-4995-8c61-5debeb2e6085",
"FieldId": "6cad8158-98c6-4a1f-aa9e-443a1982f0b6",
"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": "d2206c77-edce-45b7-bec8-0b9580194612",
"CreateDate": "2026-06-25T14:26:27.1514923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:26:27.1514923-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"
}