Jump to

• Request
• Response

getGroup

get

/ccadmin/v1/hreflangGroups/{id}

Get Hreflang Group. This operation is used to get single hreflang group from Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Hreflang group id.

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

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