Jump to

• Request
• Response
• Examples

Create an Keyword Redirect Entry.

post

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

Create a new keyword redirect entry in the specified redirect group

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• redirectEntry: string
  Specifies the redirect entry name.
• redirectGroup: string
  Specifies the redirect group name, for example, Default

Body ()

The keyword redirect entry to be created in the redirect group.

Root Schema : RedirectEntry

Type: object

Represents a Redirect Entry configuration.

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: redirect-entry
• enableStemming(optional): boolean
  Property that specifies if the search terms needs to be expanded.
• matchmode(optional): 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(optional): object searchTermExpansions
  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(optional): string
  Configured search term against which the user entered search term would be matched.
• siteIds(optional): array siteIds
  Specifies the list of site IDs that this redirect entry belongs to
• url(optional): string
  The URL to which users are redirected when the user entered search term matches with configured search terms.

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"redirect-entry"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        },
        "searchTerms":{
            "type":"string",
            "description":"Configured search term against which the user entered search term would be matched."
        },
        "matchmode":{
            "type":"string",
            "description":"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."
        },
        "url":{
            "type":"string",
            "description":"The URL to which users are redirected when the user entered search term matches with configured search terms."
        },
        "enableStemming":{
            "type":"boolean",
            "description":"Property that specifies if the search terms needs to be expanded."
        },
        "searchTermExpansions":{
            "type":"object",
            "description":"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":{
            }
        },
        "siteIds":{
            "type":"array",
            "description":"Specifies the list of site IDs that this redirect entry belongs to",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Represents a Redirect Entry configuration."
}

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.

Show Source

{
    "type":"object",
    "description":"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":{
    }
}

Nested Schema : siteIds

Type: array

Specifies the list of site IDs that this redirect entry belongs to

Show Source

• Array of: string

{
    "type":"array",
    "description":"Specifies the list of site IDs that this redirect entry belongs to",
    "items":{
        "type":"string"
    }
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Keyword Redirect Entry successfully created.

Body ()

Root Schema : Response

Type: object

Show Source

• message(optional): string
• status(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

Examples

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

curl -X POST -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 configuration of a redirect-entry object that can be input to an endpoint in either ZIP or JSON format:

{
  "ecr:type": "redirect-entry",
  "searchTerms": "fujifilm",
  "matchmode": "MATCHEXACT",
  "url": "/browse/Fujifilm/_/N-1z141wh"
}

Back to Top