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": "a64df171-6f13-41cd-9b63-59b29ee5c743", "Asset": { "AssetId": "c7343a7d-1503-44a6-b50a-d5f88a30460e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "be3ea87d-95c0-4d34-a727-718672766642", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "26f8a8a8-4792-4bfa-afdb-432d1df114a4", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "13d9fb89-d7dd-4fdb-82bc-b87a9cad2ab9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T19:06:16.9307635-08:00", "MeasurementValueNeededDate": "2024-12-21T19:06:16.9307635-08:00", "SourceSystemId": "sample string 3", "CompanyId": "063d607b-8b6d-4718-8eec-22fbc6ad7a1c", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-21T19:06:16.9307635-08:00", "MeasurementValueNeededDate": "2024-12-21T19:06:16.9307635-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "02eb38cc-5732-4b4d-b19d-8b84527f139d", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "8cb88029-46e9-4587-88a4-2cf798cfddcf", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "be3ea87d-95c0-4d34-a727-718672766642", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "26f8a8a8-4792-4bfa-afdb-432d1df114a4", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T19:06:16.9307635-08:00", "Fields": [ { "FormTypeFieldId": "6670bdd0-0eb1-489c-a624-2e95847cfd59", "Section": { "FormTypeSectionId": "fcb90106-43c8-42d2-9498-f52345233525", "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": "81c86bfa-629d-4d27-88c6-ec5d660f2611", "Name": "sample string 1" }, "Unit": { "UnitId": "f5ced962-39b6-45a3-b1a5-c271e1b3731c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "15328e32-30ac-4840-a39a-4f3a733ecb40", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08: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": "6670bdd0-0eb1-489c-a624-2e95847cfd59", "Section": { "FormTypeSectionId": "fcb90106-43c8-42d2-9498-f52345233525", "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": "81c86bfa-629d-4d27-88c6-ec5d660f2611", "Name": "sample string 1" }, "Unit": { "UnitId": "f5ced962-39b6-45a3-b1a5-c271e1b3731c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "15328e32-30ac-4840-a39a-4f3a733ecb40", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08: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": "0e696e67-d535-47ad-90cd-f34a75ee6bb7", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-12-21T19:06:16.9307635-08:00", "Location": "sample string 1", "TaskId": "a2445a0e-7a00-4cd5-8ea3-17cbc684725a", "Values": [ { "FormFieldValueId": "672c976c-735a-4672-a91d-90e25057006f", "FormTypeField": { "FormTypeFieldId": "6670bdd0-0eb1-489c-a624-2e95847cfd59", "Section": { "FormTypeSectionId": "fcb90106-43c8-42d2-9498-f52345233525", "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": "81c86bfa-629d-4d27-88c6-ec5d660f2611", "Name": "sample string 1" }, "Unit": { "UnitId": "f5ced962-39b6-45a3-b1a5-c271e1b3731c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "15328e32-30ac-4840-a39a-4f3a733ecb40", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08: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": "672c976c-735a-4672-a91d-90e25057006f", "FormTypeField": { "FormTypeFieldId": "6670bdd0-0eb1-489c-a624-2e95847cfd59", "Section": { "FormTypeSectionId": "fcb90106-43c8-42d2-9498-f52345233525", "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": "81c86bfa-629d-4d27-88c6-ec5d660f2611", "Name": "sample string 1" }, "Unit": { "UnitId": "f5ced962-39b6-45a3-b1a5-c271e1b3731c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "15328e32-30ac-4840-a39a-4f3a733ecb40", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08: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": "1277dac9-c2c7-437f-9f59-118e39309f8c", "CreateDate": "2024-12-21T19:06:16.9307635-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-21T19:06:16.9307635-08: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" }