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": "b36a68fc-543f-4cda-bf34-37e236142d9d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "22f7bb26-d4a1-4dbb-8121-87913031e715",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "22f634db-9bca-47ae-a8cc-7e20571199ac",
"CreateDate": "2026-05-24T21:17:29.2750711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T21:17:29.2750711-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-24T21:17:29.2750711-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "45e27fd1-2559-4c8e-a0dd-c0f18872987c",
"Section": {
"FormTypeSectionId": "0a38fce1-1b5f-4631-a783-0c75f85ed179",
"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": "36282cb7-a634-423b-8ade-fe179ff3e29d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c38d4803-235e-45ee-9c17-570c4172af6a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9ef0d787-e590-42ee-8914-9ca7ae40215a",
"CreateDate": "2026-05-24T21:17:29.2750711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T21:17:29.2750711-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9eb3ca9d-6efa-4868-ba02-b9a9c47a17d8",
"FieldId": "17708124-75b2-4947-aba8-5757acffd4ac",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9eb3ca9d-6efa-4868-ba02-b9a9c47a17d8",
"FieldId": "17708124-75b2-4947-aba8-5757acffd4ac",
"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": "45e27fd1-2559-4c8e-a0dd-c0f18872987c",
"Section": {
"FormTypeSectionId": "0a38fce1-1b5f-4631-a783-0c75f85ed179",
"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": "36282cb7-a634-423b-8ade-fe179ff3e29d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c38d4803-235e-45ee-9c17-570c4172af6a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9ef0d787-e590-42ee-8914-9ca7ae40215a",
"CreateDate": "2026-05-24T21:17:29.2750711-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T21:17:29.2750711-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9eb3ca9d-6efa-4868-ba02-b9a9c47a17d8",
"FieldId": "17708124-75b2-4947-aba8-5757acffd4ac",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9eb3ca9d-6efa-4868-ba02-b9a9c47a17d8",
"FieldId": "17708124-75b2-4947-aba8-5757acffd4ac",
"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": "1f037fc0-b026-4803-8e01-283c12e5c307",
"CreateDate": "2026-05-24T21:17:29.2750711-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T21:17:29.2750711-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"
}