Skip to content

Commit 75f291e

Browse files
authored
Merge pull request #273 from Metadrop/fb-boards-readme
Add documentation for board services
2 parents 964b185 + 6f84182 commit 75f291e

File tree

1 file changed

+69
-1
lines changed

1 file changed

+69
-1
lines changed

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,10 @@ $iss = new IssueService(new ArrayConfiguration(
205205
- [Update component](#update-component)
206206
- [Delete component](#delete-component)
207207

208+
### Board
209+
- [Get board list](#get-board-list)
210+
- [Get board info](#get-board-info)
211+
- [Get board issues](#get-board-issues)
208212
#### Create Project
209213

210214
Create a new project.
@@ -2300,11 +2304,75 @@ try {
23002304
```
23012305

23022306

2307+
#### Get board list
2308+
[See Jira API reference](https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-agile-1-0-board-get)
2309+
2310+
```php
2311+
<?php
2312+
require 'vendor/autoload.php';
2313+
2314+
use JiraRestApi\Board\BoardService;
2315+
2316+
try {
2317+
$board_service = new BoardService();
2318+
$board = $board_service->getBoardList();
2319+
2320+
var_dump($board);
2321+
} catch (JiraException $e) {
2322+
print("Error Occured! " . $e->getMessage());
2323+
}
2324+
2325+
```
2326+
#### Get board info
2327+
[See Jira API reference](https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-agile-1-0-board-boardId-get)
2328+
2329+
```php
2330+
<?php
2331+
require 'vendor/autoload.php';
2332+
2333+
use JiraRestApi\Board\BoardService;
2334+
2335+
try {
2336+
$board_service = new BoardService();
2337+
$board_id = 1;
2338+
$board = $board_service->getBoard($board_id);
2339+
2340+
var_dump($board);
2341+
} catch (JiraException $e) {
2342+
print("Error Occured! " . $e->getMessage());
2343+
}
2344+
2345+
```
2346+
2347+
#### Get board issues
2348+
[See Jira API reference](https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-agile-1-0-board-boardId-issue-get)
2349+
2350+
```php
2351+
<?php
2352+
require 'vendor/autoload.php';
2353+
2354+
use JiraRestApi\Board\BoardService;
2355+
2356+
try {
2357+
$board_service = new BoardService();
2358+
$board_id = 1;
2359+
$board = $board_service->getBoardIssues($board_id, [
2360+
'maxResults' => 500,
2361+
'jql' => urlencode('status != Closed'),
2362+
]);
2363+
2364+
var_dump($board);
2365+
} catch (JiraException $e) {
2366+
print("Error Occured! " . $e->getMessage());
2367+
}
2368+
2369+
```
2370+
23032371
# License
23042372

23052373
Apache V2 License
23062374

23072375
# JIRA Rest API Documents
23082376
* 6.4 - https://docs.atlassian.com/jira/REST/6.4/
23092377
* Jira Server latest - https://docs.atlassian.com/jira/REST/server/
2310-
* Jira Cloud latest - https://docs.atlassian.com/jira/REST/latest/
2378+
* Jira Cloud latest - https://docs.atlassian.com/jira/REST/latest/

0 commit comments

Comments
 (0)