DELETE TaskTypes

Back to endpoints

DELETE TaskTypes

Deletes the given task type, including all tasks of that type.

Request Information

URI Parameters

None.

Body Parameters

Task type to delete

TaskType

Name	Type	Additional information
TaskTypeId	globally unique identifier	None.
Name	string	None.
Description	string	None.
CustomStatuses	boolean	None.
Fields	Collection of TaskTypeField	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:

{
  "TaskTypeId": "d072c52e-a961-42fb-931d-467f07ff45a5",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "CustomStatuses": true,
  "Fields": [
    {
      "TaskTypeFieldId": "2534dcc8-dfaf-4831-bf12-174d5fb41052",
      "Section": {
        "TaskTypeSectionId": "9d4c36de-5d68-48d3-84a5-8d8ccf8c70f4",
        "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": "98d17e31-beed-4911-a8af-6d9367997b35",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "3a702643-bf56-4d3a-b45e-832472353b40",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "1c23cc89-2ac4-4eb3-a2b4-58accba8e9a6",
        "CreateDate": "2024-12-26T03:19:54.7447798-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-12-26T03:19:54.7447798-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "DisplayOrder": 1,
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        {
          "ValidValueId": "2f8a8b0f-35a7-4d7c-a9c9-1a3166ebd37d",
          "FieldId": "9afce0b8-1407-4485-a209-b55d487198ec",
          "FieldName": "sample string 1",
          "FieldLabel": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        },
        {
          "ValidValueId": "2f8a8b0f-35a7-4d7c-a9c9-1a3166ebd37d",
          "FieldId": "9afce0b8-1407-4485-a209-b55d487198ec",
          "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",
      "IsMultiline": true,
      "IsRepeatable": true,
      "VisibleExpression": "sample string 11",
      "SourceSystemId": "sample string 12"
    },
    {
      "TaskTypeFieldId": "2534dcc8-dfaf-4831-bf12-174d5fb41052",
      "Section": {
        "TaskTypeSectionId": "9d4c36de-5d68-48d3-84a5-8d8ccf8c70f4",
        "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": "98d17e31-beed-4911-a8af-6d9367997b35",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "3a702643-bf56-4d3a-b45e-832472353b40",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "1c23cc89-2ac4-4eb3-a2b4-58accba8e9a6",
        "CreateDate": "2024-12-26T03:19:54.7447798-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-12-26T03:19:54.7447798-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "DisplayOrder": 1,
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        {
          "ValidValueId": "2f8a8b0f-35a7-4d7c-a9c9-1a3166ebd37d",
          "FieldId": "9afce0b8-1407-4485-a209-b55d487198ec",
          "FieldName": "sample string 1",
          "FieldLabel": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        },
        {
          "ValidValueId": "2f8a8b0f-35a7-4d7c-a9c9-1a3166ebd37d",
          "FieldId": "9afce0b8-1407-4485-a209-b55d487198ec",
          "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",
      "IsMultiline": true,
      "IsRepeatable": true,
      "VisibleExpression": "sample string 11",
      "SourceSystemId": "sample string 12"
    }
  ],
  "SourceSystemId": "sample string 4",
  "CompanyId": "01b82281-3c2d-4355-870c-1bfded1366c6",
  "CreateDate": "2024-12-26T03:19:54.7447798-08:00",
  "CreateUser": "sample string 6",
  "LastModifiedDate": "2024-12-26T03:19:54.7447798-08:00",
  "LastModifiedUser": "sample string 7"
}

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