Boards

Introduction

Endpoint that returns the Boards registered in Jira.

Endpoints

Method Endpoint Description
GET https://csp-plugin-jira-client-api.azurewebsites.net/Boards get Boards

Parameters

This endpoint has no parameters.

Responses

When executing a successful request to the endpoint, it yields the following response:

                                            
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2024-01-16T19:14:36.871Z",
    "updatedAt": "2024-01-16T19:14:36.871Z",
    "deletionDate": "2024-01-16T19:14:36.871Z",
    "isDeleted": true,
    "name": "string",
    "state": "string",
    "jiraId": 0,
    "startDate": "2024-01-16T19:14:36.871Z",
    "endDate": "2024-01-16T19:14:36.871Z",
  }
]

Get Boards Count

Method Endpoint Description
GET https://csp-plugin-jira-client-api.azurewebsites.net/Boards/$count Get Boards Count information

Responses

When executing a successful request to the endpoint, it yields the following response: 

                                                
[
  {
    110
  }
]

Error

The Westeros API uses the following error codes:

Error code Description
401 Unauthorized indicates that the request was not applied because it does not have valid authentication credentials for the target resource.