DELETE Forms
Deletes the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to delete.
Form| Name | Description | Type | Additional information |
|---|---|---|---|
| FormId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| FormType | FormType |
None. |
|
| EffectiveDate | date |
None. |
|
| WellKnownText | string |
None. |
|
| Values | Collection of FormFieldValue |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| CreateMachine | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
|
| LastModifiedMachine | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FormId": "43d36e75-352d-4419-b41c-db466b11735b",
"Asset": {
"AssetId": "d3251fde-4f22-420b-b16d-834305ec0d03",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "df4a07c3-2caa-4ff3-b2d6-9a48929423f2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "829e7226-2084-441f-8d71-d2731c6c4baa",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "b6e479ae-8fc1-4eb4-9dca-fe7946739663",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T06:25:58.5001046-07:00",
"MeasurementValueNeededDate": "2021-04-17T06:25:58.5001046-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c6a6a723-9972-4f18-9a78-1b6cd22bded8",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T06:25:58.5001046-07:00",
"MeasurementValueNeededDate": "2021-04-17T06:25:58.5001046-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bbaa24e6-14e5-49d2-ac72-bcc259f715d1",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"FormType": {
"FormTypeId": "87fe7790-ce81-4959-8d6c-6b4dc04d2c5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "df4a07c3-2caa-4ff3-b2d6-9a48929423f2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "829e7226-2084-441f-8d71-d2731c6c4baa",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T06:25:58.5001046-07:00",
"Fields": [
{
"FormTypeFieldId": "f69c57b8-fdce-435a-b57b-aa52a14dfe60",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "0cc6ba03-6cad-47ef-97a3-e626c24747eb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9fbc14cf-8076-416b-83e3-fded3d8f4219",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d33a6055-9255-42d0-8a50-a63d58a56d27",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "f69c57b8-fdce-435a-b57b-aa52a14dfe60",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "0cc6ba03-6cad-47ef-97a3-e626c24747eb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9fbc14cf-8076-416b-83e3-fded3d8f4219",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d33a6055-9255-42d0-8a50-a63d58a56d27",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "824fe5ff-c874-46fe-a848-a2ffab25888a",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"EffectiveDate": "2021-04-17T06:25:58.5001046-07:00",
"WellKnownText": "sample string 1",
"Values": [
{
"FormFieldValueId": "66ac7d72-6234-4225-958d-7922a8047497",
"FormTypeField": {
"FormTypeFieldId": "f69c57b8-fdce-435a-b57b-aa52a14dfe60",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "0cc6ba03-6cad-47ef-97a3-e626c24747eb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9fbc14cf-8076-416b-83e3-fded3d8f4219",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d33a6055-9255-42d0-8a50-a63d58a56d27",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "66ac7d72-6234-4225-958d-7922a8047497",
"FormTypeField": {
"FormTypeFieldId": "f69c57b8-fdce-435a-b57b-aa52a14dfe60",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "0cc6ba03-6cad-47ef-97a3-e626c24747eb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9fbc14cf-8076-416b-83e3-fded3d8f4219",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d33a6055-9255-42d0-8a50-a63d58a56d27",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "13e7a504-337e-4c94-a5ff-83d1bbd1478a",
"CreateDate": "2021-04-17T06:25:58.5001046-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T06:25:58.5001046-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
}
Response Information
Resource Description
On success, the deleted form.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Form |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormId": "8762b558-3c01-4aa3-85c3-ff9299b2da9d",
"Asset": {
"AssetId": "061087ad-3be6-48e4-98d8-a4aa5bbf0906",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c8d1ccb5-e63e-47a6-967b-a9f80e4b8dbe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5ea1f00f-0463-4e1e-85c1-028fea346c88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "c14647fb-8ad4-4b4d-8d9f-fc995cc87cdd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T06:25:58.5313713-07:00",
"MeasurementValueNeededDate": "2021-04-17T06:25:58.5313713-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2cfd794-2635-4607-8229-b7db4d4eaa4f",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T06:25:58.5313713-07:00",
"MeasurementValueNeededDate": "2021-04-17T06:25:58.5313713-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0f27c427-98a9-4713-a78b-913d1dfbcbfe",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"FormType": {
"FormTypeId": "8ab00828-1059-4fe7-b67f-d2fec8708732",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c8d1ccb5-e63e-47a6-967b-a9f80e4b8dbe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5ea1f00f-0463-4e1e-85c1-028fea346c88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T06:25:58.5313713-07:00",
"Fields": [
{
"FormTypeFieldId": "98d17903-4704-46ca-bee9-6e35dd4d949a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "414fa6ac-b9f9-4d0f-a71d-ddd13680ff79",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e64cfbe-118f-4258-83fc-2b5be3f997eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "93474657-54f8-4e39-a59e-46cf32f22a88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "98d17903-4704-46ca-bee9-6e35dd4d949a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "414fa6ac-b9f9-4d0f-a71d-ddd13680ff79",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e64cfbe-118f-4258-83fc-2b5be3f997eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "93474657-54f8-4e39-a59e-46cf32f22a88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c5d0d63f-8187-473f-98ed-2663638932f9",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"EffectiveDate": "2021-04-17T06:25:58.5313713-07:00",
"WellKnownText": "sample string 1",
"Values": [
{
"FormFieldValueId": "e2689595-4e0f-41c8-adb2-f8c634da4c67",
"FormTypeField": {
"FormTypeFieldId": "98d17903-4704-46ca-bee9-6e35dd4d949a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "414fa6ac-b9f9-4d0f-a71d-ddd13680ff79",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e64cfbe-118f-4258-83fc-2b5be3f997eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "93474657-54f8-4e39-a59e-46cf32f22a88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "e2689595-4e0f-41c8-adb2-f8c634da4c67",
"FormTypeField": {
"FormTypeFieldId": "98d17903-4704-46ca-bee9-6e35dd4d949a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "414fa6ac-b9f9-4d0f-a71d-ddd13680ff79",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7e64cfbe-118f-4258-83fc-2b5be3f997eb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "93474657-54f8-4e39-a59e-46cf32f22a88",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "eec5ebbc-3228-4968-9e0a-4f7e727c8cd1",
"CreateDate": "2021-04-17T06:25:58.5313713-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T06:25:58.5313713-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}