All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| AddApplication | Post /api/v2/applications | |
| CloneApplication | Post /api/v2/applications/{sourceApplicationId}/clone | |
| DeleteApplication | Delete /api/v2/applications/{applicationId} | |
| GetApplication | Get /api/v2/applications/{applicationId} | |
| GetApplications | Get /api/v2/applications | |
| GetApplicationsByOrganizationId | Get /api/v2/applications/organization/{organizationId} | |
| MoveApplication | Post /api/v2/applications/{applicationId}/move/organization/{organizationId} | |
| UpdateApplication | Put /api/v2/applications/{applicationId} |
ApiApplicationDTO AddApplication(ctx).ApiApplicationDTO(apiApplicationDTO).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
apiApplicationDTO := *sonatypeiq.NewApiApplicationDTO() // ApiApplicationDTO | Specify the applicationId, application name and the organizationId under which the application should be created. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. Use the Application Categories REST API for the available categories and the corresponding tagIds. (optional)
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.AddApplication(context.Background()).ApiApplicationDTO(apiApplicationDTO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.AddApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AddApplication`: ApiApplicationDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.AddApplication`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAddApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| apiApplicationDTO | ApiApplicationDTO | Specify the applicationId, application name and the organizationId under which the application should be created. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. Use the Application Categories REST API for the available categories and the corresponding tagIds. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiApplicationDTO CloneApplication(ctx, sourceApplicationId).ClonedApplicationName(clonedApplicationName).ClonedApplicationPublicId(clonedApplicationPublicId).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
sourceApplicationId := "sourceApplicationId_example" // string | Enter the applicationId for the application to be cloned.
clonedApplicationName := "clonedApplicationName_example" // string | Enter the application name for the new cloned application. (optional)
clonedApplicationPublicId := "clonedApplicationPublicId_example" // string | Enter the applicationPublicId for the cloned application. (optional)
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.CloneApplication(context.Background(), sourceApplicationId).ClonedApplicationName(clonedApplicationName).ClonedApplicationPublicId(clonedApplicationPublicId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.CloneApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CloneApplication`: ApiApplicationDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.CloneApplication`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sourceApplicationId | string | Enter the applicationId for the application to be cloned. |
Other parameters are passed through a pointer to a apiCloneApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
clonedApplicationName | string | Enter the application name for the new cloned application. | clonedApplicationPublicId | string | Enter the applicationPublicId for the cloned application. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteApplication(ctx, applicationId).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
applicationId := "applicationId_example" // string | Enter the applicationId to be deleted.
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
r, err := apiClient.ApplicationsAPI.DeleteApplication(context.Background(), applicationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.DeleteApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Enter the applicationId to be deleted. |
Other parameters are passed through a pointer to a apiDeleteApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiApplicationDTO GetApplication(ctx, applicationId).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
applicationId := "applicationId_example" // string | Enter the applicationId.
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.GetApplication(context.Background(), applicationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.GetApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetApplication`: ApiApplicationDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.GetApplication`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Enter the applicationId. |
Other parameters are passed through a pointer to a apiGetApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiApplicationListDTO GetApplications(ctx).PublicId(publicId).IncludeCategories(includeCategories).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
publicId := []string{"Inner_example"} // []string | Enter the applicationId. (optional)
includeCategories := true // bool | Set this parameter to `true` to obtain the application tags (application categories) in the response. (optional) (default to false)
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.GetApplications(context.Background()).PublicId(publicId).IncludeCategories(includeCategories).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.GetApplications``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetApplications`: ApiApplicationListDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.GetApplications`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetApplicationsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| publicId | []string | Enter the applicationId. | |
| includeCategories | bool | Set this parameter to `true` to obtain the application tags (application categories) in the response. | [default to false] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiApplicationListDTO GetApplicationsByOrganizationId(ctx, organizationId).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
organizationId := "organizationId_example" // string | Enter the organizationId.
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.GetApplicationsByOrganizationId(context.Background(), organizationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.GetApplicationsByOrganizationId``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetApplicationsByOrganizationId`: ApiApplicationListDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.GetApplicationsByOrganizationId`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Enter the organizationId. |
Other parameters are passed through a pointer to a apiGetApplicationsByOrganizationIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiMoveApplicationResponseDTOV2 MoveApplication(ctx, applicationId, organizationId).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
applicationId := "applicationId_example" // string | Enter the applicationId of the application to be moved.
organizationId := "organizationId_example" // string | Enter the organizationId of the destination organization.
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.MoveApplication(context.Background(), applicationId, organizationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.MoveApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MoveApplication`: ApiMoveApplicationResponseDTOV2
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.MoveApplication`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Enter the applicationId of the application to be moved. | |
| organizationId | string | Enter the organizationId of the destination organization. |
Other parameters are passed through a pointer to a apiMoveApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
ApiMoveApplicationResponseDTOV2
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiApplicationDTO UpdateApplication(ctx, applicationId).ApiApplicationDTO(apiApplicationDTO).Execute()
package main
import (
"context"
"fmt"
"os"
sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)
func main() {
applicationId := "applicationId_example" // string |
apiApplicationDTO := *sonatypeiq.NewApiApplicationDTO() // ApiApplicationDTO | Specify the applicationId, application name and the organizationId under which the application exists. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. . Use the Application Categories REST API for the available categories and the corresponding tagIds. (optional)
configuration := sonatypeiq.NewConfiguration()
apiClient := sonatypeiq.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationsAPI.UpdateApplication(context.Background(), applicationId).ApiApplicationDTO(apiApplicationDTO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsAPI.UpdateApplication``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateApplication`: ApiApplicationDTO
fmt.Fprintf(os.Stdout, "Response from `ApplicationsAPI.UpdateApplication`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string |
Other parameters are passed through a pointer to a apiUpdateApplicationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiApplicationDTO | ApiApplicationDTO | Specify the applicationId, application name and the organizationId under which the application exists. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. . Use the Application Categories REST API for the available categories and the corresponding tagIds. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]