board-github
GET /v1/board-github/roadmap
A dated timeline across every linked GitHub Project.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/board-github/roadmap \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Built from whichever DATE and ITERATION fields each project actually has. Lanes are the iteration where a project has one and the project where it does not, so one timeline stays readable across a sprint-driven engineering project and a date-driven client project at once. GitHub's own roadmap layout can do neither — it is per-project and cannot see our board cards. Items with no date are **omitted and counted** in `items_without_dates`, never given an invented date: a chart of our guesses would be worse than a gap.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | string | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
count | integer | Ne | — |
items_without_dates | integer | Ne | Omitted from the timeline and counted here. A chart that invented a date for undated work would be a chart of our guesses. |
coverage_is_complete | boolean | Ne | — |
entries | GitHubProjectRoadmapEntry[] | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422