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": "809693cb-7356-49ba-9197-2ffa4074d511", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a9f97b97-90ed-4ba6-a6a8-6a6012615514", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef93f134-76d8-4814-a134-d8e0731df7cd", "CreateDate": "2024-04-28T04:29:40.4512534-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T04:29:40.4512534-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T04:29:40.4512534-07:00", "Fields": [ { "FormTypeFieldId": "66487daa-ab11-4880-8638-c5c9c2d14ac9", "Section": { "FormTypeSectionId": "710357da-0b23-4703-8eed-623e3694a471", "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": "eda2b517-1fd6-493e-8b9c-5785b21f293d", "Name": "sample string 1" }, "Unit": { "UnitId": "393b0ad3-b76a-402f-8db9-ee32db576f10", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "be1e54c1-26fd-4456-8e9e-55a1be406783", "CreateDate": "2024-04-28T04:29:40.4512534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:40.4512534-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "66487daa-ab11-4880-8638-c5c9c2d14ac9", "Section": { "FormTypeSectionId": "710357da-0b23-4703-8eed-623e3694a471", "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": "eda2b517-1fd6-493e-8b9c-5785b21f293d", "Name": "sample string 1" }, "Unit": { "UnitId": "393b0ad3-b76a-402f-8db9-ee32db576f10", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "be1e54c1-26fd-4456-8e9e-55a1be406783", "CreateDate": "2024-04-28T04:29:40.4512534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:40.4512534-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "0fa9460c-7b92-4e77-a38d-396998765903", "CreateDate": "2024-04-28T04:29:40.4512534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T04:29:40.4512534-07: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" }