Jump to

• Request
• Response

List head page tags.

get

/ccadmin/v1/sites/{siteId}/headTags

List the page tags in the head section of the specified site.

Request

Supported Media Types

• application/json

Path Parameters

• siteId(required): string
  The repository ID of the site whose page tags are listed.

Query Parameters

• fields: string
  This controls which fields are returned in the response body.
• limit: integer
  This is the field to specify the number of records to be fetched per REST call.
• offset: integer
  This field specifies the offset/starting index from which the data to be fetched.
• q: string
  The search query string in SCIM format. Results will be filtered based on this query.
• sort: string
  This field specifies the sort order of the list to be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listPageTags_response

Type: object

Show Source

• items: array items
  The list of page tags in the head section of this site
• limit: integer
  The limit
• offset: integer
  The offset
• sort: array sort
  Array having the order and property of sites.
• total: integer
  The total count
• totalResults: 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 page tags in the head section of this site",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The name of the page tag",
                        "type":"integer"
                    },
                    "id":{
                        "description":"The page tag id generated on the server",
                        "type":"string"
                    },
                    "enabled":{
                        "description":"Whether the page tag should appear in the site's HTML",
                        "type":"boolean"
                    },
                    "content":{
                        "description":"The page tag HTML",
                        "type":"string"
                    },
                    "order":{
                        "description":"1-based position of the page tag in the page tag list",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of page tags in the head section of this site

Show Source

• Array of: object items

{
    "description":"The list of page tags in the head section of this site",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The name of the page tag",
                "type":"integer"
            },
            "id":{
                "description":"The page tag id generated on the server",
                "type":"string"
            },
            "enabled":{
                "description":"Whether the page tag should appear in the site's HTML",
                "type":"boolean"
            },
            "content":{
                "description":"The page tag HTML",
                "type":"string"
            },
            "order":{
                "description":"1-based position of the page tag in the page tag list",
                "type":"integer"
            }
        }
    }
}

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 : items

Type: object

Show Source

• content: string
  The page tag HTML
• enabled: boolean
  Whether the page tag should appear in the site's HTML
• id: string
  The page tag id generated on the server
• name: integer
  The name of the page tag
• order: integer
  1-based position of the page tag in the page tag list

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the page tag",
            "type":"integer"
        },
        "id":{
            "description":"The page tag id generated on the server",
            "type":"string"
        },
        "enabled":{
            "description":"Whether the page tag should appear in the site's HTML",
            "type":"boolean"
        },
        "content":{
            "description":"The page tag HTML",
            "type":"string"
        },
        "order":{
            "description":"1-based position of the page tag in the page tag list",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order: string
  The sort order: either asc or desc.
• property: 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)

{
    "totalResults":1,
    "offset":0,
    "limit":20,
    "items":[
        {
            "name":"taya tag",
            "id":"8571b3a7-0a74-4516-978c-5090f31d8faf",
            "enabled":true,
            "content":"",
            "order":1
        }
    ]
}

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| |------------------|------------------| |52900|The page tag repository was not initialized.| |529010|The site ID in the path is invalid.| |52912|Missing request.| |52901|An error occurred performing the tag query.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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