Skip to content

Latest commit

 

History

History
209 lines (133 loc) · 5.62 KB

PlannerApi.md

File metadata and controls

209 lines (133 loc) · 5.62 KB
Raw

\PlannerApi

All URIs are relative to http://localhost:5516

Method HTTP request Description
GetActiveReleases Get /api/v1/analytics/planner/active
GetCompletedReleases Get /api/v1/analytics/planner/completed
GetReleasesByIds Post /api/v1/analytics/planner/byIds

GetActiveReleases

[]ProjectedRelease GetActiveReleases(ctx).Page(page).ResultsPerPage(resultsPerPage).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    page := int64(789) // int64 |  (optional) (default to 0)
    resultsPerPage := int64(789) // int64 |  (optional) (default to 100)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlannerApi.GetActiveReleases(context.Background()).Page(page).ResultsPerPage(resultsPerPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlannerApi.GetActiveReleases``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetActiveReleases`: []ProjectedRelease
    fmt.Fprintf(os.Stdout, "Response from `PlannerApi.GetActiveReleases`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetActiveReleasesRequest struct via the builder pattern

Name Type Description Notes
page int64 [default to 0]
resultsPerPage int64 [default to 100]

Return type

[]ProjectedRelease

Authorization

basicAuth, patAuth

HTTP request headers

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

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

GetCompletedReleases

[]ProjectedRelease GetCompletedReleases(ctx).Page(page).ResultsPerPage(resultsPerPage).Since(since).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    page := int64(789) // int64 |  (optional) (default to 0)
    resultsPerPage := int64(789) // int64 |  (optional) (default to 100)
    since := int64(789) // int64 |  (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlannerApi.GetCompletedReleases(context.Background()).Page(page).ResultsPerPage(resultsPerPage).Since(since).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlannerApi.GetCompletedReleases``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetCompletedReleases`: []ProjectedRelease
    fmt.Fprintf(os.Stdout, "Response from `PlannerApi.GetCompletedReleases`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetCompletedReleasesRequest struct via the builder pattern

Name Type Description Notes
page int64 [default to 0]
resultsPerPage int64 [default to 100]
since int64 [default to 0]

Return type

[]ProjectedRelease

Authorization

basicAuth, patAuth

HTTP request headers

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

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

GetReleasesByIds

[]ProjectedRelease GetReleasesByIds(ctx).RequestBody(requestBody).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    requestBody := []string{"Property_example"} // []string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlannerApi.GetReleasesByIds(context.Background()).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlannerApi.GetReleasesByIds``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetReleasesByIds`: []ProjectedRelease
    fmt.Fprintf(os.Stdout, "Response from `PlannerApi.GetReleasesByIds`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetReleasesByIdsRequest struct via the builder pattern

Name Type Description Notes
requestBody []string

Return type

[]ProjectedRelease

Authorization

basicAuth, patAuth

HTTP request headers

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

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