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": "5dab7c9c-ab05-4a57-a6dd-cc5ab82fb75d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3454c2b4-b0b3-4da5-8e6b-aa03a2858624",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "62738a52-4d94-4db3-a557-0b07483725d9",
"CreateDate": "2026-08-09T23:42:24.9393812-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:42:24.9393812-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-09T23:42:24.9393812-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e45ffbab-c6bf-4a42-acc3-ce0682ba3a9c",
"Section": {
"FormTypeSectionId": "4a4a6278-5afe-4f73-a5f7-614787ac9a74",
"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": "d6c71452-7562-4a45-92d6-a8ff7f81d470",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "43ca5c6f-c972-46c9-92b6-d882bb1d1225",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5d05b4d7-ce06-4536-8e96-5094903bc879",
"CreateDate": "2026-08-09T23:42:24.9393812-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:42:24.9393812-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1052b029-d4c6-4ef9-8d9d-6c752588d532",
"FieldId": "d540643d-53e3-46ae-b68c-33f08436d6a7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1052b029-d4c6-4ef9-8d9d-6c752588d532",
"FieldId": "d540643d-53e3-46ae-b68c-33f08436d6a7",
"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": "e45ffbab-c6bf-4a42-acc3-ce0682ba3a9c",
"Section": {
"FormTypeSectionId": "4a4a6278-5afe-4f73-a5f7-614787ac9a74",
"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": "d6c71452-7562-4a45-92d6-a8ff7f81d470",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "43ca5c6f-c972-46c9-92b6-d882bb1d1225",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5d05b4d7-ce06-4536-8e96-5094903bc879",
"CreateDate": "2026-08-09T23:42:24.9393812-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:42:24.9393812-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "1052b029-d4c6-4ef9-8d9d-6c752588d532",
"FieldId": "d540643d-53e3-46ae-b68c-33f08436d6a7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "1052b029-d4c6-4ef9-8d9d-6c752588d532",
"FieldId": "d540643d-53e3-46ae-b68c-33f08436d6a7",
"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": "af7bdd98-b680-462b-8e7c-45e73c2e6395",
"CreateDate": "2026-08-09T23:42:24.9393812-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:42:24.9393812-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"
}