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": "2c2e19bb-c38f-44e2-9f71-059e2487abdd", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f4feca4e-14c8-4f46-a8aa-1ce5cb787ae3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a938635a-43f8-4e27-a6b0-681ada431903", "CreateDate": "2025-06-02T14:49:19.2189235-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:49:19.2189235-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T14:49:19.2189235-07:00", "Fields": [ { "FormTypeFieldId": "4a271001-f461-4e90-ae77-946df397ff0a", "Section": { "FormTypeSectionId": "3f9ccffe-41e2-4704-9c0b-1f9cbd6d6855", "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": "16db76e8-8682-4608-9ee3-d194ecd9912e", "Name": "sample string 1" }, "Unit": { "UnitId": "193a4572-2b19-4c25-97a6-3a58192baa10", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6364c1c7-8fc9-484d-9cc2-16a04fc6fcda", "CreateDate": "2025-06-02T14:49:19.2189235-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:49:19.2189235-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "d6bf6979-1912-4483-ad1a-2eb3276f8646", "FieldId": "8db6cef2-2911-4ef6-b22d-a9a4fc4890b7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "d6bf6979-1912-4483-ad1a-2eb3276f8646", "FieldId": "8db6cef2-2911-4ef6-b22d-a9a4fc4890b7", "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": "4a271001-f461-4e90-ae77-946df397ff0a", "Section": { "FormTypeSectionId": "3f9ccffe-41e2-4704-9c0b-1f9cbd6d6855", "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": "16db76e8-8682-4608-9ee3-d194ecd9912e", "Name": "sample string 1" }, "Unit": { "UnitId": "193a4572-2b19-4c25-97a6-3a58192baa10", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6364c1c7-8fc9-484d-9cc2-16a04fc6fcda", "CreateDate": "2025-06-02T14:49:19.2189235-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:49:19.2189235-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "d6bf6979-1912-4483-ad1a-2eb3276f8646", "FieldId": "8db6cef2-2911-4ef6-b22d-a9a4fc4890b7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "d6bf6979-1912-4483-ad1a-2eb3276f8646", "FieldId": "8db6cef2-2911-4ef6-b22d-a9a4fc4890b7", "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": "a3739a10-431d-4dc0-9427-f04d79eb0f62", "CreateDate": "2025-06-02T14:49:19.2189235-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:49:19.2189235-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" }