Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 4.6 KB

FilterAPI.md

File metadata and controls

81 lines (51 loc) · 4.6 KB

FilterAPI

All URIs are relative to http://csp.infoblox.com/api/ddi/v1

Method HTTP request Description
List Get /dhcp/filter Retrieve DHCP filters.

List

ListFilterResponse List(ctx).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).TorderBy(torderBy).Tfilter(tfilter).Execute()

Retrieve DHCP filters.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {

	apiClient := ipam.NewAPIClient()
	resp, r, err := apiClient.FilterAPI.List(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FilterAPI.List``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `List`: ListFilterResponse
	fmt.Fprintf(os.Stdout, "Response from `FilterAPI.List`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
fields string A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
filter string A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: Op
offset int32 The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
limit int32 The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
pageToken string The service-defined string used to identify a page of resources. A null value indicates the first page.
orderBy string A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order.
torderBy string This parameter is used for sorting by tags.
tfilter string This parameter is used for filtering by tags.

Return type

ListFilterResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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