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": "33eaf01f-9bd0-42ef-a8d5-1a50fae4c59a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bebd3d31-58ba-4bb1-a326-5b209b4f591c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "da2d28c9-4bae-4e2d-bf87-8c9e8467fafb",
"CreateDate": "2026-07-15T08:58:01.607652-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T08:58:01.607652-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-15T08:58:01.607652-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "754998f3-6ba5-415c-9440-dc524e37765f",
"Section": {
"FormTypeSectionId": "cfca2cd1-8577-4bc2-9a95-0da047789187",
"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": "a63aca60-45fa-4d27-99b5-693ce7ee5779",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f849bd8b-69bf-4f73-81da-7b8a453bdd7a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dfb62398-1589-4272-b70d-220fd40c72b3",
"CreateDate": "2026-07-15T08:58:01.607652-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T08:58:01.607652-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "aa08e3e8-a434-4235-8e9e-eccf0ec7ffbf",
"FieldId": "ed2c6c35-a921-4158-b11d-f698d8475e45",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "aa08e3e8-a434-4235-8e9e-eccf0ec7ffbf",
"FieldId": "ed2c6c35-a921-4158-b11d-f698d8475e45",
"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": "754998f3-6ba5-415c-9440-dc524e37765f",
"Section": {
"FormTypeSectionId": "cfca2cd1-8577-4bc2-9a95-0da047789187",
"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": "a63aca60-45fa-4d27-99b5-693ce7ee5779",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f849bd8b-69bf-4f73-81da-7b8a453bdd7a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dfb62398-1589-4272-b70d-220fd40c72b3",
"CreateDate": "2026-07-15T08:58:01.607652-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T08:58:01.607652-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "aa08e3e8-a434-4235-8e9e-eccf0ec7ffbf",
"FieldId": "ed2c6c35-a921-4158-b11d-f698d8475e45",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "aa08e3e8-a434-4235-8e9e-eccf0ec7ffbf",
"FieldId": "ed2c6c35-a921-4158-b11d-f698d8475e45",
"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": "ec6e5c8d-4f4d-4921-8dca-babe9e31013e",
"CreateDate": "2026-07-15T08:58:01.607652-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T08:58:01.607652-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"
}