All URIs are relative to https://intersight.com
| Method | HTTP request | Description |
|---|---|---|
| GetForecastCatalogByMoid | Get /api/v1/forecast/Catalogs/{Moid} | Read a 'forecast.Catalog' resource. |
| GetForecastCatalogList | Get /api/v1/forecast/Catalogs | Read a 'forecast.Catalog' resource. |
| GetForecastDefinitionByMoid | Get /api/v1/forecast/Definitions/{Moid} | Read a 'forecast.Definition' resource. |
| GetForecastDefinitionList | Get /api/v1/forecast/Definitions | Read a 'forecast.Definition' resource. |
| GetForecastInstanceByMoid | Get /api/v1/forecast/Instances/{Moid} | Read a 'forecast.Instance' resource. |
| GetForecastInstanceList | Get /api/v1/forecast/Instances | Read a 'forecast.Instance' resource. |
| PatchForecastInstance | Patch /api/v1/forecast/Instances/{Moid} | Update a 'forecast.Instance' resource. |
| UpdateForecastInstance | Post /api/v1/forecast/Instances/{Moid} | Update a 'forecast.Instance' resource. |
ForecastCatalog GetForecastCatalogByMoid(ctx, moid).Execute()
Read a 'forecast.Catalog' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
moid := "moid_example" // string | The unique Moid identifier of a resource instance.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastCatalogByMoid(context.Background(), moid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastCatalogByMoid``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastCatalogByMoid`: ForecastCatalog
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastCatalogByMoid`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| moid | string | The unique Moid identifier of a resource instance. |
Other parameters are passed through a pointer to a apiGetForecastCatalogByMoidRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastCatalogResponse GetForecastCatalogList(ctx).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
Read a 'forecast.Catalog' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
filter := "$filter=CreateTime gt 2012-08-29T21:58:33Z" // string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (optional) (default to "")
orderby := "$orderby=CreationTime" // string | Determines what properties are used to sort the collection of resources. (optional)
top := int32($top=10) // int32 | Specifies the maximum number of resources to return in the response. (optional) (default to 100)
skip := int32($skip=100) // int32 | Specifies the number of resources to skip in the response. (optional) (default to 0)
select_ := "$select=CreateTime,ModTime" // string | Specifies a subset of properties to return. (optional) (default to "")
expand := "$expand=DisplayNames" // string | Specify additional attributes or related resources to return in addition to the primary resources. (optional)
apply := "apply_example" // string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. (optional)
count := false // bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. (optional)
inlinecount := "$inlinecount=true" // string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (optional) (default to "allpages")
at := "at=VersionType eq 'Configured'" // string | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. (optional)
tags := "tags_example" // string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastCatalogList(context.Background()).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastCatalogList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastCatalogList`: ForecastCatalogResponse
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastCatalogList`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetForecastCatalogListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). | [default to ""] |
| orderby | string | Determines what properties are used to sort the collection of resources. | |
| top | int32 | Specifies the maximum number of resources to return in the response. | [default to 100] |
| skip | int32 | Specifies the number of resources to skip in the response. | [default to 0] |
| select_ | string | Specifies a subset of properties to return. | [default to ""] |
| expand | string | Specify additional attributes or related resources to return in addition to the primary resources. | |
| apply | string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The "$apply" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are "aggregate" and "groupby". The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. | |
| count | bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. | |
| inlinecount | string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. | [default to "allpages"] |
| at | string | Similar to "$filter", but "at" is specifically used to filter versioning information properties for resources to return. A URI with an "at" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. | |
| tags | string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. |
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastDefinition GetForecastDefinitionByMoid(ctx, moid).Execute()
Read a 'forecast.Definition' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
moid := "moid_example" // string | The unique Moid identifier of a resource instance.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastDefinitionByMoid(context.Background(), moid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastDefinitionByMoid``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastDefinitionByMoid`: ForecastDefinition
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastDefinitionByMoid`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| moid | string | The unique Moid identifier of a resource instance. |
Other parameters are passed through a pointer to a apiGetForecastDefinitionByMoidRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastDefinitionResponse GetForecastDefinitionList(ctx).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
Read a 'forecast.Definition' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
filter := "$filter=CreateTime gt 2012-08-29T21:58:33Z" // string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (optional) (default to "")
orderby := "$orderby=CreationTime" // string | Determines what properties are used to sort the collection of resources. (optional)
top := int32($top=10) // int32 | Specifies the maximum number of resources to return in the response. (optional) (default to 100)
skip := int32($skip=100) // int32 | Specifies the number of resources to skip in the response. (optional) (default to 0)
select_ := "$select=CreateTime,ModTime" // string | Specifies a subset of properties to return. (optional) (default to "")
expand := "$expand=DisplayNames" // string | Specify additional attributes or related resources to return in addition to the primary resources. (optional)
apply := "apply_example" // string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. (optional)
count := false // bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. (optional)
inlinecount := "$inlinecount=true" // string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (optional) (default to "allpages")
at := "at=VersionType eq 'Configured'" // string | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. (optional)
tags := "tags_example" // string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastDefinitionList(context.Background()).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastDefinitionList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastDefinitionList`: ForecastDefinitionResponse
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastDefinitionList`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetForecastDefinitionListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). | [default to ""] |
| orderby | string | Determines what properties are used to sort the collection of resources. | |
| top | int32 | Specifies the maximum number of resources to return in the response. | [default to 100] |
| skip | int32 | Specifies the number of resources to skip in the response. | [default to 0] |
| select_ | string | Specifies a subset of properties to return. | [default to ""] |
| expand | string | Specify additional attributes or related resources to return in addition to the primary resources. | |
| apply | string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The "$apply" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are "aggregate" and "groupby". The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. | |
| count | bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. | |
| inlinecount | string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. | [default to "allpages"] |
| at | string | Similar to "$filter", but "at" is specifically used to filter versioning information properties for resources to return. A URI with an "at" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. | |
| tags | string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. |
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastInstance GetForecastInstanceByMoid(ctx, moid).Execute()
Read a 'forecast.Instance' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
moid := "moid_example" // string | The unique Moid identifier of a resource instance.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastInstanceByMoid(context.Background(), moid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastInstanceByMoid``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastInstanceByMoid`: ForecastInstance
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastInstanceByMoid`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| moid | string | The unique Moid identifier of a resource instance. |
Other parameters are passed through a pointer to a apiGetForecastInstanceByMoidRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastInstanceResponse GetForecastInstanceList(ctx).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
Read a 'forecast.Instance' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
filter := "$filter=CreateTime gt 2012-08-29T21:58:33Z" // string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). (optional) (default to "")
orderby := "$orderby=CreationTime" // string | Determines what properties are used to sort the collection of resources. (optional)
top := int32($top=10) // int32 | Specifies the maximum number of resources to return in the response. (optional) (default to 100)
skip := int32($skip=100) // int32 | Specifies the number of resources to skip in the response. (optional) (default to 0)
select_ := "$select=CreateTime,ModTime" // string | Specifies a subset of properties to return. (optional) (default to "")
expand := "$expand=DisplayNames" // string | Specify additional attributes or related resources to return in addition to the primary resources. (optional)
apply := "apply_example" // string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are \"aggregate\" and \"groupby\". The **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The **groupby** transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. (optional)
count := false // bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. (optional)
inlinecount := "$inlinecount=true" // string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. (optional) (default to "allpages")
at := "at=VersionType eq 'Configured'" // string | Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return. A URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. (optional)
tags := "tags_example" // string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.GetForecastInstanceList(context.Background()).Filter(filter).Orderby(orderby).Top(top).Skip(skip).Select_(select_).Expand(expand).Apply(apply).Count(count).Inlinecount(inlinecount).At(at).Tags(tags).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.GetForecastInstanceList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetForecastInstanceList`: ForecastInstanceResponse
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.GetForecastInstanceList`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetForecastInstanceListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | string | Filter criteria for the resources to return. A URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the $filter option. The expression language that is used in $filter queries supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false). | [default to ""] |
| orderby | string | Determines what properties are used to sort the collection of resources. | |
| top | int32 | Specifies the maximum number of resources to return in the response. | [default to 100] |
| skip | int32 | Specifies the number of resources to skip in the response. | [default to 0] |
| select_ | string | Specifies a subset of properties to return. | [default to ""] |
| expand | string | Specify additional attributes or related resources to return in addition to the primary resources. | |
| apply | string | Specify one or more transformation operations to perform aggregation on the resources. The transformations are processed in order with the output from a transformation being used as input for the subsequent transformation. The "$apply" query takes a sequence of set transformations, separated by forward slashes to express that they are consecutively applied, i.e., the result of each transformation is the input to the next transformation. Supported aggregation methods are "aggregate" and "groupby". The aggregate transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns a result set with a single instance, representing the aggregated value for all instances in the input set. The groupby transformation takes one or two parameters and 1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter, 2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality, 3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group, 4. Concatenates the intermediate result sets into one result set. A groupby transformation affects the structure of the result set. | |
| count | bool | The $count query specifies the service should return the count of the matching resources, instead of returning the resources. | |
| inlinecount | string | The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response. | [default to "allpages"] |
| at | string | Similar to "$filter", but "at" is specifically used to filter versioning information properties for resources to return. A URI with an "at" Query Option identifies a subset of the Entries from the Collection of Entries identified by the Resource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate expression specified by the query option. The expression language that is used in at operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations shown in the Abstract Type System section. | |
| tags | string | The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key. |
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: Not defined
- Accept: application/json, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastInstance PatchForecastInstance(ctx, moid).ForecastInstance(forecastInstance).IfMatch(ifMatch).Execute()
Update a 'forecast.Instance' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
moid := "moid_example" // string | The unique Moid identifier of a resource instance.
forecastInstance := *openapiclient.NewForecastInstance("ClassId_example", "ObjectType_example") // ForecastInstance | The 'forecast.Instance' resource to update.
ifMatch := "ifMatch_example" // string | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.PatchForecastInstance(context.Background(), moid).ForecastInstance(forecastInstance).IfMatch(ifMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.PatchForecastInstance``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchForecastInstance`: ForecastInstance
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.PatchForecastInstance`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| moid | string | The unique Moid identifier of a resource instance. |
Other parameters are passed through a pointer to a apiPatchForecastInstanceRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
forecastInstance | ForecastInstance | The 'forecast.Instance' resource to update. | ifMatch | string | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. |
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: application/json, application/json-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ForecastInstance UpdateForecastInstance(ctx, moid).ForecastInstance(forecastInstance).IfMatch(ifMatch).Execute()
Update a 'forecast.Instance' resource.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/CiscoDevNet/intersight-go"
)
func main() {
moid := "moid_example" // string | The unique Moid identifier of a resource instance.
forecastInstance := *openapiclient.NewForecastInstance("ClassId_example", "ObjectType_example") // ForecastInstance | The 'forecast.Instance' resource to update.
ifMatch := "ifMatch_example" // string | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ForecastApi.UpdateForecastInstance(context.Background(), moid).ForecastInstance(forecastInstance).IfMatch(ifMatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ForecastApi.UpdateForecastInstance``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateForecastInstance`: ForecastInstance
fmt.Fprintf(os.Stdout, "Response from `ForecastApi.UpdateForecastInstance`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| moid | string | The unique Moid identifier of a resource instance. |
Other parameters are passed through a pointer to a apiUpdateForecastInstanceRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
forecastInstance | ForecastInstance | The 'forecast.Instance' resource to update. | ifMatch | string | For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request. |
http_signature, cookieAuth, oAuth2, oAuth2
- Content-Type: application/json, application/json-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]