GET TaskTypes?taskTypeId={taskTypeId}

Retrieves a task type by its Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
taskTypeId

Id of the task type

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

On success, the task type.

NameDescriptionTypeAdditional information
Data

TaskType

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "TaskTypeId": "9c8966af-08f9-402d-b5b8-44953799048d",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "CustomStatuses": true,
    "Fields": [
      {
        "TaskTypeFieldId": "653f8055-95eb-439d-baa5-8842fa57654f",
        "Section": {
          "TaskTypeSectionId": "15162fad-081c-4b6e-ac1b-189523837347",
          "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": "f989aa90-9e58-479f-b941-cdcd0e8bb89a",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "02fdbb01-653d-40af-be74-6fcf0115bfb3",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "2bd4ba9d-b531-469b-8526-e8f678f29793",
          "CreateDate": "2024-12-22T03:01:04.6299089-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-12-22T03:01:04.6299089-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "DisplayOrder": 1,
        "MinValue": 1.0,
        "MaxValue": 1.0,
        "MinLength": 1,
        "MaxLength": 1,
        "HasValidValues": true,
        "ValidValues": [
          {
            "ValidValueId": "51fb19ce-5a84-4df1-8e71-f140d8afa861",
            "FieldId": "27d174d6-1688-4002-a344-90623b8d5628",
            "FieldName": "sample string 1",
            "FieldLabel": "sample string 2",
            "ValueText": "sample string 3",
            "LabelText": "sample string 4"
          },
          {
            "ValidValueId": "51fb19ce-5a84-4df1-8e71-f140d8afa861",
            "FieldId": "27d174d6-1688-4002-a344-90623b8d5628",
            "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": "653f8055-95eb-439d-baa5-8842fa57654f",
        "Section": {
          "TaskTypeSectionId": "15162fad-081c-4b6e-ac1b-189523837347",
          "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": "f989aa90-9e58-479f-b941-cdcd0e8bb89a",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "02fdbb01-653d-40af-be74-6fcf0115bfb3",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "2bd4ba9d-b531-469b-8526-e8f678f29793",
          "CreateDate": "2024-12-22T03:01:04.6299089-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-12-22T03:01:04.6299089-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "DisplayOrder": 1,
        "MinValue": 1.0,
        "MaxValue": 1.0,
        "MinLength": 1,
        "MaxLength": 1,
        "HasValidValues": true,
        "ValidValues": [
          {
            "ValidValueId": "51fb19ce-5a84-4df1-8e71-f140d8afa861",
            "FieldId": "27d174d6-1688-4002-a344-90623b8d5628",
            "FieldName": "sample string 1",
            "FieldLabel": "sample string 2",
            "ValueText": "sample string 3",
            "LabelText": "sample string 4"
          },
          {
            "ValidValueId": "51fb19ce-5a84-4df1-8e71-f140d8afa861",
            "FieldId": "27d174d6-1688-4002-a344-90623b8d5628",
            "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": "f95a0559-1614-4b3b-a919-6d7fa56a6c85",
    "CreateDate": "2024-12-22T03:01:04.6299089-08:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2024-12-22T03:01:04.6299089-08:00",
    "LastModifiedUser": "sample string 7"
  },
  "Total": 1,
  "Message": "sample string 1"
}