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": "a1fb7d89-e5e6-4f50-941c-b585a1d8d29b", "Asset": { "AssetId": "2e88cac3-22e6-46de-b13f-2296336ce38d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4afa77aa-c5f8-4b4e-86c3-bff7105514f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a7978d2-4eef-496a-bbc0-c19d97c72d0e", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "8a3b5e03-0e5d-4ef7-a558-6b3d4e4c23de", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "MeasurementValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e68dc291-afad-41f9-a86b-2b684d0e059a", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "MeasurementValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "494dfc3f-a96c-411a-b405-db69e2939b73", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "cdb1da15-be02-4898-96d1-8f75b03d3d61", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "4afa77aa-c5f8-4b4e-86c3-bff7105514f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a7978d2-4eef-496a-bbc0-c19d97c72d0e", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "Fields": [ { "FormTypeFieldId": "071f0383-225c-467f-8588-dd4efd500031", "Section": { "FormTypeSectionId": "c13ba996-8919-496a-b647-bcdec7cfadfd", "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": "ba7a786b-60b3-45f6-b881-5291263eddb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bf63995e-a74a-4680-82a8-ba955ca1eb1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9cd136fe-af72-4c94-adb7-718a30ec8399", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "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": "071f0383-225c-467f-8588-dd4efd500031", "Section": { "FormTypeSectionId": "c13ba996-8919-496a-b647-bcdec7cfadfd", "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": "ba7a786b-60b3-45f6-b881-5291263eddb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bf63995e-a74a-4680-82a8-ba955ca1eb1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9cd136fe-af72-4c94-adb7-718a30ec8399", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "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": "4352cbc2-0b28-4914-a2d7-89ad78967cbd", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-30T14:44:04.299563-07:00", "Location": "sample string 1", "TaskId": "a4d62b42-6855-425b-9d74-f97e6199430c", "Values": [ { "FormFieldValueId": "d5636cb6-9c84-4816-b2d6-723d30a38a3b", "FormId": "d70d57d4-d9b8-4e3c-a730-741416267a5c", "FormTypeField": { "FormTypeFieldId": "071f0383-225c-467f-8588-dd4efd500031", "FormType": { "FormTypeId": "cdb1da15-be02-4898-96d1-8f75b03d3d61", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "4afa77aa-c5f8-4b4e-86c3-bff7105514f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a7978d2-4eef-496a-bbc0-c19d97c72d0e", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "4352cbc2-0b28-4914-a2d7-89ad78967cbd", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "c13ba996-8919-496a-b647-bcdec7cfadfd", "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": "ba7a786b-60b3-45f6-b881-5291263eddb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bf63995e-a74a-4680-82a8-ba955ca1eb1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9cd136fe-af72-4c94-adb7-718a30ec8399", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "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": "d5636cb6-9c84-4816-b2d6-723d30a38a3b", "FormId": "d70d57d4-d9b8-4e3c-a730-741416267a5c", "FormTypeField": { "FormTypeFieldId": "071f0383-225c-467f-8588-dd4efd500031", "FormType": { "FormTypeId": "cdb1da15-be02-4898-96d1-8f75b03d3d61", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "4afa77aa-c5f8-4b4e-86c3-bff7105514f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a7978d2-4eef-496a-bbc0-c19d97c72d0e", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-30T14:44:04.299563-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "4352cbc2-0b28-4914-a2d7-89ad78967cbd", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "c13ba996-8919-496a-b647-bcdec7cfadfd", "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": "ba7a786b-60b3-45f6-b881-5291263eddb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bf63995e-a74a-4680-82a8-ba955ca1eb1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9cd136fe-af72-4c94-adb7-718a30ec8399", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-30T14:44:04.299563-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b8686f26-be5c-4961-87ea-5ff7ec624189", "FieldId": "b3e90890-87d5-400a-897a-bf9c7c15f4bf", "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": "bff62ca7-b176-4ce6-b4d4-51dbd027c6c6", "CreateDate": "2025-04-30T14:44:04.299563-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-30T14:44:04.299563-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" }