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": "2b58e086-1dbb-4983-bc37-8e5b2a936864", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "eac91579-2ca1-4d4f-bb4a-62d86e36291e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4e9c265a-47e1-4823-a8b4-55ff1e3f73fd", "CreateDate": "2025-06-27T06:49:43.1523814-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T06:49:43.1523814-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-27T06:49:43.1523814-07:00", "Fields": [ { "FormTypeFieldId": "01dc5484-2152-457c-812c-fda6a0d8c0a7", "Section": { "FormTypeSectionId": "a3c1e4bf-b5d2-47b3-9011-00ecbcbbbfd3", "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": "c409b577-417c-4b9f-9849-8a08b2f58fab", "Name": "sample string 1" }, "Unit": { "UnitId": "54df8523-f8c3-46fe-ae4e-70a73710b6d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "824e705b-353f-48c7-99cb-3f12f67f0b4e", "CreateDate": "2025-06-27T06:49:43.1523814-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:49:43.1523814-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bd96298a-12aa-4574-ae21-07d7580b271d", "FieldId": "a1ecd7b0-101a-4c21-8090-58be9d961c2f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bd96298a-12aa-4574-ae21-07d7580b271d", "FieldId": "a1ecd7b0-101a-4c21-8090-58be9d961c2f", "FieldName": "sample string 1", "FieldLable": "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": "01dc5484-2152-457c-812c-fda6a0d8c0a7", "Section": { "FormTypeSectionId": "a3c1e4bf-b5d2-47b3-9011-00ecbcbbbfd3", "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": "c409b577-417c-4b9f-9849-8a08b2f58fab", "Name": "sample string 1" }, "Unit": { "UnitId": "54df8523-f8c3-46fe-ae4e-70a73710b6d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "824e705b-353f-48c7-99cb-3f12f67f0b4e", "CreateDate": "2025-06-27T06:49:43.1523814-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:49:43.1523814-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bd96298a-12aa-4574-ae21-07d7580b271d", "FieldId": "a1ecd7b0-101a-4c21-8090-58be9d961c2f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bd96298a-12aa-4574-ae21-07d7580b271d", "FieldId": "a1ecd7b0-101a-4c21-8090-58be9d961c2f", "FieldName": "sample string 1", "FieldLable": "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": "eeffb941-af26-44a5-80ea-2ae2eddf74a6", "CreateDate": "2025-06-27T06:49:43.1523814-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:49:43.1523814-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" }