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. |
|
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": "9a98c9ab-d4ca-4745-8280-16ea8c62f813", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b42e9dbb-409e-4c21-a91a-dab4c7fd13da", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6a87933c-a650-42c0-b604-373f2569af02", "CreateDate": "2024-12-08T04:04:29.6995665-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T04:04:29.6995665-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-08T04:04:29.6995665-08:00", "Fields": [ { "FormTypeFieldId": "1dd627b3-fdff-484e-bbd6-8f23fd3fc19a", "Section": { "FormTypeSectionId": "1b1f908a-4c9b-4e26-bbe4-c141cd47acc2", "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": "79734272-708a-4b8c-bf5f-a9fd94f6f7c0", "Name": "sample string 1" }, "Unit": { "UnitId": "46f75d03-9fad-47ec-bb8c-2f2171eb8d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d69a757a-7079-436f-bb1c-a8a2f5835cbe", "CreateDate": "2024-12-08T04:04:29.6995665-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T04:04:29.6995665-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "641d78d7-3deb-40b1-aa48-5696fcb45bb6", "FieldId": "1e6ba5ea-702c-4d80-97f7-72ddaa5a35bc", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "641d78d7-3deb-40b1-aa48-5696fcb45bb6", "FieldId": "1e6ba5ea-702c-4d80-97f7-72ddaa5a35bc", "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": "1dd627b3-fdff-484e-bbd6-8f23fd3fc19a", "Section": { "FormTypeSectionId": "1b1f908a-4c9b-4e26-bbe4-c141cd47acc2", "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": "79734272-708a-4b8c-bf5f-a9fd94f6f7c0", "Name": "sample string 1" }, "Unit": { "UnitId": "46f75d03-9fad-47ec-bb8c-2f2171eb8d49", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d69a757a-7079-436f-bb1c-a8a2f5835cbe", "CreateDate": "2024-12-08T04:04:29.6995665-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T04:04:29.6995665-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "641d78d7-3deb-40b1-aa48-5696fcb45bb6", "FieldId": "1e6ba5ea-702c-4d80-97f7-72ddaa5a35bc", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "641d78d7-3deb-40b1-aa48-5696fcb45bb6", "FieldId": "1e6ba5ea-702c-4d80-97f7-72ddaa5a35bc", "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 3", "CompanyId": "ccd05bfc-448d-4faa-bfbe-ceead40d8095", "CreateDate": "2024-12-08T04:04:29.6995665-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T04:04:29.6995665-08:00", "LastModifiedUser": "sample string 6" }
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" }