Skip to content

MilestonesApi.md

Latest commit

 

History

History
320 lines (222 loc) · 8.69 KB

MilestonesApi.md

File metadata and controls

320 lines (222 loc) · 8.69 KB

MilestonesApi

All URIs are relative to https://api.qase.io/v1

Method HTTP request Description
createMilestone POST /milestone/{code} Create a new milestone
deleteMilestone DELETE /milestone/{code}/{id} Delete milestone
getMilestone GET /milestone/{code}/{id} Get a specific milestone
getMilestones GET /milestone/{code} Get all milestones
updateMilestone PATCH /milestone/{code}/{id} Update milestone

createMilestone

IdResponse createMilestone(milestoneCreate)

This method allows to create a milestone in selected project.

Example

import {
    MilestonesApi,
    Configuration,
    MilestoneCreate
} from 'qase-api-client';

const configuration = new Configuration();
const apiInstance = new MilestonesApi(configuration);

let code: string; //Code of project, where to search entities. (default to undefined)
let milestoneCreate: MilestoneCreate; //

const { status, data } = await apiInstance.createMilestone(
    code,
    milestoneCreate
);

Parameters

Name Type Description Notes
milestoneCreate MilestoneCreate
code [string] Code of project, where to search entities. defaults to undefined

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A result. -
400 Bad Request. -
401 Unauthorized. -
403 Forbidden. -
404 Not Found. -
422 Unprocessable Entity. -
429 Too Many Requests. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteMilestone

IdResponse deleteMilestone()

This method completely deletes a milestone from repository.

Example

import {
    MilestonesApi,
    Configuration
} from 'qase-api-client';

const configuration = new Configuration();
const apiInstance = new MilestonesApi(configuration);

let code: string; //Code of project, where to search entities. (default to undefined)
let id: number; //Identifier. (default to undefined)

const { status, data } = await apiInstance.deleteMilestone(
    code,
    id
);

Parameters

Name Type Description Notes
code [string] Code of project, where to search entities. defaults to undefined
id [number] Identifier. defaults to undefined

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A Result. -
400 Bad Request. -
401 Unauthorized. -
403 Forbidden. -
404 Not Found. -
429 Too Many Requests. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMilestone

MilestoneResponse getMilestone()

This method allows to retrieve a specific milestone.

Example

import {
    MilestonesApi,
    Configuration
} from 'qase-api-client';

const configuration = new Configuration();
const apiInstance = new MilestonesApi(configuration);

let code: string; //Code of project, where to search entities. (default to undefined)
let id: number; //Identifier. (default to undefined)

const { status, data } = await apiInstance.getMilestone(
    code,
    id
);

Parameters

Name Type Description Notes
code [string] Code of project, where to search entities. defaults to undefined
id [number] Identifier. defaults to undefined

Return type

MilestoneResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A Milestone. -
400 Bad Request. -
401 Unauthorized. -
403 Forbidden. -
404 Not Found. -
429 Too Many Requests. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMilestones

MilestoneListResponse getMilestones()

This method allows to retrieve all milestones stored in selected project.

Example

import {
    MilestonesApi,
    Configuration
} from 'qase-api-client';

const configuration = new Configuration();
const apiInstance = new MilestonesApi(configuration);

let code: string; //Code of project, where to search entities. (default to undefined)
let search: string; //Provide a string that will be used to search by name. (optional) (default to undefined)
let limit: number; //A number of entities in result set. (optional) (default to 10)
let offset: number; //How many entities should be skipped. (optional) (default to 0)

const { status, data } = await apiInstance.getMilestones(
    code,
    search,
    limit,
    offset
);

Parameters

Name Type Description Notes
code [string] Code of project, where to search entities. defaults to undefined
search [string] Provide a string that will be used to search by name. (optional) defaults to undefined
limit [number] A number of entities in result set. (optional) defaults to 10
offset [number] How many entities should be skipped. (optional) defaults to 0

Return type

MilestoneListResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of all milestones. -
400 Bad Request. -
401 Unauthorized. -
403 Forbidden. -
404 Not Found. -
429 Too Many Requests. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateMilestone

IdResponse updateMilestone(milestoneUpdate)

This method updates a milestone.

Example

import {
    MilestonesApi,
    Configuration,
    MilestoneUpdate
} from 'qase-api-client';

const configuration = new Configuration();
const apiInstance = new MilestonesApi(configuration);

let code: string; //Code of project, where to search entities. (default to undefined)
let id: number; //Identifier. (default to undefined)
let milestoneUpdate: MilestoneUpdate; //

const { status, data } = await apiInstance.updateMilestone(
    code,
    id,
    milestoneUpdate
);

Parameters

Name Type Description Notes
milestoneUpdate MilestoneUpdate
code [string] Code of project, where to search entities. defaults to undefined
id [number] Identifier. defaults to undefined

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A result. -
400 Bad Request. -
401 Unauthorized. -
403 Forbidden. -
404 Not Found. -
422 Unprocessable Entity. -
429 Too Many Requests. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]