All URIs are relative to https://localhost/cloudapi
| Method | HTTP request | Description |
|---|---|---|
| GetPreference | Get /1.0.0/preferences/{classifier} | Get specified user preference. |
| GetPreferenceDefinition | Get /1.0.0/definitions/preferences/{preferenceDefinitionId} | Get specified preference definition. |
| QueryPreferenceDefinitions | Get /1.0.0/definitions/preferences | Get list of preference definitions. |
| QueryPreferences | Get /1.0.0/preferences | Query user preferences. |
| UpdatePreference | Put /1.0.0/preferences/{classifier} | Update specified user preference |
Preference GetPreference(ctx, classifier) Get specified user preference.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| classifier | string |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PreferenceDefinition GetPreferenceDefinition(ctx, preferenceDefinitionId) Get specified preference definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| preferenceDefinitionId | string |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PreferenceDefinitions QueryPreferenceDefinitions(ctx, page, pageSize, optional) Get list of preference definitions.
Get list of preference definitions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| page | int32 | Page to fetch, zero offset. | [default to 1] |
| pageSize | int32 | Results per page to fetch. | [default to 25] |
| optional | *PreferencesApiQueryPreferenceDefinitionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PreferencesApiQueryPreferenceDefinitionsOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Filter for a query. FIQL format. | sortAsc | optional.String| Field to use for ascending sort | sortDesc | optional.String| Field to use for descending sort |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Preferences QueryPreferences(ctx, optional) Query user preferences.
Query user preferences
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *PreferencesApiQueryPreferencesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PreferencesApiQueryPreferencesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| filter | optional.String | Filter for a query. FIQL format. |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Preference UpdatePreference(ctx, updatePreferenceParams, classifier) Update specified user preference
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| updatePreferenceParams | Preference | ||
| classifier | string |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]