api/documentation/topics/generated/listDepartmentGoals.topic

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="List or get department goals" id="listDepartmentGoals">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">GET /goals/department</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>listDepartmentGoals</code></p>
        <p>Retrieve a list of department goals or a single goal when `id` is provided.

Access control:
- A user may only access goals where the goal&#x27;s `departments` set is a subset of the user&#x27;s departments.
- Users with the `superuser` permission may access all goals.
</p>
    </chapter>
    <chapter title="Authentication" id="authentication">
        <p>Security requirements:</p>
        <table>
            <tr><td>Scheme</td><td>Scopes</td></tr>
            <tr><td>BearerAuth</td><td>-</td></tr>
        </table>
    </chapter>
    <chapter title="Parameters" id="parameters">
        <table>
            <tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
            <tr><td>id</td><td>query</td><td>no</td><td>integer</td><td>When provided, returns the single goal with this id (if accessible)</td></tr>
            <tr><td></td><td></td><td>no</td><td>object</td><td></td></tr>
        </table>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>Goals retrieved successfully</td><td>application/json</td></tr>
            <tr><td>400</td><td></td><td></td></tr>
            <tr><td>401</td><td></td><td></td></tr>
            <tr><td>403</td><td></td><td></td></tr>
            <tr><td>404</td><td></td><td></td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;items&quot;: {
    &quot;$ref&quot;: &quot;#/components/schemas/DepartmentGoal&quot;
  },
  &quot;type&quot;: &quot;array&quot;
}
        </code-block>
    </chapter>
</topic>