Skip to content

Latest commit

 

History

History
414 lines (262 loc) · 12.1 KB

EnvironmentReservationApi.md

File metadata and controls

414 lines (262 loc) · 12.1 KB
Raw

\EnvironmentReservationApi

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

Method HTTP request Description
AddApplication Post /api/v1/environments/reservations/{environmentReservationId}
CreateReservation Post /api/v1/environments/reservations
DeleteEnvironmentReservation Delete /api/v1/environments/reservations/{environmentReservationId}
GetReservation Get /api/v1/environments/reservations/{environmentReservationId}
SearchReservations Post /api/v1/environments/reservations/search
UpdateReservation Put /api/v1/environments/reservations/{environmentReservationId}

AddApplication

AddApplication(ctx, environmentReservationId).ApplicationId(applicationId).Execute()

Example

package main

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

func main() {
    environmentReservationId := "environmentReservationId_example" // string | 
    applicationId := "applicationId_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.EnvironmentReservationApi.AddApplication(context.Background(), environmentReservationId).ApplicationId(applicationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentReservationApi.AddApplication``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentReservationId string

Other Parameters

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

Name Type Description Notes

applicationId | string | |

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

CreateReservation

EnvironmentReservationView CreateReservation(ctx).EnvironmentReservationForm(environmentReservationForm).Execute()

Example

package main

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

func main() {
    environmentReservationForm := *openapiclient.NewEnvironmentReservationForm() // EnvironmentReservationForm |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnvironmentReservationApi.CreateReservation(context.Background()).EnvironmentReservationForm(environmentReservationForm).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentReservationApi.CreateReservation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateReservation`: EnvironmentReservationView
    fmt.Fprintf(os.Stdout, "Response from `EnvironmentReservationApi.CreateReservation`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
environmentReservationForm EnvironmentReservationForm

Return type

EnvironmentReservationView

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]

DeleteEnvironmentReservation

DeleteEnvironmentReservation(ctx, environmentReservationId).Execute()

Example

package main

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

func main() {
    environmentReservationId := "environmentReservationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.EnvironmentReservationApi.DeleteEnvironmentReservation(context.Background(), environmentReservationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentReservationApi.DeleteEnvironmentReservation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentReservationId string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetReservation

EnvironmentReservationView GetReservation(ctx, environmentReservationId).Execute()

Example

package main

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

func main() {
    environmentReservationId := "environmentReservationId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnvironmentReservationApi.GetReservation(context.Background(), environmentReservationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentReservationApi.GetReservation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetReservation`: EnvironmentReservationView
    fmt.Fprintf(os.Stdout, "Response from `EnvironmentReservationApi.GetReservation`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentReservationId string

Other Parameters

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

Name Type Description Notes

Return type

EnvironmentReservationView

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]

SearchReservations

[]EnvironmentReservationSearchView SearchReservations(ctx).ReservationFilters(reservationFilters).Execute()

Example

package main

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

func main() {
    reservationFilters := *openapiclient.NewReservationFilters() // ReservationFilters |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
reservationFilters ReservationFilters

Return type

[]EnvironmentReservationSearchView

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]

UpdateReservation

EnvironmentReservationView UpdateReservation(ctx, environmentReservationId).EnvironmentReservationForm(environmentReservationForm).Execute()

Example

package main

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

func main() {
    environmentReservationId := "environmentReservationId_example" // string | 
    environmentReservationForm := *openapiclient.NewEnvironmentReservationForm() // EnvironmentReservationForm |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnvironmentReservationApi.UpdateReservation(context.Background(), environmentReservationId).EnvironmentReservationForm(environmentReservationForm).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentReservationApi.UpdateReservation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateReservation`: EnvironmentReservationView
    fmt.Fprintf(os.Stdout, "Response from `EnvironmentReservationApi.UpdateReservation`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentReservationId string

Other Parameters

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

Name Type Description Notes

environmentReservationForm | EnvironmentReservationForm | |

Return type

EnvironmentReservationView

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]