Skip to content

Latest commit

 

History

History
1114 lines (706 loc) · 35.2 KB

MonitorsLibraryManagementApi.md

File metadata and controls

1114 lines (706 loc) · 35.2 KB
Raw

\MonitorsLibraryManagementApi

All URIs are relative to https://api.au.sumologic.com/api

Method HTTP request Description
DisableMonitorByIds Put /v1/monitors/disable Disable monitors.
GetMonitorUsageInfo Get /v1/monitors/usageInfo Usage info of monitors.
GetMonitorsFullPath Get /v1/monitors/{id}/path Get the path of a monitor or folder.
GetMonitorsLibraryRoot Get /v1/monitors/root Get the root monitors folder.
MonitorsCopy Post /v1/monitors/{id}/copy Copy a monitor or folder.
MonitorsCreate Post /v1/monitors Create a monitor or folder.
MonitorsDeleteById Delete /v1/monitors/{id} Delete a monitor or folder.
MonitorsDeleteByIds Delete /v1/monitors Bulk delete a monitor or folder.
MonitorsExportItem Get /v1/monitors/{id}/export Export a monitor or folder.
MonitorsGetByPath Get /v1/monitors/path Read a monitor or folder by its path.
MonitorsImportItem Post /v1/monitors/{parentId}/import Import a monitor or folder.
MonitorsMove Post /v1/monitors/{id}/move Move a monitor or folder.
MonitorsReadById Get /v1/monitors/{id} Get a monitor or folder.
MonitorsReadByIds Get /v1/monitors Bulk read a monitor or folder.
MonitorsSearch Get /v1/monitors/search Search for a monitor or folder.
MonitorsUpdateById Put /v1/monitors/{id} Update a monitor or folder.

DisableMonitorByIds

DisableMonitorResponse DisableMonitorByIds(ctx).Ids(ids).Execute()

Disable monitors.

Example

package main

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

func main() {
    ids := []string{"Inner_example"} // []string | A comma-separated list of identifiers.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
ids []string A comma-separated list of identifiers.

Return type

DisableMonitorResponse

Authorization

basicAuth

HTTP request headers

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

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

GetMonitorUsageInfo

MonitorUsageInfo GetMonitorUsageInfo(ctx).Execute()

Usage info of monitors.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

MonitorUsageInfo

Authorization

basicAuth

HTTP request headers

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

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

GetMonitorsFullPath

Path GetMonitorsFullPath(ctx, id).Execute()

Get the path of a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder.

Other Parameters

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

Name Type Description Notes

Return type

Path

Authorization

basicAuth

HTTP request headers

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

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

GetMonitorsLibraryRoot

MonitorsLibraryFolderResponse GetMonitorsLibraryRoot(ctx).Execute()

Get the root monitors folder.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

MonitorsLibraryFolderResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsCopy

MonitorsLibraryBaseResponse MonitorsCopy(ctx, id).ContentCopyParams(contentCopyParams).Execute()

Copy a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to copy.
    contentCopyParams := *openapiclient.NewContentCopyParams("ParentId_example") // ContentCopyParams | Fields include:   1) Identifier of the parent folder to copy to.   2) Optionally provide a new name.   3) Optionally provide a new description.   4) Optionally set to true if you want to copy and preserve the locked status. Requires `LockMonitors` capability.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsCopy(context.Background(), id).ContentCopyParams(contentCopyParams).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsCopy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsCopy`: MonitorsLibraryBaseResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsCopy`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder to copy.

Other Parameters

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

Name Type Description Notes

contentCopyParams | ContentCopyParams | Fields include: 1) Identifier of the parent folder to copy to. 2) Optionally provide a new name. 3) Optionally provide a new description. 4) Optionally set to true if you want to copy and preserve the locked status. Requires `LockMonitors` capability. |

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsCreate

MonitorsLibraryBaseResponse MonitorsCreate(ctx).ParentId(parentId).MonitorsLibraryBase(monitorsLibraryBase).Execute()

Create a monitor or folder.

Example

package main

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

func main() {
    parentId := "parentId_example" // string | Identifier of the parent folder in which to create the monitor or folder.
    monitorsLibraryBase := *openapiclient.NewMonitorsLibraryBase("Name_example", "Type_example") // MonitorsLibraryBase | The monitor or folder to create.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsCreate(context.Background()).ParentId(parentId).MonitorsLibraryBase(monitorsLibraryBase).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsCreate`: MonitorsLibraryBaseResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
parentId string Identifier of the parent folder in which to create the monitor or folder.
monitorsLibraryBase MonitorsLibraryBase The monitor or folder to create.

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsDeleteById

MonitorsDeleteById(ctx, id).Execute()

Delete a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to delete.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsDeleteById(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsDeleteById``: %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 Identifier of the monitor or folder to delete.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

MonitorsDeleteByIds

IdToMonitorsLibraryBaseResponseMap MonitorsDeleteByIds(ctx).Ids(ids).Execute()

Bulk delete a monitor or folder.

Example

package main

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

func main() {
    ids := []string{"Inner_example"} // []string | A comma-separated list of identifiers.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
ids []string A comma-separated list of identifiers.

Return type

IdToMonitorsLibraryBaseResponseMap

Authorization

basicAuth

HTTP request headers

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

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

MonitorsExportItem

MonitorsLibraryBaseExport MonitorsExportItem(ctx, id).Execute()

Export a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to export.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder to export.

Other Parameters

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

Name Type Description Notes

Return type

MonitorsLibraryBaseExport

Authorization

basicAuth

HTTP request headers

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

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

MonitorsGetByPath

MonitorsLibraryBaseResponse MonitorsGetByPath(ctx).Path(path).Execute()

Read a monitor or folder by its path.

Example

package main

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

func main() {
    path := "path_example" // string | The path of the monitor or folder.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
path string The path of the monitor or folder.

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsImportItem

MonitorsLibraryBaseResponse MonitorsImportItem(ctx, parentId).MonitorsLibraryBaseExport(monitorsLibraryBaseExport).Execute()

Import a monitor or folder.

Example

package main

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

func main() {
    parentId := "parentId_example" // string | Identifier of the parent folder in which to import the monitor or folder.
    monitorsLibraryBaseExport := *openapiclient.NewMonitorsLibraryBaseExport("Name_example", "Type_example") // MonitorsLibraryBaseExport | The monitor or folder to be imported.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsImportItem(context.Background(), parentId).MonitorsLibraryBaseExport(monitorsLibraryBaseExport).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsImportItem``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsImportItem`: MonitorsLibraryBaseResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsImportItem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
parentId string Identifier of the parent folder in which to import the monitor or folder.

Other Parameters

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

Name Type Description Notes

monitorsLibraryBaseExport | MonitorsLibraryBaseExport | The monitor or folder to be imported. |

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsMove

MonitorsLibraryBaseResponse MonitorsMove(ctx, id).ParentId(parentId).Execute()

Move a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to move.
    parentId := "parentId_example" // string | Identifier of the parent folder to move the monitor or folder to.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsMove(context.Background(), id).ParentId(parentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsMove``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsMove`: MonitorsLibraryBaseResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsMove`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder to move.

Other Parameters

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

Name Type Description Notes

parentId | string | Identifier of the parent folder to move the monitor or folder to. |

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsReadById

MonitorsLibraryBaseResponse MonitorsReadById(ctx, id).Execute()

Get a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to read.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder to read.

Other Parameters

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

Name Type Description Notes

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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

MonitorsReadByIds

IdToMonitorsLibraryBaseResponseMap MonitorsReadByIds(ctx).Ids(ids).Execute()

Bulk read a monitor or folder.

Example

package main

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

func main() {
    ids := []string{"Inner_example"} // []string | A comma-separated list of identifiers.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
ids []string A comma-separated list of identifiers.

Return type

IdToMonitorsLibraryBaseResponseMap

Authorization

basicAuth

HTTP request headers

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

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

MonitorsSearch

ListMonitorsLibraryItemWithPath MonitorsSearch(ctx).Query(query).Limit(limit).Offset(offset).Execute()

Search for a monitor or folder.

Example

package main

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

func main() {
    query := "createdBy:000000000000968B Test" // string | The search query to find monitor or folder. Below is the list of different filters with examples:   - **createdBy** : Filter by the user's identifier who created the content. Example: `createdBy:000000000000968B`.   - **createdBefore** : Filter by the content objects created before the given timestamp(in milliseconds). Example: `createdBefore:1457997222`.   - **createdAfter** : Filter by the content objects created after the given timestamp(in milliseconds). Example: `createdAfter:1457997111`.   - **modifiedBefore** : Filter by the content objects modified before the given timestamp(in milliseconds). Example: `modifiedBefore:1457997222`.   - **modifiedAfter** : Filter by the content objects modified after the given timestamp(in milliseconds). Example: `modifiedAfter:1457997111`.   - **type** : Filter by the type of the content object. Example: `type:folder`.   - **monitorStatus** : Filter by the status of the monitor: Normal, Critical, Warning, MissingData, Disabled, AllTriggered. Example: `monitorStatus:Normal`.  You can also use multiple filters in one query. For example to search for all content objects created by user with identifier 000000000000968B with creation timestamp after 1457997222 containing the text Test, the query would look like:    `createdBy:000000000000968B createdAfter:1457997222 Test`
    limit := int32(10) // int32 | Maximum number of items you want in the response. (optional) (default to 100)
    offset := int32(5) // int32 | The position or row from where to start the search operation. (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsSearch(context.Background()).Query(query).Limit(limit).Offset(offset).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsSearch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsSearch`: ListMonitorsLibraryItemWithPath
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsSearch`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
query string The search query to find monitor or folder. Below is the list of different filters with examples: - createdBy : Filter by the user's identifier who created the content. Example: `createdBy:000000000000968B`. - createdBefore : Filter by the content objects created before the given timestamp(in milliseconds). Example: `createdBefore:1457997222`. - createdAfter : Filter by the content objects created after the given timestamp(in milliseconds). Example: `createdAfter:1457997111`. - modifiedBefore : Filter by the content objects modified before the given timestamp(in milliseconds). Example: `modifiedBefore:1457997222`. - modifiedAfter : Filter by the content objects modified after the given timestamp(in milliseconds). Example: `modifiedAfter:1457997111`. - type : Filter by the type of the content object. Example: `type:folder`. - monitorStatus : Filter by the status of the monitor: Normal, Critical, Warning, MissingData, Disabled, AllTriggered. Example: `monitorStatus:Normal`. You can also use multiple filters in one query. For example to search for all content objects created by user with identifier 000000000000968B with creation timestamp after 1457997222 containing the text Test, the query would look like: `createdBy:000000000000968B createdAfter:1457997222 Test`
limit int32 Maximum number of items you want in the response. [default to 100]
offset int32 The position or row from where to start the search operation. [default to 0]

Return type

ListMonitorsLibraryItemWithPath

Authorization

basicAuth

HTTP request headers

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

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

MonitorsUpdateById

MonitorsLibraryBaseResponse MonitorsUpdateById(ctx, id).MonitorsLibraryBaseUpdate(monitorsLibraryBaseUpdate).Execute()

Update a monitor or folder.

Example

package main

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

func main() {
    id := "id_example" // string | Identifier of the monitor or folder to update.
    monitorsLibraryBaseUpdate := *openapiclient.NewMonitorsLibraryBaseUpdate("Name_example", int64(123), "Type_example") // MonitorsLibraryBaseUpdate | The monitor or folder to update. The content version must match its latest version number in the monitors library. If the version does not match it will not be updated.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.MonitorsLibraryManagementApi.MonitorsUpdateById(context.Background(), id).MonitorsLibraryBaseUpdate(monitorsLibraryBaseUpdate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MonitorsLibraryManagementApi.MonitorsUpdateById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonitorsUpdateById`: MonitorsLibraryBaseResponse
    fmt.Fprintf(os.Stdout, "Response from `MonitorsLibraryManagementApi.MonitorsUpdateById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the monitor or folder to update.

Other Parameters

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

Name Type Description Notes

monitorsLibraryBaseUpdate | MonitorsLibraryBaseUpdate | The monitor or folder to update. The content version must match its latest version number in the monitors library. If the version does not match it will not be updated. |

Return type

MonitorsLibraryBaseResponse

Authorization

basicAuth

HTTP request headers

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

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