Jump to

• Request
• Response

getSiteGroups

get

/ccadmin/v1/siteGroups

Get the list of available site groups.

Request

Supported Media Types

• application/json

Query Parameters

• production(optional): boolean
  If this flag is set to true, site groups will be returned from the production DB. The default value is false.
• q(optional): string
  A SCIM filter string for selecting a subset of all site groups. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Examples: Get all site groups whose displayName contains US: q=displayName co "US" Get all site groups with siteUSEast as a member: q=sites co "siteUSEast" Text and site ID values appearing in SCIM filters should be quoted. The following site group properties can be used in a q query: * displayName * id * sites The sharedCart property cannot be used in a q query.
• showTranslations(optional): boolean
  Boolean indicating if the translations property should be returned for each item in the response. The default value is false.

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getSiteGroups_response

Type: object

Show Source

• items(optional): array items
  The list of available site groups
• limit(optional): integer
  The limit
• offset(optional): integer
  The offset
• sort(optional): array sort
  Array having the order and property of sites.
• total(optional): integer
  The total count
• totalResults(optional): integer
  The total results count

{
    "properties":{
        "total":{
            "description":"The total count",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total results count",
            "type":"integer"
        },
        "offset":{
            "description":"The offset",
            "type":"integer"
        },
        "limit":{
            "description":"The limit",
            "type":"integer"
        },
        "sort":{
            "description":"Array having the order and property of sites.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property sorted on.",
                        "type":"string"
                    },
                    "order":{
                        "description":"The sort order: either asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"The list of available site groups",
            "type":"array",
            "items":{
                "$ref":"#/definitions/siteGroup_response"
            }
        }
    }
}

Nested Schema : items

Type: array

The list of available site groups

Show Source

• Array of: object siteGroup_response

{
    "description":"The list of available site groups",
    "type":"array",
    "items":{
        "$ref":"#/definitions/siteGroup_response"
    }
}

Nested Schema : sort

Type: array

Array having the order and property of sites.

Show Source

• Array of: object items

{
    "description":"Array having the order and property of sites.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property sorted on.",
                "type":"string"
            },
            "order":{
                "description":"The sort order: either asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : siteGroup_response

Type: object

Show Source

• displayName(optional): string
  Site group name.
• id(optional): string
  ID of the site group.
• sharedCart(optional): boolean
  True if the member sites can share the shopping cart.
• sites(optional): array sites
  List of sites that are members of the group.

{
    "properties":{
        "displayName":{
            "description":"Site group name.",
            "type":"string"
        },
        "sharedCart":{
            "description":"True if the member sites can share the shopping cart.",
            "type":"boolean"
        },
        "sites":{
            "description":"List of sites that are members of the group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The site name.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The site ID.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"ID of the site group.",
            "type":"string"
        }
    }
}

Nested Schema : sites

Type: array

List of sites that are members of the group.

Show Source

• Array of: object items

{
    "description":"List of sites that are members of the group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The site name.",
                "type":"string"
            },
            "id":{
                "description":"The site ID.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The site ID.
• name(optional): string
  The site name.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The site name.",
            "type":"string"
        },
        "id":{
            "description":"The site ID.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  The sort order: either asc or desc.
• property(optional): string
  The property sorted on.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property sorted on.",
            "type":"string"
        },
        "order":{
            "description":"The sort order: either asc or desc.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "displayName":"Cart sharing group for US sites",
            "sharedCart":true,
            "sites":[
                {
                    "name":"East site",
                    "id":"siteUSEast"
                },
                {
                    "name":"Central site",
                    "id":"siteUSCentral"
                },
                {
                    "name":"West site",
                    "id":"siteUSWest"
                }
            ],
            "id":"cartGroupUS"
        },
        {
            "displayName":"Cart sharing group for EU sites",
            "sharedCart":true,
            "sites":[
                {
                    "name":"French site",
                    "id":"siteFrance"
                },
                {
                    "name":"Italian site",
                    "id":"siteItaly"
                },
                {
                    "name":"Spanish site",
                    "id":"siteSpain"
                },
                {
                    "name":"Portuguese site",
                    "id":"sitePortugal"
                },
                {
                    "name":"German site",
                    "id":"siteGermany"
                }
            ],
            "id":"cartGroupEU"
        }
    ]
}

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