\ConfigLogAPIsDAAS

All URIs are relative to http://localhost

Method	HTTP request	Description
ConfigLogDeleteLogs	Delete /ConfigLog/Logs	Delete logging event logs. This on-prem only API.
ConfigLogDoConfigLogSearch	Post /ConfigLog/Operations/$search	Perform an advanced search for configuration log entries.
ConfigLogExportReportData	Post /ConfigLog/ExportReport	Export logging report data in the format of csv/html/both.
ConfigLogFetchExistingOperationLabels	Post /ConfigLog/Operations/$fetchExistingLabels	Fetch existing high level log operation labels.
ConfigLogGetFirstLogDate	Get /ConfigLog/GetFirstLogDate	Get first log date
ConfigLogGetLogSite	Get /ConfigLog/LoggingSite	Get logging site details. This on-prem only API.
ConfigLogGetLowLevelOperations	Get /ConfigLog/Operations/{id}/LowLevelOperations	Get the detailed low level operations of a high level operation.
ConfigLogGetOperation	Get /ConfigLog/Operations/{id}	Get a high level log operation.
ConfigLogGetOperations	Get /ConfigLog/Operations	Get configuration log operations.
ConfigLogPatchOperation	Patch /ConfigLog/Operations/{id}	Update a high level log operation.
ConfigLogSetLogSite	Patch /ConfigLog/LoggingSite	Update logging site info. This on-prem only API.

ConfigLogDeleteLogs

ConfigLogDeleteLogs(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).XAdminCredential(xAdminCredential).Accept(accept).CitrixLocale(citrixLocale).Execute()

Delete logging event logs. This on-prem only API.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    xAdminCredential := "xAdminCredential_example" // string | Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.  Example:Basic QWxhZGRpbjpPcGVuU2VzYW1l (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogDeleteLogs(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).XAdminCredential(xAdminCredential).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogDeleteLogs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

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

Name	Type	Description
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
xAdminCredential	string	Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the "Basic " scheme prepended. Example:Basic QWxhZGRpbjpPcGVuU2VzYW1l
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogDoConfigLogSearch

LogOperationResponseModelCollection ConfigLogDoConfigLogSearch(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).LogOperationSearchRequestModel(logOperationSearchRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute()

Perform an advanced search for configuration log entries.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    logOperationSearchRequestModel := *openapiclient.NewLogOperationSearchRequestModel() // LogOperationSearchRequestModel | Specifies the advanced search parameters.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)
    limit := int32(56) // int32 | The max number of configuration log entries returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings. (optional)
    continuationToken := "continuationToken_example" // string | If a query cannot be completed, the response will have a ContinuationToken set. To obtain more results from the query, pass the continuation token back into the query to get the next batch of results. (optional)
    async := true // bool | If `true`, the search operations will be executed as a background task. The task will have JobType DoOperationSearch. When the task is complete it will redirect to GetJobResults. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogDoConfigLogSearch(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).LogOperationSearchRequestModel(logOperationSearchRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogDoConfigLogSearch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogDoConfigLogSearch`: LogOperationResponseModelCollection
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogDoConfigLogSearch`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
logOperationSearchRequestModel	LogOperationSearchRequestModel	Specifies the advanced search parameters.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.
limit	int32	The max number of configuration log entries returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings.
continuationToken	string	If a query cannot be completed, the response will have a ContinuationToken set. To obtain more results from the query, pass the continuation token back into the query to get the next batch of results.
async	bool	If `true`, the search operations will be executed as a background task. The task will have JobType DoOperationSearch. When the task is complete it will redirect to GetJobResults.	[default to false]

Return type

LogOperationResponseModelCollection

Authorization

BearerAuth

HTTP request headers

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

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

ConfigLogExportReportData

CustomReportDataResponseModel ConfigLogExportReportData(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).CustomReportInfoRequestModel(customReportInfoRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Export logging report data in the format of csv/html/both.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    customReportInfoRequestModel := *openapiclient.NewCustomReportInfoRequestModel(openapiclient.CustomReportFormatType("Html"), openapiclient.CustomReportDateRangeType("All")) // CustomReportInfoRequestModel | CustomReportInfoRequest CustomReportInfoRequestModel
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogExportReportData(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).CustomReportInfoRequestModel(customReportInfoRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogExportReportData``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogExportReportData`: CustomReportDataResponseModel
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogExportReportData`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
customReportInfoRequestModel	CustomReportInfoRequestModel	CustomReportInfoRequest CustomReportInfoRequestModel
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.

Return type

CustomReportDataResponseModel

Authorization

BearerAuth

HTTP request headers

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

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

ConfigLogFetchExistingOperationLabels

[]string ConfigLogFetchExistingOperationLabels(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Refresh(refresh).Async(async).Execute()

Fetch existing high level log operation labels.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)
    refresh := true // bool | If 'true', force fetching labels from all high level log operations and refresh the label cache, Otherwise, return labels directly from cache. (optional) (default to false)
    async := true // bool | If 'true', the fetching existing operation labels will be executed as a background task. The task wil have JobTypeFetchExistingOperationLabels. When the task is complete it will redirect to GetJobResults. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogFetchExistingOperationLabels(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Refresh(refresh).Async(async).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogFetchExistingOperationLabels``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogFetchExistingOperationLabels`: []string
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogFetchExistingOperationLabels`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.
refresh	bool	If 'true', force fetching labels from all high level log operations and refresh the label cache, Otherwise, return labels directly from cache.	[default to false]
async	bool	If 'true', the fetching existing operation labels will be executed as a background task. The task wil have JobTypeFetchExistingOperationLabels. When the task is complete it will redirect to GetJobResults.	[default to false]

Return type

[]string

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogGetFirstLogDate

string ConfigLogGetFirstLogDate(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Get first log date

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogGetFirstLogDate(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogGetFirstLogDate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogGetFirstLogDate`: string
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogGetFirstLogDate`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.

Return type

string

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogGetLogSite

LogSiteResponseModel ConfigLogGetLogSite(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Get logging site details. This on-prem only API.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogGetLogSite(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogGetLogSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogGetLogSite`: LogSiteResponseModel
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogGetLogSite`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.

Return type

LogSiteResponseModel

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogGetLowLevelOperations

LowLevelOperationResponseModelCollection ConfigLogGetLowLevelOperations(ctx, id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Execute()

Get the detailed low level operations of a high level operation.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    id := "id_example" // string | id of specified high level operation
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)
    limit := int32(56) // int32 | The max number of low level operations returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings. (optional)
    continuationToken := "continuationToken_example" // string | The continuationToken returned by the previous query. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogGetLowLevelOperations(context.Background(), id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogGetLowLevelOperations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogGetLowLevelOperations`: LowLevelOperationResponseModelCollection
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogGetLowLevelOperations`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	id of specified high level operation

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.

userAgent | string | User Agent type of the request. | authorization | string | Citrix authorization header: CWSAuth Bearer={token} | citrixTransactionId | string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | accept | string | Must accept application/json. | citrixLocale | string | Locale of the request. | limit | int32 | The max number of low level operations returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings. | continuationToken | string | The continuationToken returned by the previous query. |

Return type

LowLevelOperationResponseModelCollection

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogGetOperation

LogOperationResponseModel ConfigLogGetOperation(ctx, id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Get a high level log operation.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    id := "id_example" // string | ID of the operation.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogGetOperation(context.Background(), id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogGetOperation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogGetOperation`: LogOperationResponseModel
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogGetOperation`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the operation.

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.

userAgent | string | User Agent type of the request. | authorization | string | Citrix authorization header: CWSAuth Bearer={token} | citrixTransactionId | string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | accept | string | Must accept application/json. | citrixLocale | string | Locale of the request. |

Return type

LogOperationResponseModel

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogGetOperations

LogOperationResponseModelCollection ConfigLogGetOperations(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Text(text).Days(days).SearchDateOption(searchDateOption).TimeDiff(timeDiff).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute()

Get configuration log operations.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)
    text := "text_example" // string | Optional; Text pattern to match, which is case-insensitive and may include the wildcard \"*\". If specified, only return records which Text matched pattern. Otherwise, all records will be returned. (optional)
    days := int32(56) // int32 | Optional; Number of days of history to retrieve. Note: This parameter is exclusive with parameter searchDateOption. If neither is specified, all records will be returned. (optional)
    searchDateOption := openapiclient.SearchDateOption("LastMinute") // SearchDateOption | Optional; Specific time filters for searching operations. Note: This parameter is exclusive with parameter days. If neither is specified, all records will be returned. (optional)
    timeDiff := int32(56) // int32 | Optional; The time difference in seconds between client time and UTC time. Note: The value must be a valid UTC offset, e.g. UTC+8, timeDiff=28800; UTC-5, timeDiff=-18000. If not specified, it will be default to 0. (optional)
    limit := int32(56) // int32 | Optional; The max number of operations returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings. (optional)
    continuationToken := "continuationToken_example" // string | If a query cannot be completed, the response will have a ContinuationToken set. To obtain more results from the query, pass the continuation token back into the query to get the next batch of results. (optional)
    async := true // bool | If 'true', the get operations will be executed as a background task. The task wil have JobTypeGetOperations. When the task is complete it will redirect to GetJobResults. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogGetOperations(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Text(text).Days(days).SearchDateOption(searchDateOption).TimeDiff(timeDiff).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogGetOperations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogGetOperations`: LogOperationResponseModelCollection
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogGetOperations`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.
text	string	Optional; Text pattern to match, which is case-insensitive and may include the wildcard "*". If specified, only return records which Text matched pattern. Otherwise, all records will be returned.
days	int32	Optional; Number of days of history to retrieve. Note: This parameter is exclusive with parameter searchDateOption. If neither is specified, all records will be returned.
searchDateOption	SearchDateOption	Optional; Specific time filters for searching operations. Note: This parameter is exclusive with parameter days. If neither is specified, all records will be returned.
timeDiff	int32	Optional; The time difference in seconds between client time and UTC time. Note: The value must be a valid UTC offset, e.g. UTC+8, timeDiff=28800; UTC-5, timeDiff=-18000. If not specified, it will be default to 0.
limit	int32	Optional; The max number of operations returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings.
continuationToken	string	If a query cannot be completed, the response will have a ContinuationToken set. To obtain more results from the query, pass the continuation token back into the query to get the next batch of results.
async	bool	If 'true', the get operations will be executed as a background task. The task wil have JobTypeGetOperations. When the task is complete it will redirect to GetJobResults.	[default to false]

Return type

LogOperationResponseModelCollection

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ConfigLogPatchOperation

ConfigLogPatchOperation(ctx, id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).EditOperationRequestModel(editOperationRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Async(async).Execute()

Update a high level log operation.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    id := "id_example" // string | ID of the operation.
    editOperationRequestModel := *openapiclient.NewEditOperationRequestModel() // EditOperationRequestModel | Details of the operation to update.
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)
    async := true // bool | If `true`, the operation will be updated as a background task. The task will have JobType UpdateOperation. When the task is complete it will redirect to GetOperation. The job's Parameters will contain properties:  * _Id_ - ID of the operation being updated. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogPatchOperation(context.Background(), id).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).EditOperationRequestModel(editOperationRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Async(async).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogPatchOperation``: %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.
id	string	ID of the operation.

Other Parameters

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

Name	Type	Description	Notes
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.

editOperationRequestModel | EditOperationRequestModel | Details of the operation to update. | userAgent | string | User Agent type of the request. | authorization | string | Citrix authorization header: CWSAuth Bearer={token} | citrixTransactionId | string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | accept | string | Must accept application/json. | citrixLocale | string | Locale of the request. | async | bool | If `true`, the operation will be updated as a background task. The task will have JobType UpdateOperation. When the task is complete it will redirect to GetOperation. The job's Parameters will contain properties: * Id - ID of the operation being updated. | [default to false]

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

ConfigLogSetLogSite

LogSiteResponseModel ConfigLogSetLogSite(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).LogSiteRequestModel(logSiteRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Update logging site info. This on-prem only API.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID.
    logSiteRequestModel := *openapiclient.NewLogSiteRequestModel() // LogSiteRequestModel | 
    userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional)
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ConfigLogAPIsDAAS.ConfigLogSetLogSite(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).LogSiteRequestModel(logSiteRequestModel).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ConfigLogAPIsDAAS.ConfigLogSetLogSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfigLogSetLogSite`: LogSiteResponseModel
    fmt.Fprintf(os.Stdout, "Response from `ConfigLogAPIsDAAS.ConfigLogSetLogSite`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description
citrixCustomerId	string	Citrix Customer ID. Default is 'CitrixOnPremises'
citrixInstanceId	string	Citrix Instance (Site) ID.
logSiteRequestModel	LogSiteRequestModel
userAgent	string	User Agent type of the request.
authorization	string	Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId	string	Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept	string	Must accept application/json.
citrixLocale	string	Locale of the request.

Return type

LogSiteResponseModel

Authorization

BearerAuth

HTTP request headers

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

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

Files

ConfigLogAPIsDAAS.md

Latest commit

History

ConfigLogAPIsDAAS.md

File metadata and controls

\ConfigLogAPIsDAAS

ConfigLogDeleteLogs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogDoConfigLogSearch

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogExportReportData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogFetchExistingOperationLabels

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogGetFirstLogDate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogGetLogSite

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogGetLowLevelOperations

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogGetOperation

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogGetOperations

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogPatchOperation

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ConfigLogSetLogSite

Example

Path Parameters