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": "91ceaf01-c1e1-43aa-9bbd-3aeaae6fd245", "Asset": { "AssetId": "74f9cd38-a8d9-420d-bc77-5acc13266550", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ac6c1bde-0115-47cb-86bb-5cc58891d016", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c44054d1-5570-4d17-bd46-6a5a16ea37a3", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T19:05:23.605766-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "439dcf56-8553-440a-bd89-1be0e1564085", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-19T19:05:23.605766-07:00", "MeasurementValueNeededDate": "2024-04-19T19:05:23.605766-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6570c764-7ba7-489e-a80e-74c7284e5da2", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-19T19:05:23.605766-07:00", "MeasurementValueNeededDate": "2024-04-19T19:05:23.605766-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b7556a18-2637-49f1-be69-8fb7e97ba525", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T19:05:23.605766-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "254260f5-6325-4490-b514-97892a2d0e56", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ac6c1bde-0115-47cb-86bb-5cc58891d016", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c44054d1-5570-4d17-bd46-6a5a16ea37a3", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T19:05:23.605766-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-19T19:05:23.605766-07:00", "Fields": [ { "FormTypeFieldId": "5d78bdb4-3990-4997-af68-4d993b8bd12b", "Section": { "FormTypeSectionId": "b381f96b-45a4-45a1-aa5a-b7988e5ef681", "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": "51360531-70ce-4de7-b0d4-6f0a8c59d32f", "Name": "sample string 1" }, "Unit": { "UnitId": "5a1bd6ca-d125-409d-b64e-23641496d02e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fd05b64-49c5-401b-b6c8-9b05e6c7b777", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-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": "5d78bdb4-3990-4997-af68-4d993b8bd12b", "Section": { "FormTypeSectionId": "b381f96b-45a4-45a1-aa5a-b7988e5ef681", "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": "51360531-70ce-4de7-b0d4-6f0a8c59d32f", "Name": "sample string 1" }, "Unit": { "UnitId": "5a1bd6ca-d125-409d-b64e-23641496d02e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fd05b64-49c5-401b-b6c8-9b05e6c7b777", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-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": "391ca836-a4e5-4a51-b97b-a787f4b9618c", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-19T19:05:23.605766-07:00", "Location": "sample string 1", "TaskId": "8e19b2df-6b82-4f14-b229-940f99fb0272", "Values": [ { "FormFieldValueId": "17679002-e474-4ea4-affb-7320245586c1", "FormTypeField": { "FormTypeFieldId": "5d78bdb4-3990-4997-af68-4d993b8bd12b", "Section": { "FormTypeSectionId": "b381f96b-45a4-45a1-aa5a-b7988e5ef681", "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": "51360531-70ce-4de7-b0d4-6f0a8c59d32f", "Name": "sample string 1" }, "Unit": { "UnitId": "5a1bd6ca-d125-409d-b64e-23641496d02e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fd05b64-49c5-401b-b6c8-9b05e6c7b777", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-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" }, "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": "17679002-e474-4ea4-affb-7320245586c1", "FormTypeField": { "FormTypeFieldId": "5d78bdb4-3990-4997-af68-4d993b8bd12b", "Section": { "FormTypeSectionId": "b381f96b-45a4-45a1-aa5a-b7988e5ef681", "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": "51360531-70ce-4de7-b0d4-6f0a8c59d32f", "Name": "sample string 1" }, "Unit": { "UnitId": "5a1bd6ca-d125-409d-b64e-23641496d02e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fd05b64-49c5-401b-b6c8-9b05e6c7b777", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T19:05:23.605766-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" }, "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": "c1364854-b8d8-4184-b968-19645c15555a", "CreateDate": "2024-04-19T19:05:23.605766-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-19T19:05:23.605766-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" }