Partial update Keyword Redirect Entry.

patch

/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}

Partial update keyword redirect entry configuration in the specified redirect group.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

redirectEntry

Type: string

Required: true

Specifies the redirect entry name.

redirectGroup

Type: string

Required: true

Specifies the redirect group name, for example, Default

Body Parameter

The request body represents the partially updated redirect entry.

Root Schema : RedirectEntry

Type: object

Represents a Redirect Entry configuration.

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: redirect-entry

enableStemming

Type: boolean

Property that specifies if the search terms needs to be expanded.

matchmode

Type: string

The type of match between the specified search terms value and the search term that the user enters. Must be one of the values from MATCHEXACT, MATCHPHRASE, MATCHALL.

searchTermExpansions

Type: object searchTermExpansions

Additional Properties Allowed:

Specifies the possible different forms of the configured search terms. This property is used by assembler in rule evaluation process to match user specified search term against any of these forms.

searchTerms

Type: string

Configured search term against which the user entered search term would be matched.

url

Type: string

The URL to which users are redirected when the user entered search term matches with configured search terms.

Nested Schema : searchTermExpansions

Type: object

Specifies the possible different forms of the configured search terms. This property is used by assembler in rule evaluation process to match user specified search term against any of these forms.

Properties

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

202 Response

Keyword Redirect Entry successfully updated.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

Examples

The following example shows how to update a redirect-entry object named id4 in the default redirect group using cURL:

curl -X PATCH -H "Authorization:Bearer access_token" -H "Content-Type:application/json" -d@pathname/filename.json http://host:port/gsadmin/v1/cloud/redirects/Default/id4

Request Body Example

The following example shows the modification to the configuration of the redirect-entry object named id4. The URL is changed from N-1z141wh to N-1z162xy:

{
  "ecr:type": "redirect-entry",
  "url": "/browse/Fujifilm/_/N-1z162xy"
}