Module preferences

filters: A list of filters that are logically combined by an operator.

operator: The logical operator that is used to combine the filters.

must: List of queries to be evaluated as an AND operator.

mustNot: List of queries to be evaluated as a NOT operator.

should: List of queries to be evaluated as an OR operator.

groupId: The ID of the preference group.

id: The Preference Id.

value: The value for the Preference Id.

data: The list of custom preferences in the search result.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

customerListId: The customer list identifier

• Min Length: 1
• Max Length: 256

title: The title of the customer list link

• Max Length: 256

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

• Max Length: 256

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

detail: A human-readable explanation specific to this occurrence of the problem.

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

boolFilter:

queryFilter:

range2Filter:

rangeFilter:

termFilter:

filter:

query:

path: The path to the nested document.

• Max Length: 2048

query:

scoreMode: Indicates how scores for matching child objects affect the root parent document’s relevance score.

id: The user supplied ID of the attribute

• Min Length: 1
• Max Length: 256

effectiveId: The effective ID, which is c_id if the attribute is custom, and just the id otherwise

• Max Length: 256

displayName:

description:

key: Flag indicating if this is a key attribute

mandatory: Flag indicating if a value is mandatory for the attribute

localizable: Flag indicating if this attribute can be localized

siteSpecific: Flag indicating if this attribute is site-specific

searchable: Flag indicating if this attribute is searchable

queryable: Returns true if the attribute definition is explicitly marked queryable or if the attribute value type belongs to a queryable type. Computed and read-only.

valueType:

visible: Flag indicating if this attribute is visible

system: Flag indicating if this attribute is a system attribute

unit:

requiresEncoding: Flag indicating if this attribute can be encoded using the encoding='off' flag in ISML templates

multiValueType: True if the attribute can have multiple values. Applicable to set_of_* and enum_of_* types.

setValueType: Flag indicating if this attribute is of type 'Set of'

externallyManaged: Flag indicating if this attribute is externally managed

externallyDefined: Flag indicating if this attribute is externally defined

orderRequired: Flag indicating if this attribute is required for order of the attribute model's product

regularExpression: A regular expression that defines the legal values for this attribute

• Max Length: 4000

fieldLength: The length of the field for this attribute in the editor

fieldHeight: The height of the field for this attribute in the editor

minLength: The minimum length of the field for this attribute

readOnly: Flag indicating if this attribute is read-only

minValue: The minimum possible value for this attribute

maxValue: The maximum possible value for this attribute

scale: The minimum number of fraction digits for a value of this attribute

defaultValue: The default value of this attribute. It can be updated, but not created.

valueDefinitions: A set of values that are possible for this attribute

creationDate: The date/time when the attribute definition was created

lastModified: The date/time when the attribute definition was last modified

id: The ID of the attribute value

• Max Length: 256

value: The value of the attribute

• Max Length: 4000

displayValue:

description:

position: The position of the attribute value within the set of attribute values

sitePreferences: The list of site-specific preferences, returned when expand=sites.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

query:

sorts: The sorting that was applied to the result.

hits: The sorted array of search hits. Can be empty.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

id: The preference attribute ID

• Min Length: 1
• Max Length: 256

description:

displayName:

attributeDefinition:

siteValues: A mapping of site IDs to their preference values.

valueType:

hits: The sorted array of search hits. Can be empty.

query:

sorts: The sorting that was applied to the result.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

boolQuery:

filteredQuery:

matchAllQuery: Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints.

nestedQuery:

termQuery:

textQuery:

query:

filterMode: Compare mode: overlap, containing, or contained.

fromField: The field name of the field that starts the first range.

• Max Length: 260

fromInclusive: A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to false.

fromValue: The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.

toField: The field name of the field that ends the first range.

• Max Length: 260

toInclusive: A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to false.

toValue: The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.

field: The search field.

• Max Length: 260

from:

fromInclusive: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to false.

to:

toInclusive: A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to false.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

limit: Maximum records to retrieve per request, not to exceed 200.

query:

sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.

offset: The zero-based index of the first hit/data to include in the result.

id: The ID of the site.

• Min Length: 1
• Max Length: 32

displayName:

description:

customerListLink: The link to the customer list

inDeletion: Specifies whether the site status is in deletion (true) or not (false)

storefrontStatus: Status of the storefront

siteCatalogId: The catalog bound to the given site.

• Min Length: 1
• Max Length: 256

cartridges: The cartridge names assigned to a site delemited by ':'.

• Max Length: 4000

creationDate: The timestamp when the site was created.

lastModified: The timestamp when the site was last modified.

site:

field: The name of the field to sort on.

• Max Length: 256

sortOrder: The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.

field: The filter field.

• Max Length: 260

operator: The operator used to compare the field's values with the given values.

values: The filter values.

fields: The document fields that the values are matched against, combined with the operator.

operator: Returns the operator to use for the term query.

values: The values that the fields are compared against, combined with the operator.

fields: The document fields that the search phrase matches against.

searchPhrase: A search phrase, which can include multiple terms separated by spaces.