Jump to

• Request
• Response
• Examples

Partial update Keyword Redirects Configuration

patch

/gsadmin/v1/{appName}/redirects

Partial updates redirects configuration of the specified application.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Body ()

The request body represents the partially updated redirects configuration.

Root Schema : Redirects

Type: object

Represents an application's Keyword Redirects configuration. Child Nodes represent Redirect Group configuration confirming to RedirectGroup JSON schema

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: redirects

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"redirects"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents an application's Keyword Redirects configuration. Child Nodes represent Redirect Group configuration confirming to RedirectGroup JSON schema"
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Keyword Redirects 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 or redirect-group objects contained in the redirects object. The following request generates an error:

PATCH /gsadmin/v1/cloud/redirects

Request Body

{
  "ecr:type": "redirects",
  "Default": {
    "ecr:type": "redirect-group",
    "id1": {
      "ecr:type": "redirect-entry",
      "url": "/browse/kodak/_/N-1z141wh"
     }
  },
}

Back to Top