ccrz.ccApiSiteIndex.fetch

Compatibility

This reference applies to:

Signature

global static Map<String, Object> fetch(Map<String, Object>)

Service Layer Classes

Data Service Provider

ccrz.ccServiceSiteIndex

Inputs (Required)

Map<String, Object> that must include the following required keys:

ccrz.ccApi.API_VERSION

The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING

Map<String, Object> that specifies the scope of data that this method returns, including which fields the method returns for each record that matches the query.

ccrz.ccApiSiteIndex.ACTIVE

Boolean

Value	Usage
true	Return only site index records where the Active field is enabled.
false	Ignore the value of the Active field when querying site index records.

ccrz.ccApiSiteIndex.CATEGORY_IDS

Set<String> of category IDs whose corresponding site index records you want to query.

ccrz.ccApiSiteIndex.IDS

Set<String> of site index IDs to query.

ccrz.ccApiSiteIndex.LOCALE

String that specifies a locale to query site index records for.

ccrz.ccApiSiteIndex.LOCALES

Set<String> of locales to query site index records for.

ccrz.ccApiSiteIndex.STOREFRONT

String that specifies the name of a storefront for filtering the query.

If the input data doesn't include this key, the method falls back to ccrz.cc_CallContext.storefront.

Note

ccrz.ccApiSiteIndex.URL_HASH

String that specifies a category's hashed friendly URL value to query site index records for. This string matches the value in a site index record's Friendly URL Hash field.

Outputs

Map<String, Object> that can include the following keys:

ccrz.ccApi.API_VERSION

Integer that indicates which API version was used for the query.

ccrz.ccApi.SUCCESS

Boolean

Value	Usage
true	The call completed.
false	The call encountered errors. B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint. Tip

ccrz.ccApiSiteIndex.SITE_INDICES

Map<String, Object> of ccrz__E_SiteIndex__c records that match the query.

To specify which fields the API returns for each site index record, request a specific data size for the ccrz.ccApiSiteIndex.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiSiteIndex.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_M
    }
}

For information about which fields are available with different data sizes, see the ccrz__E_SiteIndex__c reference.

Tip