Sanggunian ng API
board-github
20 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| POST | /v1/board-github/discover | List the GitHub Projects a credential can see. | agency.board.manage |
| GET | /v1/board-github/links | The GitHub Projects this organisation has connected. | agency.board.view |
| POST | /v1/board-github/links | Connect a GitHub Project to this organisation. | agency.board.manage |
| DELETE | /v1/board-github/links/{linkId} | Disconnect a GitHub Project. | agency.board.manage |
| GET | /v1/board-github/links/{linkId} | One connection, with its WIP report and its open notices. | agency.board.view |
| PATCH | /v1/board-github/links/{linkId} | Change a connection's sync direction or the board it sits alongside. | agency.board.manage |
| GET | /v1/board-github/links/{linkId}/conflicts | Every field whose value was overwritten by the sync. | agency.board.view |
| PUT | /v1/board-github/links/{linkId}/fields/{fieldId}/wip | Set an advisory WIP limit on one status option. | agency.board.manage |
| GET | /v1/board-github/links/{linkId}/items | The items on a connected project. | agency.board.view |
| POST | /v1/board-github/links/{linkId}/items | Post a new item to the GitHub Project from our UI. | agency.board.manage |
| DELETE | /v1/board-github/links/{linkId}/items/{itemId} | Remove an item from the GitHub Project, permanently. | agency.board.manage |
| PUT | /v1/board-github/links/{linkId}/items/{itemId}/archive | Archive a GitHub Project item, or restore it. | agency.board.manage |
| PUT | /v1/board-github/links/{linkId}/items/{itemId}/card | Attach a GitHub item to a board card, or detach it. | agency.board.manage |
| PUT | /v1/board-github/links/{linkId}/items/{itemId}/field | Set or clear one field value on a GitHub Project item. | agency.board.manage |
| POST | /v1/board-github/links/{linkId}/sync | Refresh one connection from GitHub now. | agency.board.view |
| GET | /v1/board-github/links/{linkId}/webhook | The payload URL and signing secret for a connection the customer configures. | agency.board.manage |
| POST | /v1/board-github/links/{linkId}/webhook | Try again to create the webhook on GitHub, and mint a fresh secret. | agency.board.manage |
| GET | /v1/board-github/roadmap | A dated timeline across every linked GitHub Project. | agency.board.view |
| GET | /v1/board-github/rollup | Every linked GitHub Project, summed into one view. | agency.board.view |
| POST | /v1/board-github/webhook/{endpointKey} | One GitHub webhook delivery for a linked project. | Walang API key |