Jump to

• Request
• Response
• Examples

Partial update Keyword Redirect Group.

patch

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

Partial update keyword redirect group configuration of the specified application's redirects.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

The request body represents the partially updated redirects.

Root Schema : RedirectGroup

Type: object

Represents a Redirect Group configuration. Child Nodes represent Redirect Entry configuration confirming to RedirectEntry JSON schema

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: redirect-group

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"redirect-group"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a Redirect Group configuration. Child Nodes represent Redirect Entry configuration confirming to RedirectEntry JSON schema"
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Keyword Redirect Group successfully updated.

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

A PATCH endpoint cannot access an object through its parent object. Thus, you cannot use this endpoint to modify the redirect-entry objects contained in the redirect-group object. The following request generates an error:

PATCH /gsadmin/v1/cloud/redirects/Default

Request Body Example

{
  "ecr:type": "redirect-group",
  "id1": {
    "ecr:type": "redirect-entry",
    "url": "/browse/Canon/_/N-1z162xy",
    },
  "id2": {
    "ecr:type": "redirect-entry",
    "searchTerms": "contact",
    }
}

Back to Top