DELETE Forms
Deletes the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to delete.
FormName | Description | Type | Additional information |
---|---|---|---|
FormId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
FormType | FormType |
None. |
|
EffectiveDate | date |
None. |
|
Location | string |
None. |
|
TaskId | globally unique identifier |
None. |
|
Values | Collection of FormFieldValue |
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:
{ "FormId": "c2ca4221-59d2-4f1c-81e6-fd2dc954ee30", "Asset": { "AssetId": "42acd318-43b3-4e14-ac12-722ad4c2e1e0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5d9db8ea-ffd3-4a14-a939-2e6f64fbd198", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59415a48-d9a9-475b-baa0-cd1c73b39434", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "f72ecf72-ff6e-42f9-811d-570ba4f00e6a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "MeasurementValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e0e0197e-75b1-436d-80b1-f13f71788e7e", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "MeasurementValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8f95feb7-489e-476d-8c2d-8fa848246664", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b15291ed-604e-4dc2-906d-312a5629435b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5d9db8ea-ffd3-4a14-a939-2e6f64fbd198", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59415a48-d9a9-475b-baa0-cd1c73b39434", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "Fields": [ { "FormTypeFieldId": "d59066bf-d51f-4b50-adad-b0017701253d", "Section": { "FormTypeSectionId": "a838f1ec-2b47-4753-970f-5ef798a6dab1", "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": "e242b9f2-76cf-4427-858b-8a7064c0f7fa", "Name": "sample string 1" }, "Unit": { "UnitId": "a8f9ce53-b8bc-4f4e-9b8e-8768e8280c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb6d08bd-c91e-400e-955d-53bdb9e22569", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "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": "d59066bf-d51f-4b50-adad-b0017701253d", "Section": { "FormTypeSectionId": "a838f1ec-2b47-4753-970f-5ef798a6dab1", "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": "e242b9f2-76cf-4427-858b-8a7064c0f7fa", "Name": "sample string 1" }, "Unit": { "UnitId": "a8f9ce53-b8bc-4f4e-9b8e-8768e8280c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb6d08bd-c91e-400e-955d-53bdb9e22569", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "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": "39cd8a17-52b1-441d-813c-876beda89b8e", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-24T14:19:59.6389723-07:00", "Location": "sample string 1", "TaskId": "e540c763-e57a-4f99-8814-3a1332537b20", "Values": [ { "FormFieldValueId": "d74b7811-785a-4c36-998f-cb7ab43e264c", "FormId": "4301d011-3f0b-4577-a039-daa7c1b20ed4", "FormTypeField": { "FormTypeFieldId": "d59066bf-d51f-4b50-adad-b0017701253d", "FormType": { "FormTypeId": "b15291ed-604e-4dc2-906d-312a5629435b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5d9db8ea-ffd3-4a14-a939-2e6f64fbd198", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59415a48-d9a9-475b-baa0-cd1c73b39434", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "39cd8a17-52b1-441d-813c-876beda89b8e", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "a838f1ec-2b47-4753-970f-5ef798a6dab1", "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": "e242b9f2-76cf-4427-858b-8a7064c0f7fa", "Name": "sample string 1" }, "Unit": { "UnitId": "a8f9ce53-b8bc-4f4e-9b8e-8768e8280c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb6d08bd-c91e-400e-955d-53bdb9e22569", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "d74b7811-785a-4c36-998f-cb7ab43e264c", "FormId": "4301d011-3f0b-4577-a039-daa7c1b20ed4", "FormTypeField": { "FormTypeFieldId": "d59066bf-d51f-4b50-adad-b0017701253d", "FormType": { "FormTypeId": "b15291ed-604e-4dc2-906d-312a5629435b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5d9db8ea-ffd3-4a14-a939-2e6f64fbd198", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "59415a48-d9a9-475b-baa0-cd1c73b39434", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T14:19:59.6389723-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "39cd8a17-52b1-441d-813c-876beda89b8e", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "a838f1ec-2b47-4753-970f-5ef798a6dab1", "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": "e242b9f2-76cf-4427-858b-8a7064c0f7fa", "Name": "sample string 1" }, "Unit": { "UnitId": "a8f9ce53-b8bc-4f4e-9b8e-8768e8280c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cb6d08bd-c91e-400e-955d-53bdb9e22569", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cdb79653-0474-496f-9b13-99507b2ebcd1", "FieldId": "2bdb55c8-47e0-4a28-ac09-08177a936fe7", "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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "73e85c22-4ba2-4c77-8278-55900ccb91de", "CreateDate": "2025-04-24T14:19:59.6389723-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-24T14:19:59.6389723-07:00", "LastModifiedUser": "sample string 5" }
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" }