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": "dffcb946-0be6-4431-ab43-b1415097fe9d", "Asset": { "AssetId": "a5928ee3-59cc-471e-91fb-24efff0050bf", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "bce271bc-b3a6-4033-b4d9-6fe5dd120f9b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9be314b7-48d8-4359-94ad-750537222d8e", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:01:21.735702-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "bba79670-f400-42fe-bf89-2930c1d60f67", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T18:01:21.735702-07:00", "MeasurementValueNeededDate": "2025-07-31T18:01:21.735702-07:00", "SourceSystemId": "sample string 3", "CompanyId": "04994b47-1307-4910-9cc1-d3ad87236c6f", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T18:01:21.735702-07:00", "MeasurementValueNeededDate": "2025-07-31T18:01:21.735702-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d30ba73e-6dbd-413b-9ba9-057cf393095a", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T18:01:21.735702-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "9fbfee66-5760-40e1-8e48-f3b9db13d22a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bce271bc-b3a6-4033-b4d9-6fe5dd120f9b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9be314b7-48d8-4359-94ad-750537222d8e", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T18:01:21.735702-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T18:01:21.735702-07:00", "Fields": [ { "FormTypeFieldId": "e7f6ef3f-4841-4947-a8e6-632ecaa27727", "Section": { "FormTypeSectionId": "e08483d5-6498-4ce2-bb9f-39336e131fc7", "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": "61e75ff2-91f0-403c-831f-5ca298652e23", "Name": "sample string 1" }, "Unit": { "UnitId": "5de91845-3441-4e9c-a9fc-418e4a9d41ca", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "137d1c2a-0b35-430a-a384-b96666d39951", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-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": "e7f6ef3f-4841-4947-a8e6-632ecaa27727", "Section": { "FormTypeSectionId": "e08483d5-6498-4ce2-bb9f-39336e131fc7", "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": "61e75ff2-91f0-403c-831f-5ca298652e23", "Name": "sample string 1" }, "Unit": { "UnitId": "5de91845-3441-4e9c-a9fc-418e4a9d41ca", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "137d1c2a-0b35-430a-a384-b96666d39951", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-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": "5a73a956-582a-4614-8dfb-62652bf663ba", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T18:01:21.735702-07:00", "Location": "sample string 1", "TaskId": "ecfccf8e-5122-4fcb-81ca-1a458b8b150d", "Values": [ { "FormFieldValueId": "37c184f5-aad1-49a5-921d-7efcc5194186", "FormTypeField": { "FormTypeFieldId": "e7f6ef3f-4841-4947-a8e6-632ecaa27727", "Section": { "FormTypeSectionId": "e08483d5-6498-4ce2-bb9f-39336e131fc7", "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": "61e75ff2-91f0-403c-831f-5ca298652e23", "Name": "sample string 1" }, "Unit": { "UnitId": "5de91845-3441-4e9c-a9fc-418e4a9d41ca", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "137d1c2a-0b35-430a-a384-b96666d39951", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-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": "37c184f5-aad1-49a5-921d-7efcc5194186", "FormTypeField": { "FormTypeFieldId": "e7f6ef3f-4841-4947-a8e6-632ecaa27727", "Section": { "FormTypeSectionId": "e08483d5-6498-4ce2-bb9f-39336e131fc7", "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": "61e75ff2-91f0-403c-831f-5ca298652e23", "Name": "sample string 1" }, "Unit": { "UnitId": "5de91845-3441-4e9c-a9fc-418e4a9d41ca", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "137d1c2a-0b35-430a-a384-b96666d39951", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T18:01:21.735702-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": "c151ad89-ac0b-4d90-9423-0873105d56c8", "CreateDate": "2025-07-31T18:01:21.735702-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T18:01:21.735702-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" }