ccrz.ccApiSiteIndex.revise

Updates the status of the Active field on existing site index records. B2B Commerce for Visualforce uses this method in site index batch jobs.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Winter ’21 4.13 12
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

You can still call older versions of the API for this method, which can accept different input keys or return different output keys. Any differences in behavior for older versions aren't documented in this topic.

Note

This method doesn't allow a guest user to update records. If you're creating subscriber code that requires a guest user to update records, you have the following options:

Warning

Signature

global static Map<String, Object> revise(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

ccrz.ccApiSiteIndex.SITE_INDICES
Map<String, ccrz__E_SiteIndex__c>> of the site index records to update.

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING
Map<String, Object> that describes options for sizing and scoping the method's return data. This method supports ccrz.ccApi.SZ_REFETCH => TRUE, which specifies that this method invokes ccrz.ccApiSiteIndex.fetch for returning the updated site index records.
ccrz.ccApi.SIZING => new Map<String, Object>{
    ccrz.ccApiProduct.ENTITYNAME => new Map<String, Object>{
        ccrz.ccApi.SZ_REFETCH => TRUE
    }
}

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 the updated ccrz__E_SiteIndex__c records.

This key is returned only when the input map includes ccrz.ccApi.SZ_REFETCH => true.

Note