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": "3e127283-2e01-4b33-b816-785b09093d93",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8c45bde0-f40f-4b1e-b36e-3e2efa7b6de8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "57c645a3-8aec-4f7c-9dbc-be9e75f56bdb",
"CreateDate": "2026-09-26T07:57:41.568736-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T07:57:41.568736-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T07:57:41.568736-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "eea03ba4-0d7e-4b3c-807b-de917ccfb2f2",
"Section": {
"FormTypeSectionId": "bcb8bdd4-cfcb-48d9-b683-a84ebcadcbd0",
"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": "761ef5fd-73eb-4118-89a8-dcaf509c356d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ac4d637a-e192-4a32-9d07-e9555e21ac03",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "463313c2-31c0-407c-b2be-63d2da1d5800",
"CreateDate": "2026-09-26T07:57:41.568736-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T07:57:41.568736-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "143d43bc-a565-42cc-9fc5-546b266380bc",
"FieldId": "5daaeffa-4bd8-4692-8c60-0f1f1c4f467e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "143d43bc-a565-42cc-9fc5-546b266380bc",
"FieldId": "5daaeffa-4bd8-4692-8c60-0f1f1c4f467e",
"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": "eea03ba4-0d7e-4b3c-807b-de917ccfb2f2",
"Section": {
"FormTypeSectionId": "bcb8bdd4-cfcb-48d9-b683-a84ebcadcbd0",
"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": "761ef5fd-73eb-4118-89a8-dcaf509c356d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ac4d637a-e192-4a32-9d07-e9555e21ac03",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "463313c2-31c0-407c-b2be-63d2da1d5800",
"CreateDate": "2026-09-26T07:57:41.568736-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T07:57:41.568736-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "143d43bc-a565-42cc-9fc5-546b266380bc",
"FieldId": "5daaeffa-4bd8-4692-8c60-0f1f1c4f467e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "143d43bc-a565-42cc-9fc5-546b266380bc",
"FieldId": "5daaeffa-4bd8-4692-8c60-0f1f1c4f467e",
"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": "7d7f00da-d731-41ce-b013-69f344d23812",
"CreateDate": "2026-09-26T07:57:41.568736-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T07:57:41.568736-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"
}