Projects
What does this endpoint do?
This endpoint accept method: GET to retrieve the projects.
Get Projects
The GET method is one of the HTTP (Hypertext Transfer Protocol) methods used for retrieving data from a specified resource on a server. In a GET request, data is appended to the URL in the form of parameters, commonly known as the query string. This data is visible in the URL itself.
| Method | Endpoint | Description |
|---|---|---|
| GET | https://csp-plugin-jira-client-api.azurewebsites.net/Projects | Get Projects information |
What is Query String?
A query string is a part of a URL (Uniform Resource Locator) that contains additional data to be sent to the server. It typically follows the question mark "?" in the URL and consists of key-value pairs, where values are often used to pass parameters to a web application.
| Parameters | Endpoint example with query string | Description |
|---|---|---|
| dataSourceId | https://csp-plugin-jira-client-api.azurewebsites.net/Projects?dataSourceId=[DATASOURCEID] | Filter project by dataSourceId |
Responses
When executing a successful request to the endpoint, it yields the following response:
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2024-01-16T18:27:09.253Z",
"updatedAt": "2024-01-16T18:27:09.253Z",
"deletionDate": "2024-01-16T18:27:09.253Z",
"isDeleted": true,
"dataSourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"key": "string",
"jiraId": 0,
"name": "string",
"projectTypeKey": "string",
"simplified": true,
"style": "string",
"isPrivate": true,
"archived": true,
"categoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
]
Get Projects Count
The GET method is one of the HTTP (Hypertext Transfer Protocol) methods used for retrieving data from a specified resource on a server. In a GET request, data is appended to the URL in the form of parameters, commonly known as the query string. This data is visible in the URL itself.
| Method | Endpoint | Description |
|---|---|---|
| GET | https://csp-plugin-jira-client-api.azurewebsites.net/Projects/$count | Get Projects count information |
Query string
| Parameters | Endpoint | Description |
|---|---|---|
| dataSourceId | https://csp-plugin-jira-client-api.azurewebsites.net/Projects/$count | Filter project by dataSourceId |
Responses
When executing a successful request to the endpoint, it yields the following response:
[
{
61
}
]
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. |