BoardApi.md

ScrumBoardIt.BoardApi

All URIs are relative to https://api.scrumboard-it.org

Method	HTTP request	Description
getBoardById	GET /boards/{boardId}	Find board by ID
getBoards	GET /boards	List all accessible boards
getTasksByBoardId	GET /boards/{boardId}/tasks	List all tasks of a board

getBoardById

InlineResponse2001 getBoardById(boardId)

Find board by ID

Example

var ScrumBoardIt = require('scrumboard-it-client');
var defaultClient = ScrumBoardIt.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new ScrumBoardIt.BoardApi();

var boardId = "boardId_example"; // String | ID of the board to return

apiInstance.getBoardById(boardId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
boardId	String	ID of the board to return

Return type

InlineResponse2001

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getBoards

InlineResponse200 getBoards()

List all accessible boards

Example

var ScrumBoardIt = require('scrumboard-it-client');
var defaultClient = ScrumBoardIt.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new ScrumBoardIt.BoardApi();
apiInstance.getBoards().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTasksByBoardId

InlineResponse2002 getTasksByBoardId(boardId)

List all tasks of a board

Example

var ScrumBoardIt = require('scrumboard-it-client');
var defaultClient = ScrumBoardIt.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new ScrumBoardIt.BoardApi();

var boardId = "boardId_example"; // String | ID of the board's tasks

apiInstance.getTasksByBoardId(boardId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
boardId	String	ID of the board's tasks

Return type

InlineResponse2002

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json