GET/depts

Applies to QAComplete 12.75 SaaS, last modified on April 01, 2021

Returns a list of departments of a logged user.

Use this operation to get information about the departments the current user belongs to.

To get information on a specific department, use the /depts/{DeptId} (GET) operation.

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must have access to departments you want to get. For more information, see Authentication.

Request Format

To get information on departments, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/depts?offset={offset}&limit={limit}&Filter={filter}

offset  :  integer, default: 0

The number of departments to skip before counting the returned departments. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.

limit  :  integer, default: 25

The maximum number of departments to return in the response.

filter  :  string

The filter expression to apply to the returned list. See Search Filters.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/depts HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/depts

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with departments information.

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 317


{
    "metadata": {
       "result_set": {
          "count": 1,
          "offset": 0,
          "limit": 25,
          "total": 1
       },
        "permissions": {
            "acl": 1
       }
    },
    "results": [
       {
         "id": 8162,
         "company_id": 8426,
         "dept_name": "Your Company Name",
         "update_user_id": 1234,
         "date_created": "2015-03-10T13:25:55.1500000",
         "date_updated": "2015-03-10T13:25:55.1500000",
         "page_size": 25
      }
  ]
}

See Also

Departments REST API Reference

Highlight search results