DELETE FormTypes
Deletes the given form type, including all forms of that type.
Request Information
URI Parameters
None.
Body Parameters
Form type to delete
FormTypeName | 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": "f78ce669-ce65-452a-aead-af90e44b046a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "beeb0aab-9ffa-4ab7-ad1a-2dbfddb38612", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5a4b8f32-b6a9-40ec-b5e1-fc115a28f721", "CreateDate": "2025-09-17T13:18:36.4708508-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T13:18:36.4708508-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-17T13:18:36.4708508-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "0ca14b46-8e6f-4540-ad56-8083d840a84a", "Section": { "FormTypeSectionId": "11f5d5a2-68a9-4b6f-9bb7-24867c67d64c", "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": "10caac60-ca87-4425-a246-071e24b8cd13", "Name": "sample string 1" }, "Unit": { "UnitId": "7dbd96fc-7e6d-4da6-abf1-c634c159f318", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "afe49a57-43fc-4ea3-8497-82a103107b17", "CreateDate": "2025-09-17T13:18:36.4708508-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-17T13:18:36.4708508-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "455d5588-3f94-4e07-8673-473582a7ad99", "FieldId": "9a674ca5-76e6-428b-b888-00f3a4e74440", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "455d5588-3f94-4e07-8673-473582a7ad99", "FieldId": "9a674ca5-76e6-428b-b888-00f3a4e74440", "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": "0ca14b46-8e6f-4540-ad56-8083d840a84a", "Section": { "FormTypeSectionId": "11f5d5a2-68a9-4b6f-9bb7-24867c67d64c", "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": "10caac60-ca87-4425-a246-071e24b8cd13", "Name": "sample string 1" }, "Unit": { "UnitId": "7dbd96fc-7e6d-4da6-abf1-c634c159f318", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "afe49a57-43fc-4ea3-8497-82a103107b17", "CreateDate": "2025-09-17T13:18:36.4708508-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-17T13:18:36.4708508-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "455d5588-3f94-4e07-8673-473582a7ad99", "FieldId": "9a674ca5-76e6-428b-b888-00f3a4e74440", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "455d5588-3f94-4e07-8673-473582a7ad99", "FieldId": "9a674ca5-76e6-428b-b888-00f3a4e74440", "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": "529ff54e-b925-42ca-803d-9a53c03ffc96", "CreateDate": "2025-09-17T13:18:36.4708508-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-17T13:18:36.4708508-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" }