Jump to

• Request
• Response

updateGroup

put

/ccadmin/v1/hreflangGroups/{id}

Updates hreflang group.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Hreflang group id.

Body ()

Root Schema : createGroup_request

Type: object

Show Source

• groupMembers: array groupMembers
  The list of hreflang groups members
• groupName: string
  Group name

{
    "properties":{
        "groupMembers":{
            "description":"The list of hreflang groups members",
            "type":"array",
            "items":{
                "$ref":"#/definitions/groupMemberObject"
            }
        },
        "groupName":{
            "description":"Group name",
            "type":"string"
        }
    },
    "required":[
        "groupName",
        "groupMembers"
    ]
}

Nested Schema : groupMembers

Type: array

The list of hreflang groups members

Show Source

• Array of: object groupMemberObject

{
    "description":"The list of hreflang groups members",
    "type":"array",
    "items":{
        "$ref":"#/definitions/groupMemberObject"
    }
}

Nested Schema : groupMemberObject

Type: object

Show Source

• localeId: string
  ID of the locale.
• siteId: string
  ID of the site.
• xDefault(optional): boolean
  Flag indicating if it is a default group member.

{
    "properties":{
        "xDefault":{
            "description":"Flag indicating if it is a default group member.",
            "type":"boolean"
        },
        "siteId":{
            "description":"ID of the site.",
            "type":"string"
        },
        "localeId":{
            "description":"ID of the locale.",
            "type":"string"
        }
    },
    "required":[
        "localeId",
        "siteId"
    ],
    "example":{
        "xDefault":false,
        "siteId":"siteB",
        "localeId":"14"
    }
}

Example:

{
    "xDefault":false,
    "siteId":"siteB",
    "localeId":"14"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getGroup_response

Type: object

Show Source

• groupMembers(optional): array groupMembers
  The list of hreflang groups members
• groupName(optional): string
  Group name
• id(optional): string
  ID.

{
    "type":"object",
    "properties":{
        "groupMembers":{
            "description":"The list of hreflang groups members",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "xDefault":{
                        "description":"Flag indicating if it is a default group member.",
                        "type":"boolean"
                    },
                    "siteId":{
                        "description":"ID of the site.",
                        "type":"string"
                    },
                    "localeId":{
                        "description":"ID of the locale.",
                        "type":"string"
                    }
                }
            }
        },
        "groupName":{
            "description":"Group name",
            "type":"string"
        },
        "id":{
            "description":"ID.",
            "type":"string"
        }
    }
}

Nested Schema : groupMembers

Type: array

The list of hreflang groups members

Show Source

• Array of: object items

{
    "description":"The list of hreflang groups members",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "xDefault":{
                "description":"Flag indicating if it is a default group member.",
                "type":"boolean"
            },
            "siteId":{
                "description":"ID of the site.",
                "type":"string"
            },
            "localeId":{
                "description":"ID of the locale.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• localeId(optional): string
  ID of the locale.
• siteId(optional): string
  ID of the site.
• xDefault(optional): boolean
  Flag indicating if it is a default group member.

{
    "type":"object",
    "properties":{
        "xDefault":{
            "description":"Flag indicating if it is a default group member.",
            "type":"boolean"
        },
        "siteId":{
            "description":"ID of the site.",
            "type":"string"
        },
        "localeId":{
            "description":"ID of the locale.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "groupMembers":[
        {
            "xDefault":false,
            "repositoryId":"siteB:14",
            "siteId":"siteB",
            "localeId":"14"
        },
        {
            "xDefault":true,
            "repositoryId":"siteB:16",
            "siteId":"siteB",
            "localeId":"16"
        }
    ],
    "groupName":"Test group 2",
    "repositoryId":"200002",
    "id":"200002"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |183100|Cannot modify hreflang groups because a publish is currently in progress.| |183101|Unexpected error returned processing hreflang groups.| |183104|Group with name ''{0}'' already exists.| |183105|Error parsing input request.| |183106|No default site-language combination has been selected.| |183107|There can be only one default site-language combination.| |183108|Site {0} does not exist.| |183109|Locale {0} does not exist.| |183110|Site ID cannot be empty.| |183111|Locale ID cannot be empty.| |183112|Group name cannot be empty.| |183113|Locale ''{0}'' is not associated with site ''{1}''.| |183114|Locale ''{0}'' and site ''{1}'' is already associated with an existing group.| |183115|Multiple references of locale ''{0}''.| |183116|Group ''{0}'' does not exist.| |

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top