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": "b18facbe-8bdd-4941-ba9d-ca78ec2bb0c4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f32c781c-49e8-4b95-b33e-595ff9750c5a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "019af64c-7b9e-4212-8933-e6948b3dbfef",
"CreateDate": "2026-03-09T15:14:14.6621526-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T15:14:14.6621526-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-09T15:14:14.6621526-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e03007e0-a212-4a90-afbe-455750e8792e",
"Section": {
"FormTypeSectionId": "755ad0c1-6f83-44a1-b7f8-e9468492dc90",
"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": "987232eb-f568-4777-883d-8d3f7909438f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0723d650-ba2f-4092-8665-398945942fdc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0fe70c07-2f00-4263-b3b2-fd12d8bff96a",
"CreateDate": "2026-03-09T15:14:14.6621526-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T15:14:14.6621526-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "08264f19-6429-4092-a189-8ef2773de6cb",
"FieldId": "4d2afd2b-6d43-48da-86ac-7bb78b9b7ebe",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "08264f19-6429-4092-a189-8ef2773de6cb",
"FieldId": "4d2afd2b-6d43-48da-86ac-7bb78b9b7ebe",
"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": "e03007e0-a212-4a90-afbe-455750e8792e",
"Section": {
"FormTypeSectionId": "755ad0c1-6f83-44a1-b7f8-e9468492dc90",
"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": "987232eb-f568-4777-883d-8d3f7909438f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0723d650-ba2f-4092-8665-398945942fdc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0fe70c07-2f00-4263-b3b2-fd12d8bff96a",
"CreateDate": "2026-03-09T15:14:14.6621526-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T15:14:14.6621526-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "08264f19-6429-4092-a189-8ef2773de6cb",
"FieldId": "4d2afd2b-6d43-48da-86ac-7bb78b9b7ebe",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "08264f19-6429-4092-a189-8ef2773de6cb",
"FieldId": "4d2afd2b-6d43-48da-86ac-7bb78b9b7ebe",
"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": "5d08d7c4-c1b4-4676-8fe2-dc054067d544",
"CreateDate": "2026-03-09T15:14:14.6621526-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T15:14:14.6621526-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"
}