Global Dictionary REST APIs

This endpoint returns all the key value pairs stored in the global dictionary for a site.

/rest/v17/globalDict

This endpoint supports the following query specifications. For more information, see Manage Collections.

• q - Declares a query specification expression.

• excludeLinks - Exclude links from the response.

• fields - A list of fields to be returned. The value is a comma delimited string and each token is a field name.

• limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum.

• offset – The offset of the page. By default, offset is 0, which means first page will be returned.

• orderby – Specifies a comma-separated list of fields to order the response by.

• totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified

None

This endpoint returns a value stored in the global dictionary corresponding to the given key along with the minTimeToLive value.

/rest/v17/globalDict/{key}

The string value key of the global dictionary

None

This endpoint adds or updates the global dictionary key values defined for the site. To update an existing global dictionary key value, the Upsert-Mode header parameter must be set to True. If set to False, only new global dictionary key values are added.

/rest/v17/globalDict

To only add new dictionary key values, the upsert-mode header parameter must be set to False.

To update existing global dictionary key values, the upsert-mode header parameter must be set to True.

(Required) The name of the global dictionary key

.

(Optional) The minimum time, in minutes, the key-value pair is guaranteed to exist in the global dictionary. Default value is 1440 minutes.

(Required) The value associated with the key

This endpoint deletes global dictionary key value defined for the site.

/rest/v17/globalDict/{key}

The name of the global dictionary key that you want to delete

None