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": "43b85203-70ef-46a7-8e58-dbb57c618435", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c00439d6-50f0-4489-ad64-86413e239bda", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "daa1d779-a7cb-48b4-b5df-6c861fb808e3", "CreateDate": "2025-07-02T16:51:32.4403603-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T16:51:32.4403603-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-02T16:51:32.4403603-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "c079a78d-cd16-43bc-9cd6-a60618a9bee5", "Section": { "FormTypeSectionId": "b7a2cfe0-930c-4f84-81b0-e2bd7e6462a4", "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": "ac94e4e7-af52-4922-99f7-03d42205afe3", "Name": "sample string 1" }, "Unit": { "UnitId": "82d7eb1f-c940-4c4b-bf24-91853b81f307", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ff9274c4-c370-4a47-b0cf-1230c22feec8", "CreateDate": "2025-07-02T16:51:32.4403603-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T16:51:32.4403603-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1bcdac97-e95d-457e-b700-cabc4c536d52", "FieldId": "9f459421-46aa-4c05-8161-dc4e75ee9c44", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1bcdac97-e95d-457e-b700-cabc4c536d52", "FieldId": "9f459421-46aa-4c05-8161-dc4e75ee9c44", "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": "c079a78d-cd16-43bc-9cd6-a60618a9bee5", "Section": { "FormTypeSectionId": "b7a2cfe0-930c-4f84-81b0-e2bd7e6462a4", "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": "ac94e4e7-af52-4922-99f7-03d42205afe3", "Name": "sample string 1" }, "Unit": { "UnitId": "82d7eb1f-c940-4c4b-bf24-91853b81f307", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ff9274c4-c370-4a47-b0cf-1230c22feec8", "CreateDate": "2025-07-02T16:51:32.4403603-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T16:51:32.4403603-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1bcdac97-e95d-457e-b700-cabc4c536d52", "FieldId": "9f459421-46aa-4c05-8161-dc4e75ee9c44", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1bcdac97-e95d-457e-b700-cabc4c536d52", "FieldId": "9f459421-46aa-4c05-8161-dc4e75ee9c44", "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": "f939ae6f-400e-403b-b0da-19f9d505a404", "CreateDate": "2025-07-02T16:51:32.4403603-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T16:51:32.4403603-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" }