Get All Departments

Overview

This API allows to retrieve all departments that the user can view.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user, user must at least have one of the following:
    • "View Administration" action on the "System" resource.
    • "View Knowledge Base" action on "System" resource.
    • "View Agent" action on "System" resource.
  • If logged in user is a global user:
    • 'View' action on the 'Department' resource.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.
Available values: all, description, created, externalId

Examples:
Additional attributes 'description' and 'created' will be returned in server response.
$attribute=description,created
All the attributes will be returned in server response.
$attribute=all
filterText
string <= 124 characters

Search string. Must not exceed 124 characters. When this attribute is provided, only those departments will be returned where either name or description contains this string.

$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name" "description"
Example: $sort=id
$order
string

Common query parameter $order.

Enum: "asc" "desc"
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 25

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 25

header Parameters
Accept
required
string
Default: application/json

The content type accepted by the client.

Enum: "application/json" "application/xml"
Accept-Language
required
string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

NO Content

  • No matches were found for given search criteria.
  • Matches found for this search, however the requested page or range doesn't contain any results.
400

Bad Request

401

Unauthorized

403

Forbidden

406

Not Acceptable

500

Internal server error

get/department
Request samples
Response samples
application/json
    

  • GET /core/departmentmgr/v3/department
    • 

  • This example demonstrates the following:
      

    • Retrieve all departments viewable to user
      • 

    • Retrieve only summary attributes of each department.
      • 

    

    • 



{
  • "department": [
    ],
  • "paginationInfo": {
    }
}