board-github
GET /v1/board-github/roadmap
A dated timeline across every linked GitHub Project.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/board-github/roadmap \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | string | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
count | integer | Не | — |
items_without_dates | integer | Не | 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 | Не | — |
entries | GitHubProjectRoadmapEntry[] | Не | — |
Грешки, които този крайpoint може да върне
401 · 403 · 422