GET api/NE/Tasks

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Task
NameDescriptionTypeAdditional information
AssignedUserId

integer

None.

Attempts

byte

None.

Comments

string

None.

CompletedBy

integer

None.

CompletedDate

date

None.

CreatedBy

integer

None.

CreatedByBusinessUnitId

integer

None.

CreatedByDataOriginId

integer

None.

CreatedDate

date

None.

DisplayName

string

None.

EndDueDate

date

None.

EntityId

integer

None.

EntityNameId

integer

None.

FollowUpDate

date

None.

InteractionAlertDate

date

None.

IsEscalated

boolean

None.

IsOpened

boolean

None.

IsInteractionAlertActive

boolean

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

ParentTaskId

integer

None.

PublicNotes

string

None.

StartDueDate

date

None.

TaskId

integer

None.

TaskPriorityId

integer

None.

TaskQueueId

byte

None.

TaskSourceId

integer

None.

TaskStatusId

integer

None.

TaskTypeId

integer

None.

Tasks

Collection of Task

None.

TaskNotes

Collection of TaskNote

None.

TaskWorkedEvents

Collection of TaskWorkedEvent

None.

CreatedByBusinessUnit

BusinessUnit

None.

EntityName

EntityName

None.

ParentTask

Task

None.

TaskPriority

TaskPriority

None.

TaskQueue

TaskQueue

None.

TaskSource

TaskSource

None.

TaskStatus

TaskStatus

None.

TaskType

TaskType

None.

AssignedUser

User

None.

CreatedByUser

User

None.

ModifiedByUser

User

None.

CompletedByUser

User

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.TASK.Task, NE.Entities.Server",
    "AssignedUserId": 1,
    "Attempts": 64,
    "Comments": "sample string 2",
    "CompletedBy": 1,
    "CompletedDate": "2024-12-07T21:05:27.491+00:00",
    "CreatedBy": 3,
    "CreatedByBusinessUnitId": 4,
    "CreatedByDataOriginId": 5,
    "CreatedDate": "2024-12-07T21:05:27.491+00:00",
    "DisplayName": "sample string 7",
    "EndDueDate": "2024-12-07T21:05:27.491+00:00",
    "EntityId": 9,
    "EntityNameId": 10,
    "FollowUpDate": "2024-12-07T21:05:27.491+00:00",
    "InteractionAlertDate": "2024-12-07T21:05:27.491+00:00",
    "IsEscalated": true,
    "IsOpened": true,
    "IsInteractionAlertActive": true,
    "ModifiedBy": 1,
    "ModifiedDate": "2024-12-07T21:05:27.491+00:00",
    "ParentTaskId": 1,
    "PublicNotes": "sample string 13",
    "StartDueDate": "2024-12-07T21:05:27.491+00:00",
    "TaskId": 15,
    "TaskPriorityId": 16,
    "TaskQueueId": 64,
    "TaskSourceId": 1,
    "TaskStatusId": 18,
    "TaskTypeId": 19,
    "Tasks": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ],
    "TaskNotes": [
      {
        "$id": "2",
        "$type": "NE.Entities.Server.TASK.TaskNote, NE.Entities.Server",
        "TaskNoteId": 1,
        "TaskId": 2,
        "TaskNoteTypeId": 3,
        "Note": "sample string 4",
        "IsDeleted": true,
        "CreatedBy": 6,
        "CreatedDate": "2024-12-07T21:05:27.507+00:00",
        "ModifiedBy": 1,
        "ModifiedDate": "2024-12-07T21:05:27.507+00:00",
        "Task": {
          "$ref": "1"
        },
        "TaskNoteType": {
          "$id": "3",
          "$type": "NE.Entities.Server.TASK.TaskNoteType, NE.Entities.Server",
          "TaskNoteTypeId": 1,
          "Description": "sample string 2",
          "CodeName": "sample string 3",
          "IsAttempt": true,
          "CanSelectOnWeb": true,
          "TaskStatusId": 1,
          "TaskNotes": [
            {
              "$ref": "2"
            },
            {
              "$ref": "2"
            }
          ],
          "TaskStatus": {
            "$id": "4",
            "$type": "NE.Entities.Server.TASK.TaskStatus, NE.Entities.Server",
            "TaskStatusId": 1,
            "Description": "sample string 2",
            "IsFinal": true,
            "CodeName": "sample string 4",
            "GeneratesTicket": true,
            "TicketBusinessUnitId": 1,
            "CanResolve": true,
            "EntityNameId": 1,
            "TaskInboxSortOrder": 7,
            "TicketBusinessUnit": {
              "$id": "5",
              "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
              "BusinessUnitId": 1,
              "Description": "sample string 2",
              "IsAHS": true
            },
            "EntityName": {
              "$id": "6",
              "$type": "AHS.Server.Entities.EntityName, AHS.Server",
              "EntityNameId": 1,
              "Description": "sample string 2",
              "CodeName": "sample string 3"
            },
            "IsForState": true
          }
        },
        "User_CreatedBy": {
          "$id": "7",
          "$type": "AHS.Server.Entities.User, AHS.Server",
          "UserId": 1,
          "Username": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Email": "sample string 5",
          "IsActive": true,
          "IsSystem": true,
          "IsADBased": true,
          "BusinessUnitId": 9,
          "PermissionIds": [
            1,
            2
          ],
          "FullName": "sample string 3 sample string 4",
          "BusinessUnit": {
            "$ref": "5"
          }
        },
        "User_ModifiedBy": {
          "$ref": "7"
        }
      },
      {
        "$ref": "2"
      }
    ],
    "TaskWorkedEvents": [
      {
        "$id": "8",
        "$type": "NE.Entities.Server.TASK.TaskWorkedEvent, NE.Entities.Server",
        "TaskWorkedEventID": 1,
        "TaskID": 2,
        "EventEntityNameID": 3,
        "EventEntityID": 4,
        "CreatedBy": 5,
        "CreatedDate": "2024-12-07T21:05:27.507+00:00",
        "EntityName": {
          "$ref": "6"
        },
        "Task": {
          "$ref": "1"
        },
        "CreatedByUser": {
          "$ref": "7"
        }
      },
      {
        "$ref": "8"
      }
    ],
    "CreatedByBusinessUnit": {
      "$ref": "5"
    },
    "EntityName": {
      "$ref": "6"
    },
    "ParentTask": {
      "$ref": "1"
    },
    "TaskPriority": {
      "$id": "9",
      "$type": "NE.Entities.Server.TASK.TaskPriority, NE.Entities.Server",
      "TaskPriorityId": 1,
      "Description": "sample string 2",
      "CodeName": "sample string 3",
      "PriorityLevel": 4,
      "IsForState": true,
      "Definition": "sample string 6",
      "EntityNameId": 1,
      "EntityName": {
        "$ref": "6"
      }
    },
    "TaskQueue": {
      "$id": "10",
      "$type": "NE.Entities.Server.TASK.TaskQueue, NE.Entities.Server",
      "TaskQueueId": 64,
      "Description": "sample string 2",
      "AlternateDescription": "sample string 3",
      "Codename": "sample string 4",
      "IsForState": true,
      "EntityNameId": 1
    },
    "TaskSource": {
      "$id": "11",
      "$type": "NE.Entities.Server.TASK.TaskSource, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "IsActive": true,
      "TaskSourceId": 4,
      "EntityNameId": 1,
      "Tasks": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "EntityName": {
        "$ref": "6"
      }
    },
    "TaskStatus": {
      "$ref": "4"
    },
    "TaskType": {
      "$id": "12",
      "$type": "NE.Entities.Server.TASK.TaskType, NE.Entities.Server",
      "TaskTypeId": 1,
      "TaskAssignmentTypeId": 64,
      "Description": "sample string 2",
      "AlternateDescription": "sample string 3",
      "IsActive": true,
      "IsCallDriven": true,
      "CanCreate_Backend": true,
      "CanCreate_UI": true,
      "CanCreate_Manual": true,
      "ListOrder": 64,
      "CodeName": "sample string 10",
      "DefaultTaskQueueId": 64,
      "EntityNameId": 1,
      "TaskTypeEntityTypes": [
        {
          "$id": "13",
          "$type": "NE.Entities.Server.TASK.TaskTypeEntityName, NE.Entities.Server",
          "TaskTypeEntityNameID": 1,
          "TaskTypeID": 2,
          "EntityNameID": 3,
          "Description": "sample string 4",
          "CreatePermissionID": 1,
          "AssignmentPermissionID": 1,
          "WorkablePermissionID": 1,
          "ManagementPermissionID": 1,
          "ReadOnlyPermissionId": 1,
          "CodeName": "sample string 5",
          "BusinessUnitId": 1,
          "Users": [
            {
              "$ref": "7"
            },
            {
              "$ref": "7"
            }
          ],
          "EntityName": {
            "$ref": "6"
          },
          "TaskType": {
            "$ref": "12"
          },
          "BusinessUnit": {
            "$ref": "5"
          }
        },
        {
          "$ref": "13"
        }
      ],
      "EntityName": {
        "$ref": "6"
      },
      "TaskAssignmentType": {
        "$id": "14",
        "$type": "NE.Entities.Server.TASK.TaskAssignmentType, NE.Entities.Server",
        "TaskAssignmentTypeID": 64,
        "Description": "sample string 2",
        "CodeName": "sample string 3",
        "TaskTypes": [
          {
            "$ref": "12"
          },
          {
            "$ref": "12"
          }
        ]
      }
    },
    "AssignedUser": {
      "$ref": "7"
    },
    "CreatedByUser": {
      "$ref": "7"
    },
    "ModifiedByUser": {
      "$ref": "7"
    },
    "CompletedByUser": {
      "$ref": "7"
    }
  },
  {
    "$ref": "1"
  }
]