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": "6263087f-5171-44d0-a934-8176065ec47f", "Asset": { "AssetId": "188072fd-c81e-4862-9ee6-ddb957eab613", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "500d79b7-2719-46eb-82c4-81ffbf1dea73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "492cd263-66b4-4c57-a869-89d9331637cb", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "792d56d4-022d-4d8b-8757-ab94ca553087", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "SourceSystemId": "sample string 3", "CompanyId": "58c8682a-a172-43da-8d2c-1071bacbacc4", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "MeasurementValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7a3f48d9-cec5-4787-aa21-bdb3e907b6bb", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "19d2e223-2e17-4566-9756-cab424432342", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "500d79b7-2719-46eb-82c4-81ffbf1dea73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "492cd263-66b4-4c57-a869-89d9331637cb", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "24a656ce-221e-431e-9958-2da9fb25c927", "Section": { "FormTypeSectionId": "f8cbca70-3db6-4f70-8a42-efc0fceb5d00", "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": "e150ed7a-1acb-46f1-8a42-bc66493825bd", "Name": "sample string 1" }, "Unit": { "UnitId": "4d11e6a1-203a-46e6-90d7-96f3d679ab86", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9092ccb6-4f56-4ee0-bcd1-d6ca6db61227", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "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": "24a656ce-221e-431e-9958-2da9fb25c927", "Section": { "FormTypeSectionId": "f8cbca70-3db6-4f70-8a42-efc0fceb5d00", "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": "e150ed7a-1acb-46f1-8a42-bc66493825bd", "Name": "sample string 1" }, "Unit": { "UnitId": "4d11e6a1-203a-46e6-90d7-96f3d679ab86", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9092ccb6-4f56-4ee0-bcd1-d6ca6db61227", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "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 4", "CompanyId": "7e0ff6a0-7fa3-414c-8b15-3d04c87aacce", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-08-24T10:11:42.5568618-07:00", "Location": "sample string 1", "TaskId": "4c87cf89-a4ff-454c-8076-d9a60cca4a21", "Values": [ { "FormFieldValueId": "290bb970-cc40-4acc-88b0-182b9724e1ae", "FormId": "8cb00662-ba3c-4bf6-804b-02b0e03e5878", "FormTypeField": { "FormTypeFieldId": "24a656ce-221e-431e-9958-2da9fb25c927", "FormType": { "FormTypeId": "19d2e223-2e17-4566-9756-cab424432342", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "500d79b7-2719-46eb-82c4-81ffbf1dea73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "492cd263-66b4-4c57-a869-89d9331637cb", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "7e0ff6a0-7fa3-414c-8b15-3d04c87aacce", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "f8cbca70-3db6-4f70-8a42-efc0fceb5d00", "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": "e150ed7a-1acb-46f1-8a42-bc66493825bd", "Name": "sample string 1" }, "Unit": { "UnitId": "4d11e6a1-203a-46e6-90d7-96f3d679ab86", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9092ccb6-4f56-4ee0-bcd1-d6ca6db61227", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "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": "290bb970-cc40-4acc-88b0-182b9724e1ae", "FormId": "8cb00662-ba3c-4bf6-804b-02b0e03e5878", "FormTypeField": { "FormTypeFieldId": "24a656ce-221e-431e-9958-2da9fb25c927", "FormType": { "FormTypeId": "19d2e223-2e17-4566-9756-cab424432342", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "500d79b7-2719-46eb-82c4-81ffbf1dea73", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "492cd263-66b4-4c57-a869-89d9331637cb", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T10:11:42.5568618-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "7e0ff6a0-7fa3-414c-8b15-3d04c87aacce", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "f8cbca70-3db6-4f70-8a42-efc0fceb5d00", "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": "e150ed7a-1acb-46f1-8a42-bc66493825bd", "Name": "sample string 1" }, "Unit": { "UnitId": "4d11e6a1-203a-46e6-90d7-96f3d679ab86", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9092ccb6-4f56-4ee0-bcd1-d6ca6db61227", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T10:11:42.5568618-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bac2603a-b069-4d0c-9d24-f9c1fc6a7dac", "FieldId": "2f578c0d-39ef-4b09-aacd-9e167ac83bd3", "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": "7fa6dc70-d33e-4ecd-b141-5a53a84f39ee", "CreateDate": "2025-08-24T10:11:42.5568618-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-24T10:11:42.5568618-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" }