Skip to content

Latest commit

 

History

History
345 lines (218 loc) · 9.25 KB

ApplicationApi.md

File metadata and controls

345 lines (218 loc) · 9.25 KB
Raw

\ApplicationApi

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

Method HTTP request Description
CreateApplication Post /api/v1/applications
DeleteApplication Delete /api/v1/applications/{applicationId}
GetApplication Get /api/v1/applications/{applicationId}
SearchApplications Post /api/v1/applications/search
UpdateApplication Put /api/v1/applications/{applicationId}

CreateApplication

ApplicationView CreateApplication(ctx).ApplicationForm(applicationForm).Execute()

Example

package main

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

func main() {
    applicationForm := *openapiclient.NewApplicationForm() // ApplicationForm |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationForm ApplicationForm

Return type

ApplicationView

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]

DeleteApplication

DeleteApplication(ctx, applicationId).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApplicationApi.DeleteApplication(context.Background(), applicationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationApi.DeleteApplication``: %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.
applicationId string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteApplicationRequest 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]

GetApplication

ApplicationView GetApplication(ctx, applicationId).Execute()

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApplicationView

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]

SearchApplications

[]ApplicationView SearchApplications(ctx).ApplicationFilters(applicationFilters).Execute()

Example

package main

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

func main() {
    applicationFilters := *openapiclient.NewApplicationFilters() // ApplicationFilters |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationFilters ApplicationFilters

Return type

[]ApplicationView

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]

UpdateApplication

ApplicationView UpdateApplication(ctx, applicationId).ApplicationForm(applicationForm).Execute()

Example

package main

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

func main() {
    applicationId := "applicationId_example" // string | 
    applicationForm := *openapiclient.NewApplicationForm() // ApplicationForm |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

applicationForm | ApplicationForm | |

Return type

ApplicationView

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]