23 lines
7.9 KiB
HTML
23 lines
7.9 KiB
HTML
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:43:17.903091027"><title>List or get department goals | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"parameters","level":0,"title":"Parameters","anchor":"#parameters"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="List or get department goals | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/listdepartmentgoals.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="List or get department goals | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
|
|
"@context": "http://schema.org",
|
|
"@type": "WebPage",
|
|
"@id": "writerside-documentation/listdepartmentgoals.html#webpage",
|
|
"url": "writerside-documentation/listdepartmentgoals.html",
|
|
"name": "List or get department goals | Copenhagen Truck Wash API",
|
|
"description": "",
|
|
"image": "",
|
|
"inLanguage":"en-US"
|
|
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
|
|
"@type": "WebSite",
|
|
"@id": "writerside-documentation/#website",
|
|
"url": "writerside-documentation/",
|
|
"name": "Copenhagen Truck Wash API Help"
|
|
}</script><!-- End Schema.org --></head><body data-id="listDepartmentGoals" data-main-title="List or get department goals" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Goals.topic|Goals///Tag_Goals_Page_1.topic|Goals - Page 1 of 1"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="listDepartmentGoals" id="listDepartmentGoals.topic">List or get department goals</h1><p id="z7tiooi_2">This endpoint documentation is generated directly from <code class="code" id="z7tiooi_8">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">GET /goals/department</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="z7tiooi_10">Operation ID: <code class="code" id="z7tiooi_12">listDepartmentGoals</code></p><p id="z7tiooi_11">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></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="z7tiooi_13">Security requirements:</p><div class="table-wrapper"><table class="wide" id="z7tiooi_14"><thead><tr class="ijRowHead" id="z7tiooi_15"><th id="z7tiooi_17"><p>Scheme</p></th><th id="z7tiooi_18"><p>Scopes</p></th></tr></thead><tbody><tr id="z7tiooi_16"><td id="z7tiooi_19"><p>BearerAuth</p></td><td id="z7tiooi_20"><p>-</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="parameters" data-toc="parameters">Parameters</h2><div class="table-wrapper"><table class="wide" id="z7tiooi_21"><thead><tr class="ijRowHead" id="z7tiooi_22"><th id="z7tiooi_25"><p>Name</p></th><th id="z7tiooi_26"><p>In</p></th><th id="z7tiooi_27"><p>Required</p></th><th id="z7tiooi_28"><p>Type</p></th><th id="z7tiooi_29"><p>Description</p></th></tr></thead><tbody><tr id="z7tiooi_23"><td id="z7tiooi_30"><p>id</p></td><td id="z7tiooi_31"><p>query</p></td><td id="z7tiooi_32"><p>no</p></td><td id="z7tiooi_33"><p>integer</p></td><td id="z7tiooi_34"><p>When provided, returns the single goal with this id (if accessible)</p></td></tr><tr id="z7tiooi_24"><td id="z7tiooi_35"></td><td id="z7tiooi_36"></td><td id="z7tiooi_37"><p>no</p></td><td id="z7tiooi_38"><p>object</p></td><td id="z7tiooi_39"></td></tr></tbody></table></div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="z7tiooi_40"><thead><tr class="ijRowHead" id="z7tiooi_43"><th id="z7tiooi_49"><p>Status</p></th><th id="z7tiooi_50"><p>Description</p></th><th id="z7tiooi_51"><p>Content Types</p></th></tr></thead><tbody><tr id="z7tiooi_44"><td id="z7tiooi_52"><p>200</p></td><td id="z7tiooi_53"><p>Goals retrieved successfully</p></td><td id="z7tiooi_54"><p>application/json</p></td></tr><tr id="z7tiooi_45"><td id="z7tiooi_55"><p>400</p></td><td id="z7tiooi_56"></td><td id="z7tiooi_57"></td></tr><tr id="z7tiooi_46"><td id="z7tiooi_58"><p>401</p></td><td id="z7tiooi_59"></td><td id="z7tiooi_60"></td></tr><tr id="z7tiooi_47"><td id="z7tiooi_61"><p>403</p></td><td id="z7tiooi_62"></td><td id="z7tiooi_63"></td></tr><tr id="z7tiooi_48"><td id="z7tiooi_64"><p>404</p></td><td id="z7tiooi_65"></td><td id="z7tiooi_66"></td></tr></tbody></table></div><p id="z7tiooi_41">Schema for response <code class="code" id="z7tiooi_67">200</code> (<code class="code" id="z7tiooi_68">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"items": {
|
|
"$ref": "#/components/schemas/DepartmentGoal"
|
|
},
|
|
"type": "array"
|
|
}
|
|
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="tag-goals-page-1.html" class="navigation-links__prev">Goals - Page 1 of 1</a><a href="createdepartmentgoal.html" class="navigation-links__next">Create department goal</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html> |