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": "8a729173-6b23-4ec4-ae07-341ddffd6793",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b8848f73-4759-4355-856c-2f336b915a5e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed646816-af05-42c8-9008-ba4f496bd2ea",
"CreateDate": "2026-01-17T09:56:16.3982504-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-17T09:56:16.3982504-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-17T09:56:16.3982504-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "a40df41f-7de9-4d5f-a34f-b217861c5596",
"Section": {
"FormTypeSectionId": "c122388c-47f0-4038-9511-0290757f7469",
"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": "5ee8a189-b3f7-4414-967a-3364bde36e88",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c5c31e41-4844-458b-8c8d-55e2ab320a74",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "913278c8-effe-450d-baf6-1a0dc24f2409",
"CreateDate": "2026-01-17T09:56:16.3982504-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-17T09:56:16.3982504-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a03a4d8c-fbc1-4f13-9514-d78a3b1b2fe3",
"FieldId": "342acfaf-aecd-4ab1-94ea-88648342d412",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a03a4d8c-fbc1-4f13-9514-d78a3b1b2fe3",
"FieldId": "342acfaf-aecd-4ab1-94ea-88648342d412",
"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": "a40df41f-7de9-4d5f-a34f-b217861c5596",
"Section": {
"FormTypeSectionId": "c122388c-47f0-4038-9511-0290757f7469",
"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": "5ee8a189-b3f7-4414-967a-3364bde36e88",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c5c31e41-4844-458b-8c8d-55e2ab320a74",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "913278c8-effe-450d-baf6-1a0dc24f2409",
"CreateDate": "2026-01-17T09:56:16.3982504-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-17T09:56:16.3982504-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a03a4d8c-fbc1-4f13-9514-d78a3b1b2fe3",
"FieldId": "342acfaf-aecd-4ab1-94ea-88648342d412",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a03a4d8c-fbc1-4f13-9514-d78a3b1b2fe3",
"FieldId": "342acfaf-aecd-4ab1-94ea-88648342d412",
"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": "cf420827-7afb-4b57-9415-ed7430a24d6a",
"CreateDate": "2026-01-17T09:56:16.3982504-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-17T09:56:16.3982504-08: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"
}