Skip to content

Latest commit

 

History

History
275 lines (172 loc) · 7.87 KB

IAIRecommendationsApi.md

File metadata and controls

275 lines (172 loc) · 7.87 KB
Raw

\IAIRecommendationsApi

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
GetMessageCatalogs Get /translation-catalogs/{catalog-id} Get Message catalogs
GetRecommendations Post /recommendations/request Returns a Recommendation Based on Object
GetRecommendationsConfig Get /recommendations/config Get certification recommendation config values
UpdateRecommendationsConfig Put /recommendations/config Update certification recommendation config values

GetMessageCatalogs

[]MessageCatalogDto GetMessageCatalogs(ctx, catalogId).Execute()

Get Message catalogs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    catalogId := "catalogId_example" // string | The ID of the message catalog.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
catalogId string The ID of the message catalog.

Other Parameters

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

Name Type Description Notes

Return type

[]MessageCatalogDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

GetRecommendations

RecommendationResponseDto GetRecommendations(ctx).RecommendationRequestDto(recommendationRequestDto).Execute()

Returns a Recommendation Based on Object

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    recommendationRequestDto := *openapiclient.NewRecommendationRequestDto() // RecommendationRequestDto | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
recommendationRequestDto RecommendationRequestDto

Return type

RecommendationResponseDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

GetRecommendationsConfig

RecommendationConfigDto GetRecommendationsConfig(ctx).Execute()

Get certification recommendation config values

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

RecommendationConfigDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

UpdateRecommendationsConfig

RecommendationConfigDto UpdateRecommendationsConfig(ctx).RecommendationConfigDto(recommendationConfigDto).Execute()

Update certification recommendation config values

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    recommendationConfigDto := *openapiclient.NewRecommendationConfigDto() // RecommendationConfigDto | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
recommendationConfigDto RecommendationConfigDto

Return type

RecommendationConfigDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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