DELETE FormTypes

Deletes the given form type, including all forms of that type.

Request Information

URI Parameters

None.

Body Parameters

Form type to delete

FormType
NameDescriptionTypeAdditional information
FormTypeId

globally unique identifier

None.

Name

string

None.

Description

string

None.

AssetType

AssetType

None.

FrequencyNeeded

integer

None.

ValueNeededDate

date

None.

Fields

Collection of FormTypeField

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:
{
  "FormTypeId": "c8c07843-a6a6-4a06-ac66-b26f1929c688",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "AssetType": {
    "AssetTypeId": "bc528a4c-246c-4a2b-8026-9666f1b58acb",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayColor": "sample string 3",
    "SourceSystemId": "sample string 4",
    "CompanyId": "3e08cf7f-abaf-4895-8cbb-5884c95ad0aa",
    "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
    "CreateUser": "sample string 6",
    "CreateMachine": "sample string 7",
    "LastModifiedDate": "2021-04-17T06:42:17.8887204-07:00",
    "LastModifiedUser": "sample string 8",
    "LastModifiedMachine": "sample string 9"
  },
  "FrequencyNeeded": 1,
  "ValueNeededDate": "2021-04-17T06:42:17.8887204-07:00",
  "Fields": [
    {
      "FormTypeFieldId": "02b1f838-5657-4a5d-b5f3-31f40e4f039a",
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Description": "sample string 3",
      "DataType": {
        "DataTypeId": "5d521cfb-f69b-4a77-b506-be2903787a17",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "0124adfc-e90e-4603-8280-a1cec7d399c8",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "79efbbf9-2585-45eb-a2e8-cff8562882f2",
        "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
        "CreateUser": "sample string 5",
        "CreateMachine": "sample string 6",
        "LastModifiedDate": "2021-04-17T06:42:17.8887204-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": "02b1f838-5657-4a5d-b5f3-31f40e4f039a",
      "Name": "sample string 1",
      "Label": "sample string 2",
      "Description": "sample string 3",
      "DataType": {
        "DataTypeId": "5d521cfb-f69b-4a77-b506-be2903787a17",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "0124adfc-e90e-4603-8280-a1cec7d399c8",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "79efbbf9-2585-45eb-a2e8-cff8562882f2",
        "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
        "CreateUser": "sample string 5",
        "CreateMachine": "sample string 6",
        "LastModifiedDate": "2021-04-17T06:42:17.8887204-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": "623a13a4-91a9-4f28-a919-862951094356",
  "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
  "CreateUser": "sample string 5",
  "CreateMachine": "sample string 6",
  "LastModifiedDate": "2021-04-17T06:42:17.8887204-07:00",
  "LastModifiedUser": "sample string 7",
  "LastModifiedMachine": "sample string 8"
}

Response Information

Resource Description

On success, the deleted form type.

NameDescriptionTypeAdditional information
Data

FormType

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "FormTypeId": "08782140-bb09-44e9-9473-101605d4caee",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "8d340660-ae49-4452-9427-6aeedc5ffb62",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayColor": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "bb886801-c58f-4499-ba0e-ea4e3b43f333",
      "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
      "CreateUser": "sample string 6",
      "CreateMachine": "sample string 7",
      "LastModifiedDate": "2021-04-17T06:42:17.8887204-07:00",
      "LastModifiedUser": "sample string 8",
      "LastModifiedMachine": "sample string 9"
    },
    "FrequencyNeeded": 1,
    "ValueNeededDate": "2021-04-17T06:42:17.8887204-07:00",
    "Fields": [
      {
        "FormTypeFieldId": "47056f99-18b8-42aa-bf54-0dce1ee69af1",
        "Name": "sample string 1",
        "Label": "sample string 2",
        "Description": "sample string 3",
        "DataType": {
          "DataTypeId": "67526a56-d9fa-4f30-9127-10e29549be28",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "e9722a21-234e-4aa9-a839-3dcc3699f59f",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "8e0c9f91-1625-4697-a967-1d0031be821f",
          "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:42:17.8887204-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": "47056f99-18b8-42aa-bf54-0dce1ee69af1",
        "Name": "sample string 1",
        "Label": "sample string 2",
        "Description": "sample string 3",
        "DataType": {
          "DataTypeId": "67526a56-d9fa-4f30-9127-10e29549be28",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "e9722a21-234e-4aa9-a839-3dcc3699f59f",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "8e0c9f91-1625-4697-a967-1d0031be821f",
          "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:42:17.8887204-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": "df9d2c9b-d5a3-409c-89f5-1f9df54ee4dc",
    "CreateDate": "2021-04-17T06:42:17.8887204-07:00",
    "CreateUser": "sample string 5",
    "CreateMachine": "sample string 6",
    "LastModifiedDate": "2021-04-17T06:42:17.8887204-07:00",
    "LastModifiedUser": "sample string 7",
    "LastModifiedMachine": "sample string 8"
  },
  "Total": 1,
  "Message": "sample string 1"
}