DELETE Forms

Back to endpoints

DELETE Forms

Deletes the given form.

Request Information

URI Parameters

None.

Body Parameters

The form to delete.

Form

Name	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": "6a8b8e0a-d749-442e-b905-692740432373",
  "Asset": {
    "AssetId": "3fb5e670-482a-4f97-b3ef-1e187263cf5a",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "b2f38fdf-9c26-47cb-bf38-755b0a832cb4",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayColor": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "aa164146-8e24-42de-a57e-7515b485c47b",
      "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
      "LastModifiedUser": "sample string 7"
    },
    "AssetGroup": {
      "AssetGroupId": "8c4d4518-4a2b-4806-a6a3-7a28bfc6a36d",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2025-02-05T07:57:12.5994229-08:00",
      "MeasurementValueNeededDate": "2025-02-05T07:57:12.5994229-08:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "522946be-e7a9-4b31-ae85-25d7d83fc7f6",
      "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "FormValueNeededDate": "2025-02-05T07:57:12.5994229-08:00",
    "MeasurementValueNeededDate": "2025-02-05T07:57:12.5994229-08:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "78b2dc46-d85e-446e-ab92-15ae4c6ea7f4",
    "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "FormType": {
    "FormTypeId": "52eb8cc9-252b-4567-8b3e-50976cd7c128",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "b2f38fdf-9c26-47cb-bf38-755b0a832cb4",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayColor": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "aa164146-8e24-42de-a57e-7515b485c47b",
      "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
      "LastModifiedUser": "sample string 7"
    },
    "FrequencyNeeded": 1,
    "ValueNeededDate": "2025-02-05T07:57:12.5994229-08:00",
    "Fields": [
      {
        "FormTypeFieldId": "126bdf7d-d004-4734-9309-7ce02b0abb82",
        "Section": {
          "FormTypeSectionId": "d44b22a8-e5d6-47c6-b785-761019ea5653",
          "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": "f301bc41-89d1-4279-a238-c00c673c98fa",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "0d0e8d4e-5d49-4798-b664-29d7fd855679",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "43b1b87a-3b42-4f88-9c33-1d045b7e0afb",
          "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-02-05T07:57:12.5994229-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": "126bdf7d-d004-4734-9309-7ce02b0abb82",
        "Section": {
          "FormTypeSectionId": "d44b22a8-e5d6-47c6-b785-761019ea5653",
          "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": "f301bc41-89d1-4279-a238-c00c673c98fa",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "0d0e8d4e-5d49-4798-b664-29d7fd855679",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "43b1b87a-3b42-4f88-9c33-1d045b7e0afb",
          "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-02-05T07:57:12.5994229-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": "5ee84df4-52da-4251-a99a-54125c1bb4c5",
    "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
    "LastModifiedUser": "sample string 6"
  },
  "EffectiveDate": "2025-02-05T07:57:12.5994229-08:00",
  "Location": "sample string 1",
  "TaskId": "7171dbc6-8dc1-4360-9b37-6105b7b26a90",
  "Values": [
    {
      "FormFieldValueId": "91c74935-15a2-42bf-b39d-51aef2e73987",
      "FormTypeField": {
        "FormTypeFieldId": "126bdf7d-d004-4734-9309-7ce02b0abb82",
        "Section": {
          "FormTypeSectionId": "d44b22a8-e5d6-47c6-b785-761019ea5653",
          "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": "f301bc41-89d1-4279-a238-c00c673c98fa",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "0d0e8d4e-5d49-4798-b664-29d7fd855679",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "43b1b87a-3b42-4f88-9c33-1d045b7e0afb",
          "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-02-05T07:57:12.5994229-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": "91c74935-15a2-42bf-b39d-51aef2e73987",
      "FormTypeField": {
        "FormTypeFieldId": "126bdf7d-d004-4734-9309-7ce02b0abb82",
        "Section": {
          "FormTypeSectionId": "d44b22a8-e5d6-47c6-b785-761019ea5653",
          "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": "f301bc41-89d1-4279-a238-c00c673c98fa",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "0d0e8d4e-5d49-4798-b664-29d7fd855679",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "43b1b87a-3b42-4f88-9c33-1d045b7e0afb",
          "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-02-05T07:57:12.5994229-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": "d46795fb-3897-43c9-affc-00b865f92bee",
  "CreateDate": "2025-02-05T07:57:12.5994229-08:00",
  "CreateUser": "sample string 4",
  "LastModifiedDate": "2025-02-05T07:57:12.5994229-08:00",
  "LastModifiedUser": "sample string 5"
}

Response Information

Resource Description

Name	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"
}