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": "561b83fd-180b-47f8-8d22-88516702f51e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b352481a-f7d7-4ebe-8207-f15b2b88a608",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e62d5751-76e0-4802-8c3c-5a6a6e7a7a8b",
"CreateDate": "2026-10-08T15:18:32.9992534-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-08T15:18:32.9992534-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-08T15:18:32.9992534-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "282ca02f-254d-4876-91d8-5446b9b612b1",
"Section": {
"FormTypeSectionId": "44f15ea9-057d-46fd-8cf1-0602955edd19",
"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": "d81d59c0-7cb6-49cb-be9a-6d6df4c9c281",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fea9c25d-52b3-4b09-b3cb-416977149a8f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2f9f4891-99f4-4bc4-bae8-677cfac383c8",
"CreateDate": "2026-10-08T15:18:32.9992534-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-08T15:18:32.9992534-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "703739f2-6fae-4a68-b85e-7d874e490376",
"FieldId": "964e9c8c-cb13-4c65-be78-9e95f82b1374",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "703739f2-6fae-4a68-b85e-7d874e490376",
"FieldId": "964e9c8c-cb13-4c65-be78-9e95f82b1374",
"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": "282ca02f-254d-4876-91d8-5446b9b612b1",
"Section": {
"FormTypeSectionId": "44f15ea9-057d-46fd-8cf1-0602955edd19",
"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": "d81d59c0-7cb6-49cb-be9a-6d6df4c9c281",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fea9c25d-52b3-4b09-b3cb-416977149a8f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2f9f4891-99f4-4bc4-bae8-677cfac383c8",
"CreateDate": "2026-10-08T15:18:32.9992534-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-08T15:18:32.9992534-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "703739f2-6fae-4a68-b85e-7d874e490376",
"FieldId": "964e9c8c-cb13-4c65-be78-9e95f82b1374",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "703739f2-6fae-4a68-b85e-7d874e490376",
"FieldId": "964e9c8c-cb13-4c65-be78-9e95f82b1374",
"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": "e884ddb6-5307-46be-8bf2-5bb21061a678",
"CreateDate": "2026-10-08T15:18:33.0148712-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-08T15:18:33.0148712-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"
}