openapi: 3.2.0
info:
  title: Acoustic Authoring sites API
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  description: 'Operations tagged Authoring sites across 2 of this provider''s published API definitions: acoustic-content-openapi-original.json, acoustic-content-swagger2-original.yaml. Each path carries the servers of the definition it was published in.'
tags:
- name: Authoring sites
  description: 'Use the Content authoring sites service Rest APIs to work with sites. Sites are comprised of a site metadata and a hierarchy of pages. You can retrieve or update site metadata and create, read, update, and delete site pages belonging to a site. The out-of-the-box site has an ID of ''default''.

    '
paths:
  /authoring/v1/sites:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: Get list of all sites
      description: 'Returns a list of all sites. A default site with id ''default'' exists out of the box.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: fields
        in: query
        description: 'Reduce the returned site metadata down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string.

          To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.

          '
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                title: List of available sites
                description: List of available sites
                properties:
                  items:
                    type: array
                    items:
                      title: Site Metadata
                      description: Site Metadata
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the site.
                        rev:
                          type: string
                          description: The current revision of the document.
                        name:
                          type: string
                          description: The name of the site.
                        classification:
                          type: string
                          description: This is always `site`
                        lastModified:
                          type: string
                          description: The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                        lastModifierId:
                          type: string
                          description: This is the user id of the user that modified the site metadata. This field is read only
                        created:
                          type: string
                          description: The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                        creatorId:
                          type: string
                          description: This is the user id of the user that created the site metadata. This field is read only.
                        routingMode:
                          type: string
                          description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
              examples:
                response:
                  value:
                    items:
                    - name: default
                      classification: site
                      routingMode: anchor
                      lastModified: '2017-09-11T14:03:04.348Z'
                      lastModifierId: 00000000-0000-0000-0000-000000000009
                      created: '2017-09-11T14:03:04.348Z'
                      creatorId: 00000000-0000-0000-0000-000000000009
                      id: default
                      rev: 1-76a0d8566675d83395d8878fab7d4e5e
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Create a new site
      description: 'Use this endpoint to create a new site.


        The new site can either be an initial draft site which has no associated ready version or

        it can be a draft of an existing ready site.


        The body of the request should contain the metadata for the new site.

        This metadata should include the site ''name'', ''linkedDocId'' is optional, ''id'' is optional.

        If ''linkedDocId'' is provided, then the site created will be a draft of the ready site specified in ''linkedDocId''.

        If ''linkedDocId'' is not provided, then the site created will be an initial draft site i.e no ready version exists yet.

        If ID is provided, and a draft of the default site is being created it must start with default.

        ''linkedDocId'' must be set to ''default''.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: copySourceSiteId
        in: query
        description: 'If ‘copySourceSiteId’ is specified when creating a site then a new site is created and all the pages from the source site are copied into the new site.

          '
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: Creating Site Metadata
              description: Create Site Metadata
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the site. If creating a draft of the default site the id must start with default.
                linkedDocId:
                  type: string
                  description: The linkedDocId for draft sites. This is an optional field, if provided specify the ID of the ready site to create a draft of.
                name:
                  type: string
                  description: The name of the site. This is a required field.
                status:
                  type: string
                  description: The status of the site metadata (i.e. draft)
                routingMode:
                  type: string
                  description: The is routingMode the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
        description: The metadata for the new site
        required: true
      responses:
        '201':
          description: succcess.
          content:
            application/json:
              schema:
                title: Site Metadata
                description: Site Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the site.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the site.
                  classification:
                    type: string
                    description: This is always `site`
                  lastModified:
                    type: string
                    description: The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the site metadata. This field is read only
                  created:
                    type: string
                    description: The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the site metadata. This field is read only.
                  routingMode:
                    type: string
                    description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
              examples:
                response:
                  value:
                    name: default
                    routingMode: anchor
                    storeId: ''
                    storeIdentifier: ''
                    linkedDocId: default
                    classification: site
                    lastModified: '2018-07-17T15:17:02.203Z'
                    lastModifierId: d30a541e-ff2e-45a8-a0eb-52952a3cd6eb
                    creatorId: 00000000-0000-0000-0000-000000000009
                    created: '2018-07-16T15:56:20.009Z'
                    status: ready
                    id: default:fc81b9d3-76a7-4bd1-8ddc-a23cc9e4b101
                    rev: 68-8f553a9520a1f3be3b21fd6cc8684dd5
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - errorKey: SITE_ITEM_INVALID_ERROR
                      code: 2003
                      statusCode: '400'
                      message: Site metadata supplied is invalid, the 'linkedDocId' may be missing or empty.
                      messageParameters:
                        field: linkedDocId
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '69982173950058'
                    errors:
                    - code: 2096
                      message: 'Unable to create site with ID: default:fc81b9d3-76a7-4bd1-8ddc-a23cc9e4b101 due to a conflict.'
                      level: ERROR
                      description: Unable to create the specified site due to a conflict with an existing item. You may have attempted to create the site but the site already exists.
                      locale: en
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: Retrieve metadata for a site.
      description: 'Retrieve the site metadata for an existing site. A default site with ID ''default'' exists out-of-the-box.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: fields
        in: query
        description: 'Optional. Only the site metadata fields that are specified here are returned for each result. Any site metadata field is a valid value and can be specified as a comma-separated list. Field names should only be specified once in the list.


          For example, to only retrieve `name` and `rev` this parameter should look like `fields=name,rev`.

          '
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: Site Metadata
                description: Site Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the site.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the site.
                  classification:
                    type: string
                    description: This is always `site`
                  lastModified:
                    type: string
                    description: The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the site metadata. This field is read only
                  created:
                    type: string
                    description: The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the site metadata. This field is read only.
                  routingMode:
                    type: string
                    description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
              examples:
                response:
                  value:
                    name: default
                    classification: site
                    routingMode: anchor
                    lastModified: '2017-09-11T14:03:04.348Z'
                    lastModifierId: 00000000-0000-0000-0000-000000000009
                    created: '2017-09-11T14:03:04.348Z'
                    creatorId: 00000000-0000-0000-0000-000000000009
                    id: default
                    rev: 1-76a0d8566675d83395d8878fab7d4e5e
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    put:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Update metadata for a site.
      description: 'Update the metadata for an existing site. A default site with ID ''default'' exists out-of-the-box.


        The update data must include the `rev` and `name` metadata fields.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: Content-Type
        in: header
        description: Content type of the request body, should be 'application/json'
        required: true
        schema:
          type: string
      - name: forceOverride
        in: query
        description: 'Force update of the existing site metadata without requiring the current `rev` value.

          When set to `true` this request will overwrite the stored site metadata regardless of a difference in revisions.

          '
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              title: Updating Site Metadata
              description: Updating Site Metadata
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the site.
                rev:
                  type: string
                  description: The current revision of the document. This is a required field.
                name:
                  type: string
                  description: The name of the site. This is a required field.
                routingMode:
                  type: string
                  description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
        description: Provide the updated site metadata in the body of the request. The current revision (`rev`) and the site name (`name`) fields must be provided in order to update the site metadata.
        required: true
      responses:
        '200':
          description: Success, returns updated site
          content:
            application/json:
              schema:
                title: Site Metadata update response
                description: Site Metadata update response
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the site.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the site.
                  classification:
                    type: string
                    description: this is always `site`
                  routingMode:
                    type: string
                    description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
              examples:
                response:
                  value:
                    name: default
                    id: default
                    rev: 22-ae719cf45c00a55eda54d6480976b3e1
                    classification: site
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2003
                      message: Site metadata supplied is invalid
                      level: ERROR
                      description: The site metadata supplied is invalid. Provide a valid site metadata value and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2051
                      message: 'Unable to update site with ID: default due to a conflict.'
                      level: ERROR
                      description: Unable to update the specified site due to a conflict with an existing item. You may have attempted to update the site with an older version. Resolve the conflict and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    delete:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Delete a site and the site pages
      description: 'Use this endpoint to delete a site and the pages in that site.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Site successfully deleted.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '409':
          description: conflict
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 6016
                      message: Some of the pages for site dummyId could not be deleted.
                      level: ERROR
                      description: A site with the specified ID could not be deleted as some of the pages in the site could not be deleted. Please try again.
                      locale: en
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/ready:
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Promote the site and pages metadata from draft to ready status.
      description: 'Use this endpoint to change the status of a site''s metadata and the metadata of all pages in the site from draft to ready.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the draft site.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully changed the status of the site from draft to ready.
          content:
            application/json:
              schema:
                title: Site Metadata
                description: Site Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the site.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the site.
                  classification:
                    type: string
                    description: This is always `site`
                  lastModified:
                    type: string
                    description: The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the site metadata. This field is read only
                  created:
                    type: string
                    description: The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the site metadata. This field is read only.
                  routingMode:
                    type: string
                    description: The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'.  With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455571'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/cancel:
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Cancel the draft site metadata undoing any modifications.
      description: 'Use this endpoint to undo changes to the site''s metadata.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the draft site.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully cancelled the draft site metadata.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455571'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages/ready:
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Bulk promote the specified page Ids in the specified site from draft to ready status.
      description: 'Use this endpoint to change the status of multiple pages in a specific site from draft to ready.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the draft site.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              title: List of draft page ids in specified site to ready
              description: Publish the list of draft page Ids
              type: object
              properties:
                ids:
                  type: array
                  description: List of draft page Ids
                  items:
                    type: string
        description: The array of draft page Ids to ready
        required: true
      responses:
        '204':
          description: Successfully changed the status of all specified pages in the site from draft to ready.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455571'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: 'Get the full page hierarchy for a site.

        '
      description: 'Use this endpoint to retrieve the full page hierarchy for site. The metadata for each page will be included. This metadata includes the position of the page relative to its peers, the ID for the page content item, an optional override layout ID to use and encoded route if query parameter included=route is specified.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: fields
        in: query
        description: Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      - name: include
        in: query
        description: 'Specify additional fields to include with each result. The following fields can be specified to be included in the page item: ''hierarchicalPath'', ''route''.

          You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.

          The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

          '
        required: false
        schema:
          type: string
      - name: responseFormat
        in: query
        description: Specify the format for the response. Valid values are 'hierarchical' and 'list'. Default is 'hierarchical'.
        required: false
        schema:
          type: string
          default: hierarchical
      responses:
        '200':
          description: succcess.
          content:
            application/json:
              schema:
                type: object
                title: Hierachy of pages in the site
                description: Hierachy of pages in the site
                properties:
                  items:
                    type: array
                    items:
                      title: Hierarchical Page Metadata
                      description: Page Metadata of page in hierarchy
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the page item.
                        rev:
                          type: string
                          description: The current revision of the document.
                        name:
                          type: string
                          description: The name of the page item.
                        contentId:
                          type: string
                          description: The ID of the page content item this item represents.
                        contentTypeId:
                          type: string
                          description: The ID of the page content type.
                        position:
                          type: string
                          description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                        description:
                          type: string
                          description: Page description.
                        layoutId:
                          type: string
                          description: Page layout template ID.
                        segment:
                          type: string
                          description: Friendly URL segment.
                        title:
                          type: string
                          description: Page title.
                        parentId:
                          type: string
                          description: Not present if root page otherwise id of parent page
                        classification:
                          type: string
                          description: This is always `page`
                        children:
                          type: array
                          items:
                            type: object
                          description: This is an array of the hierarchical child pages of this hierarchical page
                        hideFromNavigation:
                          type: boolean
                          description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    items:
                    - id: 1067771c-ec05-4671-951b-18f503953f2d
                      rev: 22-ae719cf45c00a55eda54d6480976b3e1
                      name: home
                      segment: home
                      contentTypeId: ab7288e3-42r3-h34s-72nm-34vfk4gf894g
                      description: home page
                      layoutId: 7655c56d-39ee-4c4d-8689-00bd1c08e6ff
                      title: Home Page
                      contentId: 68eb88a6-31d8-4e47-ad5f-da932081b68d
                      route: /home
                      position: 0
                      classification: page
                      hideFromNavigation: false
                      children:
                      - id: aw67771c-ec05-4671-951b-18fqwq53f2d
                        rev: 20-axz19cf45c00a55eda54d6480976b3e1
                        name: products
                        segment: products
                        contentTypeId: dffa969c-32fc-4079-8a57-eb85ad136ae8
                        description: products page
                        layoutId: 13c46fbe-db14-4a24-859f-f4b847a2b843
                        title: Products Page
                        contentId: 76sd88a6-31d8-4e47-ad5f-da932081b68d
                        route: /home/products
                        parentId: 1067771c-ec05-4671-951b-18f503953f2d
                        position: 0
                        hideFromNavigation: false
                        children: []
                    - id: 1067771c-ec05-4671-951b-18f632153f2d
                      rev: 22-ae719cf45c00a55eda54d6480ab6b3e1
                      name: search results
                      segment: search-results
                      contentTypeId: ab7288e3-4ar3-h34s-72nm-3fvf3agf894g
                      description: search results page
                      layoutId: 7655c56d-39ee-4c4d-8689-00be1c0854ff
                      title: Search Results
                      contentId: 68b192a6-31d8-4e47-ad5f-da472081b68d
                      route: /search-results
                      position: 0
                      classification: page
                      hideFromNavigation: true
                      children: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      summary: Create a page.
      description: 'Use this endpoint to create a page in a specified site. The body of the request should contain the metadata for the new page.

        This metadata should include the page ''name'', optional ''position'' relative to its peers and the ''contentId'' or ''contentTypeId''.

        Specify ''contentId'' to associate an existing content item with the page or specify ''contentTypeId'' to create an empty content item using the specified content type.

        The ''position'' field is optional, value is an integer value starting at 0. If not set position is set to the last sibling position.

        The ''layoutId'' field is also optional. If not set the selected layout for the new content item will be the default layout mapped to the specified content type.

        If the ''layoutId'' field is specified it must be the ID of an existing layout. If the specified layout is not mapped to the content type then the default layout mapped to the content type will be used instead.

        <br />User roles: admin, manager'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: cloneContentId
        in: query
        description: 'Clone the provided content item and to use the clone for this new page.

          If ''contentId'' is set on the body, it is ignored and replaced with the id of the newly cloned content Item

          A non zero length value for ''contentTypeId'' in the body must be specified to satisify the API requirements.

          '
        required: false
        schema:
          type: string
      - name: copySourcePageId
        in: query
        description: 'If ‘copySourcePageId’ is specified when creating a page then a new page is created by making a deep copy of the source page and its content.

          '
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: Create Page Metadata
              description: Creation of Page Metadata
              type: object
              properties:
                name:
                  type: string
                  description: The name of the page.
                contentId:
                  type: string
                  description: (Optional) The ID of the page content item to be associated with the new page. Specify this field when the new page is to be associated with an existing page content item.
                contentTypeId:
                  type: string
                  description: (Optional) The ID of the page content type to be used to create the new page content item for the new page. Specify this field when a page content item does not already exist.
                position:
                  type: string
                  description: (Optional) The position of the page relative to its sibling pages. Position is an integer value starting at 0.
                description:
                  type: string
                  description: Page description.
                layoutId:
                  type: string
                  description: (Optional) Page layout template ID for the new page content item. If not specified the default layout mapped to the content type will be used.
                segment:
                  type: string
                  description: Friendly URL segment.
                title:
                  type: string
                  description: Page title.
                parentId:
                  type: string
                  description: (Optional) The ID of the parent page. This should not be set if the new page is to be a root page. Otherwise, set this field to the ID of the parent page.
                hideFromNavigation:
                  type: boolean
                  description: (Optional) This controls the visibility of the page in the site navigation menu. Set it to `true` to hide the page. The default setting (if this field is not supplied) is `false`. If to `true` set on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
        description: The metadata for the new page.
        required: true
      responses:
        '201':
          description: succcess.
          content:
            application/json:
              schema:
                title: Page Metadata
                description: Page Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the page item.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the page item.
                  contentId:
                    type: string
                    description: The ID of the page content item this item represents.
                  contentTypeId:
                    type: string
                    description: The ID of the page content type.
                  position:
                    type: string
                    description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                  description:
                    type: string
                    description: Page description.
                  layoutId:
                    type: string
                    description: Page layout template ID.
                  segment:
                    type: string
                    description: Friendly URL segment.
                  title:
                    type: string
                    description: Page title.
                  parentId:
                    type: string
                    description: Not present if root page otherwise id of parent page
                  classification:
                    type: string
                    description: This is always `page`
                  lastModified:
                    type: string
                    description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the page. This field is read only
                  created:
                    type: string
                    description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the page. This field is read only.
                  hideFromNavigation:
                    type: boolean
                    description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    id: aw67771c-ec05-4671-951b-18fqwq53f2d
                    rev: 1-axz19cf45c30a58eda54d6480974b3e1
                    name: products
                    segment: products
                    contentTypeId: dffa969c-32fc-4079-8a57-eb85ad136ae8
                    description: products page
                    layoutId: 13c46fbe-db14-4a24-859f-f4b847a2b843
                    title: Products Page
                    contentId: 76sd88a6-31d8-4e47-ad5f-da932081b68d
                    parentId: 1067771c-ec05-4671-951b-18f503953f2d
                    position: 0
                    hideFromNavigation: false
                    classification: page
                    lastModified: '2017-09-11T14:03:04.348Z'
                    lastModifierId: 00000000-0000-0000-0000-000000000009
                    created: '2017-09-11T14:03:04.348Z'
                    creatorId: 00000000-0000-0000-0000-000000000009
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages/views/by-modified:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: Get pages modified between two dates.
      description: 'Returns the page metadata for pages modified between the specified last modified date range in the site specified by `site-id`.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: start
        in: query
        description: Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.
        required: false
        schema:
          type: string
          format: date-time
      - name: end
        in: query
        description: Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.
        required: false
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        description: Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      - name: order
        in: query
        description: 'Specify whether you want the page items to be returned in ascending or descending order.

          Documents are returned in ascending order by default.

          Supported order values are ''asc'', ''ascending'', ''desc'' and ''descending''

          e.g. /sites/dummySitesId/pages/views/by-modified?order=descending returns the pages in descending order.

          '
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Set the limit for the maximum number of items to return in a single result. The default value is 50. Use 0 for unlimited. If offset and limit are not set, all results are returned.
        required: false
        schema:
          type: number
          format: integer
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of items to skip from the beginning of the list and return the rest. The default value is 0. If offset and limit are not set, all results are returned.
        required: false
        schema:
          type: number
          format: integer
      - name: include
        in: query
        description: 'Specify additional fields to include with each result. The following fields can be specified to be included in the page item: ''hierarchicalPath'', ''route''.

          You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.

          The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: succcess.
          content:
            application/json:
              schema:
                type: object
                title: Modified pages list
                description: A list of pages in the site modified between certain dates
                properties:
                  items:
                    type: array
                    items:
                      title: Page Metadata
                      description: Page Metadata
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the page item.
                        rev:
                          type: string
                          description: The current revision of the document.
                        name:
                          type: string
                          description: The name of the page item.
                        contentId:
                          type: string
                          description: The ID of the page content item this item represents.
                        contentTypeId:
                          type: string
                          description: The ID of the page content type.
                        position:
                          type: string
                          description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                        description:
                          type: string
                          description: Page description.
                        layoutId:
                          type: string
                          description: Page layout template ID.
                        segment:
                          type: string
                          description: Friendly URL segment.
                        title:
                          type: string
                          description: Page title.
                        parentId:
                          type: string
                          description: Not present if root page otherwise id of parent page
                        classification:
                          type: string
                          description: This is always `page`
                        lastModified:
                          type: string
                          description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                        lastModifierId:
                          type: string
                          description: This is the user id of the user that modified the page. This field is read only
                        created:
                          type: string
                          description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                        creatorId:
                          type: string
                          description: This is the user id of the user that created the page. This field is read only.
                        hideFromNavigation:
                          type: boolean
                          description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    items:
                    - id: 1067771c-ec05-4671-951b-18f503953f2d
                      rev: 22-ae719cf45c00a55eda54d6480976b3e1
                      name: home
                      segment: home
                      contentTypeId: ab7288e3-42r3-h34s-72nm-34vfk4gf894g
                      description: home page
                      layoutId: 7655c56d-39ee-4c4d-8689-00bd1c08e6ff
                      title: Home Page
                      contentId: 68eb88a6-31d8-4e47-ad5f-da932081b68d
                      position: 0
                      hideFromNavigation: false
                      classification: page
                    - id: 2867771c-ec05-4671-951b-18f500053f2d
                      rev: 20-ae719cf45c00a55eda54d6350976b3e1
                      name: About Us
                      segment: about-us
                      contentTypeId: ab7288e3-42r3-h34s-72nm-34vfk4gf894g
                      description: About Us page
                      layoutId: 7655c56d-39ee-4c4d-8689-00bd1c08e6ff
                      title: About Us
                      contentId: 68eb88a6-31d8-441e-ad5f-da932081b68d
                      position: 1
                      hideFromNavigation: false
                      classification: page
                    - id: 35575721-ec45-9871-921b-18f500053f4d
                      rev: 20-ae7a9cff5c00a55eda5dd6350976b3a1
                      name: Our Events
                      segment: our-events
                      contentTypeId: ab2748e3-42r3-h34s-72nm-34vfk4gf457g
                      description: Events page
                      layoutId: 7655c56d-39ee-4c4d-8689-00bd1c08e6ff
                      title: Our Events page
                      contentId: 62ab38a6-34a8-121e-dc32-de441563f6ad
                      position: 0
                      parentId: 1067771c-ec05-4671-951b-18f503953f2d
                      hideFromNavigation: false
                      classification: page
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2005
                      message: Invalid site ID parameter provided.
                      level: ERROR
                      description: The site ID provided is invalid. The site ID value cannot be empty or contain spaces. Provide a valid site ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2002
                      message: 'Site not found for ID: dummyId'
                      level: ERROR
                      description: A site with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages/{page-id}:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: Get a page by id.
      description: 'Returns the page metadata specified by `page-id` in the site specified by `site-id`.


        If the page is a root page then no parentId will be returned in the response.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: page-id
        in: path
        description: ID of page.
        required: true
        schema:
          type: string
          format: uuid
      - name: fields
        in: query
        description: 'Reduce the returned page metadata down to just the specified fields.

          Fields specified by a comma seperated list of field names and should only be used once in query string.

          To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.

          '
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      - name: include
        in: query
        description: 'Specify additional fields to include with each result. The following fields can be specified to be included in the page item: ''hierarchicalPath'', ''route''.

          You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.

          The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: succcess.
          content:
            application/json:
              schema:
                title: Page Metadata
                description: Page Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the page item.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the page item.
                  contentId:
                    type: string
                    description: The ID of the page content item this item represents.
                  contentTypeId:
                    type: string
                    description: The ID of the page content type.
                  position:
                    type: string
                    description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                  description:
                    type: string
                    description: Page description.
                  layoutId:
                    type: string
                    description: Page layout template ID.
                  segment:
                    type: string
                    description: Friendly URL segment.
                  title:
                    type: string
                    description: Page title.
                  parentId:
                    type: string
                    description: Not present if root page otherwise id of parent page
                  classification:
                    type: string
                    description: This is always `page`
                  lastModified:
                    type: string
                    description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the page. This field is read only
                  created:
                    type: string
                    description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the page. This field is read only.
                  hideFromNavigation:
                    type: boolean
                    description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    id: aw67771c-ec05-4671-951b-18fqwq53f2d
                    rev: 20-axz19cf45c00a55eda54d6480976b3e1
                    name: products
                    segment: products
                    contentTypeId: dffa969c-32fc-4079-8a57-eb85ad136ae8
                    description: products page
                    layoutId: 13c46fbe-db14-4a24-859f-f4b847a2b843
                    title: Products Page
                    contentId: 76sd88a6-31d8-4e47-ad5f-da932081b68d
                    parentId: 1067771c-ec05-4671-951b-18f503953f2d
                    position: 0
                    hideFromNavigation: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2011
                      message: Invalid page ID parameter provided.
                      level: ERROR
                      description: The page ID provided is missing or invalid. The page ID cannot be empty or contain spaces. Provide a valid page ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    delete:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Delete a page.
      description: 'Deletes the page specified by `page-id` and all descendant pages in the site specified by `site-id`.

        By default the page and descendant pages associated content is not deleted, set ''delete-content'' query parameter to ''true'' to delete the page and descendant pages associated content.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: page-id
        in: path
        description: ID of page.
        required: true
        schema:
          type: string
          format: uuid
      - name: delete-content
        in: query
        description: Set to true to delete associated content. If delete-content is not specified the default is to not delete the associated content.
        required: false
        schema:
          type: boolean
      responses:
        '204':
          description: Page successfully deleted.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2011
                      message: Invalid page ID parameter provided.
                      level: ERROR
                      description: The page ID provided is missing or invalid. The page ID cannot be empty or contain spaces. Provide a valid page ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 6001
                      message: 'There was a conflict deleting page: dummyId and its child pages.'
                      level: ERROR
                      description: 'Unable to delete the page: {pageId} and its child pages due to conflict. Resolve the conflict and try again.'
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
    put:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Update a page.
      description: 'Updates the page metadata specified by `page-id` in the site specified by `site-id`.

        Move of a page to a different parent or repositioning with other sibling pages is not supported, use the move endpoint instead.

        The full page metadata must be supplied, partial updates are not supported.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: page-id
        in: path
        description: ID of page.
        required: true
        schema:
          type: string
          format: uuid
      - name: forceOverride
        in: query
        description: 'Force update of the existing page metadata without requiring the current rev value.

          When set to `true` this request will overwrite the stored page metadata regardless of a difference in revisions.

          '
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              title: Update of Page Metadata
              description: Update of Page Metadata
              type: object
              properties:
                name:
                  type: string
                  description: The name of the page.
                id:
                  type: string
                  description: The ID of the page item.
                rev:
                  type: string
                  description: (Optional) The revision of the document.
                position:
                  type: string
                  description: The position of the page relative to its sibling pages. Position is an integer value starting at 0.
                description:
                  type: string
                  description: Page description.
                layoutId:
                  type: string
                  description: Page layout template ID.
                contentId:
                  type: string
                  description: The ID of the page content item this item represents.
                contentTypeId:
                  type: string
                  description: The ID of the page content type.
                segment:
                  type: string
                  description: Friendly URL segment.
                title:
                  type: string
                  description: Page title.
                parentId:
                  type: string
                  description: (Optional) The ID of the parent page. This should not be set if the new page is to be a root page. Otherwise, set this field to the ID of the parent page.
                classification:
                  type: string
                  description: this is always `page`
                hideFromNavigation:
                  type: boolean
                  description: (Optional) This controls the visibility of the page in the site navigation menu. Set it to `true` to hide the page. The default setting (if this field is not supplied) is `false`. If to `true` set on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
        description: The metadata for the updated page.
        required: true
      responses:
        '200':
          description: Page successfully updated.
          content:
            application/json:
              schema:
                title: Page Metadata
                description: Page Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the page item.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the page item.
                  contentId:
                    type: string
                    description: The ID of the page content item this item represents.
                  contentTypeId:
                    type: string
                    description: The ID of the page content type.
                  position:
                    type: string
                    description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                  description:
                    type: string
                    description: Page description.
                  layoutId:
                    type: string
                    description: Page layout template ID.
                  segment:
                    type: string
                    description: Friendly URL segment.
                  title:
                    type: string
                    description: Page title.
                  parentId:
                    type: string
                    description: Not present if root page otherwise id of parent page
                  classification:
                    type: string
                    description: This is always `page`
                  lastModified:
                    type: string
                    description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the page. This field is read only
                  created:
                    type: string
                    description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the page. This field is read only.
                  hideFromNavigation:
                    type: boolean
                    description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    id: aw67771c-ec05-4671-951b-18fqwq53f2d
                    rev: 20-axz19cf45c00a55eda54d6480976b3e1
                    name: products
                    segment: products
                    contentTypeId: dffa969c-32fc-4079-8a57-eb85ad136ae8
                    description: products page
                    layoutId: 13c46fbe-db14-4a24-859f-f4b847a2b843
                    title: Products Page
                    contentId: 76sd88a6-31d8-4e47-ad5f-da932081b68d
                    parentId: 1067771c-ec05-4671-951b-18f503953f2d
                    hideFromNavigation: false
                    position: 0
                    classification: page
                    lastModified: '2017-09-11T14:03:04.348Z'
                    lastModifierId: 00000000-0000-0000-0000-000000000009
                    created: '2017-09-11T14:03:04.348Z'
                    creatorId: 00000000-0000-0000-0000-000000000009
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2011
                      message: Invalid page ID parameter provided.
                      level: ERROR
                      description: The page ID provided is missing or invalid. The page ID cannot be empty or contain spaces. Provide a valid page ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: 1067771c-ec05-4671-951b-18f503953f2d'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2025
                      message: 'The page with ID: 1067771c-ec05-4671-951b-18f503953f2d has a different ''rev'' value than the one supplied.'
                      level: ERROR
                      description: Unable to update the page. A page with the specified ID has a different 'rev' value than the one supplied. Change the 'rev' to be currently stored value and try to update the page again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages/move:
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Move a page.
      description: 'Use this endpoint to move a page. The body of the request should be empty.

        The query parameters should include the ''sourceId'', ''sourceRev'', ''targetPosition'', the optional ''targetId'' and ''targetRev''.

        `sourceId` and `sourceRev` relate to the page to be moved.

        `targetId` and `targetRev` relate to the destination parent page.  These are optional parameters, if not set it means the source page is to be moved to the site root.

        The `targetPosition` field is required, it is an integer value starting at 0. It cannot exceed the number of child pages of the destination parent page.

        If the move is successful, then the response body JSON object will contain the id and rev of the updated destination parent page (`targetId`), except in the case of moving to the site root then the response body is an empty JSON object.

        A refresh of the page hierarchy is recommended after moving a page to a different parent page.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: sourceId
        in: query
        description: The ID of the source page to move.
        required: true
        schema:
          type: string
          format: uuid
      - name: sourceRev
        in: query
        description: the 'rev' value for the page to be moved.
        required: true
        schema:
          type: string
      - name: targetId
        in: query
        description: The ID of the target page.
        required: false
        schema:
          type: string
          format: uuid
      - name: targetRev
        in: query
        description: the 'rev' value for the target page.
        required: false
        schema:
          type: string
      - name: targetPosition
        in: query
        description: The new position on the  target page for the move.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: succcess.
          content:
            application/json:
              schema:
                title: Target Parent After Move
                description: Target Parent Updated Values After Move
                type: object
                properties:
                  id:
                    type: string
                    description: (optional) The ID of the parent page item.
                  rev:
                    type: string
                    description: (optional) The latest revision of the parent page item document.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2041
                      message: A target position of 10 is not valid for the children of page with ID dummyPage, so no move occurred
                      level: ERROR
                      description: Unable to move the page. The target position supplied is invalid for the target page. Change the targetPosition and try again
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/{site-id}/pages/{page-id}/ready:
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      summary: Promote the page from draft to ready status.
      description: 'Use this endpoint to change the status of a page from draft to ready.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: site-id
        in: path
        description: The ID of the site.
        required: true
        schema:
          type: string
          format: uuid
      - name: page-id
        in: path
        description: The ID of the draft page.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully changed the status of the page from draft to ready.
          content:
            application/json:
              schema:
                title: Page Metadata
                description: Page Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the page item.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the page item.
                  contentId:
                    type: string
                    description: The ID of the page content item this item represents.
                  contentTypeId:
                    type: string
                    description: The ID of the page content type.
                  position:
                    type: string
                    description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                  description:
                    type: string
                    description: Page description.
                  layoutId:
                    type: string
                    description: Page layout template ID.
                  segment:
                    type: string
                    description: Friendly URL segment.
                  title:
                    type: string
                    description: Page title.
                  parentId:
                    type: string
                    description: Not present if root page otherwise id of parent page
                  classification:
                    type: string
                    description: This is always `page`
                  lastModified:
                    type: string
                    description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the page. This field is read only
                  created:
                    type: string
                    description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the page. This field is read only.
                  hideFromNavigation:
                    type: boolean
                    description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455571'
                    errors:
                    - code: 2062
                      message: 'Unable to ready the draft of the page with ID: dummyDraftPageId in site with ID: dummySiteId as the page is not in a draft state.'
                      level: ERROR
                      description: Unable to ready a draft of the page as the page is not in a draft state. Ensure the correct id is been used and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
  /authoring/v1/sites/pages/{page-id}:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      summary: Get a page by unique id.
      description: 'Returns the page metadata specified by unique `page-id`. This API is equalivent to `/sites/pages/{site-id/pages{page-id}` but does not require a `site-id`.


        If the page is a root page then no parentId will be returned in the response.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: page-id
        in: path
        description: ID of page.
        required: true
        schema:
          type: string
          format: uuid
      - name: fields
        in: query
        description: 'Reduce the returned page metadata down to just the specified fields.

          Fields specified by a comma seperated list of field names and should only be used once in query string.

          To only retrieve `rev` and `lastModified` this parameter should look like `fields=rev,lastModified`.

          '
        required: false
        style: form
        explode: false
        schema:
          type: string
          items:
            type: string
      - name: include
        in: query
        description: 'Specify additional fields to include with each result. The following fields can be specified to be included in the page item: ''hierarchicalPath'', ''route''.

          You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route.

          The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: succcess.
          content:
            application/json:
              schema:
                title: Page Metadata
                description: Page Metadata
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the page item.
                  rev:
                    type: string
                    description: The current revision of the document.
                  name:
                    type: string
                    description: The name of the page item.
                  contentId:
                    type: string
                    description: The ID of the page content item this item represents.
                  contentTypeId:
                    type: string
                    description: The ID of the page content type.
                  position:
                    type: string
                    description: Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.
                  description:
                    type: string
                    description: Page description.
                  layoutId:
                    type: string
                    description: Page layout template ID.
                  segment:
                    type: string
                    description: Friendly URL segment.
                  title:
                    type: string
                    description: Page title.
                  parentId:
                    type: string
                    description: Not present if root page otherwise id of parent page
                  classification:
                    type: string
                    description: This is always `page`
                  lastModified:
                    type: string
                    description: The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                  lastModifierId:
                    type: string
                    description: This is the user id of the user that modified the page. This field is read only
                  created:
                    type: string
                    description: The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only
                  creatorId:
                    type: string
                    description: This is the user id of the user that created the page. This field is read only.
                  hideFromNavigation:
                    type: boolean
                    description: This controls the visibility of the page in the site navigation menu. If set to `true` this page is hidden. If set to `true` on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.
              examples:
                response:
                  value:
                    id: aw67771c-ec05-4671-951b-18fqwq53f2d
                    rev: 20-axz19cf45c00a55eda54d6480976b3e1
                    name: products
                    segment: products
                    contentTypeId: dffa969c-32fc-4079-8a57-eb85ad136ae8
                    description: products page
                    layoutId: 13c46fbe-db14-4a24-859f-f4b847a2b843
                    title: Products Page
                    contentId: 76sd88a6-31d8-4e47-ad5f-da932081b68d
                    parentId: 1067771c-ec05-4671-951b-18f503953f2d
                    position: 0
                    hideFromNavigation: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2011
                      message: Invalid page ID parameter provided.
                      level: ERROR
                      description: The page ID provided is missing or invalid. The page ID cannot be empty or contain spaces. Provide a valid page ID and try again.
                      locale: en
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1016
                      message: Problem accessing database.
                      level: ERROR
                      description: Problem accessing database. Try again or contact Acoustic support if problem persists.
                      locale: en
        '404':
          description: Not found
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 2012
                      message: 'Page not found for ID: dummyId'
                      level: ERROR
                      description: A page with the specified ID was not found in the system. Provide a valid ID and try again.
                      locale: en
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 1018
                      message: Temporarily unable to access the database.
                      level: ERROR
                      description: Temporarily unable to access the database. Try again or contact Acoustic support if problem persists.
                      locale: en
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                title: ErrorMessage
                description: ErrorMessage
                type: object
                properties:
                  service:
                    type: string
                    description: Service name.
                  requestId:
                    type: string
                    description: Request ID.
                  errors:
                    type: array
                    items:
                      title: Error
                      description: Error
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                        level:
                          type: string
                        description:
                          type: string
                        cause:
                          type: object
                          properties:
                            code:
                              type: integer
                            message:
                              type: string
                        locale:
                          type: string
              examples:
                response:
                  value:
                    service: prod-authoring-sites
                    requestId: '455478465455511'
                    errors:
                    - code: 5004
                      message: Unexpected error occurred.
                      level: ERROR
                      description: Unable to complete the request due to an unexpected error. Try again or contact Acoustic support if problem persists.
                      locale: en
      tags:
      - Authoring sites
components:
  schemas:
    ErrorResponse:
      description: This JSON record represents an error condition.
      type: object
      properties:
        errors:
          type: array
          items:
            description: This JSON record represents an individual error or warning contained in an error message.
            type: object
            properties:
              code:
                type: integer
                description: An error code
              message:
                type: string
                description: A message describing what went wrong.
              description:
                type: string
                description: Further explanation of the error condition and potential next steps to resolve the problem.
              more_info:
                type: string
                description: A URL pointing to a web site that provides more information on the given error condition.
              level:
                type: string
                enum:
                - ERROR
                - WARNING
                description: The severity level of the message. Default is error.
              parameters:
                type: object
                description: Additional properties reflecting the dynamic parts of the error condition.
              cause:
                type: object
                description: This property can be used to transport causing error message records produced by a down stream service calls.
              locale:
                type: string
                description: This property represents the locale of the text contained in properties 'message', and 'description'. This property is mandatory if message and description contain translated text.
            required:
            - code
            - message
        requestId:
          type: string
          description: The ID of the failing request.
        service:
          type: string
          description: The name of the service serving the error message.
      required:
      - errors
      - requestId
x-refined-from:
- acoustic-content-openapi-original.json
- acoustic-content-swagger2-original.yaml
x-readme:
  explorer-enabled: true
  proxy-enabled: true