openapi: 3.2.0
info:
  title: Acoustic Authoring layouts API
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  description: 'Operations tagged Authoring layouts 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 layouts
  description: 'Use the Content content authoring layout service Rest APIs to work with layouts and layout mappings.


    Layouts define the template for the type documents. They define the markup and how to add content properties and elements into the markup. For example, the layouts ''Article'', and ''Event'' would define what an article or event looks like on the web site, or email.


    Layout Mappings define an association between a content-type and one or more layouts. Specifically marking those layouts as valid for the given content-type.

    '
paths:
  /authoring/v1/layouts:
    post:
      tags:
      - Authoring layouts
      summary: Create new layouts.
      description: 'Use the /layouts end-point to create a new layout.<br />User roles: admin, manager'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: A new layout.
              properties:
                name:
                  type: string
                  description: The name of the layout.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  minLength: 1
                  example: Sample layout
                description:
                  type: string
                  description: The description of the layout.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  example: An example description of the sample layout
                classification:
                  type: string
                  description: Indicates the type of this document.
                  enum:
                  - layout
                created:
                  type: string
                  description: Optional creation date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.
                  format: date-time
                path:
                  type: string
                  description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                  example: /myLayouts/SampleLayout.json
                prerender:
                  type: boolean
                  description: Indicates if the layout should be prerendered.
                  default: false
                  example: false
                tags:
                  type: array
                  items:
                    type: string
                  uniqueItems: true
                  example:
                  - news
                  - sample
                thumbnail:
                  type: object
                  description: 'The reference to the asset that should act as the thumbnail of this layout.

                    The thumbnail can be referred to by either id or path.

                    '
                  properties:
                    id:
                      type: string
                      description: The ID of the asset.
                      example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                    path:
                      type: string
                      description: The path of the asset.
                      example: /sales/images/hub.png
                template:
                  type: string
                  minLength: 1
                  example: /mytemplates/template.hbs
                templateType:
                  type: string
                  description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                  enum:
                  - handlebars
                  - angular
                  default: handlebars
                  example: handlebars
                urlTemplate:
                  type: string
                  description: Specifies the pattern for url generation.
                isSystem:
                  type: boolean
                  description: Indicates whether this item is a 'system item' or not.
                  default: false
              required:
              - name
              - template
        description: Contains the layout to create.
        required: true
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout.
                properties:
                  id:
                    type: string
                    description: The ID of the layout.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                  rev:
                    type: string
                    description: The current revision of the layout.
                    minLength: 1
                    example: 139c63397272172e73f52d22f22f606f6c
                  name:
                    type: string
                    description: The name of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout
                  description:
                    type: string
                    description: The description of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    example: An example description of the sample layout
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  path:
                    type: string
                    description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayouts/SampleLayout.json
                  prerender:
                    type: boolean
                    description: Indicates if the layout should be prerendered.
                    default: false
                    example: false
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  thumbnail:
                    type: object
                    description: 'The reference to the asset that should act as the thumbnail of this layout.

                      The thumbnail can be referred to by either id or path.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                  template:
                    type: string
                    minLength: 1
                    example: /mytemplates/template.hbs
                  templateType:
                    type: string
                    description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                    enum:
                    - handlebars
                    - angular
                    default: handlebars
                    example: handlebars
                  urlTemplate:
                    type: string
                    description: Specifies the pattern for url generation.
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - template
        '400':
          description: Empty body or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '409':
          description: Layout with the same path exists.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layouts in the database.
      description: 'Use the /layouts endpoint to retrieve all layouts from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layouts to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layouts that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      - name: pageMode
        in: query
        required: false
        description: "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of  times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
        schema:
          type: string
          enum:
          - offset
          - deep
      - name: order
        in: query
        description: Specify whether you want the layouts to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order.
        required: false
        schema:
          type: string
          enum:
          - ascending
          - descending
          default: ascending
      - name: fields
        in: query
        description: Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layouts.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                        rev:
                          type: string
                          description: The current revision of the layout.
                          minLength: 1
                          example: 139c63397272172e73f52d22f22f606f6c
                        name:
                          type: string
                          description: The name of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout
                        description:
                          type: string
                          description: The description of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          example: An example description of the sample layout
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        path:
                          type: string
                          description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayouts/SampleLayout.json
                        prerender:
                          type: boolean
                          description: Indicates if the layout should be prerendered.
                          default: false
                          example: false
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        thumbnail:
                          type: object
                          description: 'The reference to the asset that should act as the thumbnail of this layout.

                            The thumbnail can be referred to by either id or path.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        template:
                          type: string
                          minLength: 1
                          example: /mytemplates/template.hbs
                        templateType:
                          type: string
                          description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                          enum:
                          - handlebars
                          - angular
                          default: handlebars
                          example: handlebars
                        urlTemplate:
                          type: string
                          description: Specifies the pattern for url generation.
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - template
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/by-content/{content-id}:
    get:
      tags:
      - Authoring layouts
      summary: Retrieves the layouts associated with the specified content.
      description: 'Use the /layouts/by-content/{contentId} endpoint to retrieve the layouts associated with the specified content. When the ''filter'' query string parameter is set to ''selected'', only the selected layout (which could be a content override) is returned.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: content-id
        in: path
        description: The ID of the content whose associated layouts should be returned.
        required: true
        schema:
          type: string
      - name: projectId
        in: query
        description: "Optionally specifies the context for draft overlay. Contains the project id, or special values:\n    * draft for standalone draft overlays\n    * none for no project overlay.\n\nWhen both the 'projectId' query-string parameter AND the 'x-ibm-dx-project-id' header are specified, the 'projectId' query-string parameter will override the 'x-ibm-dx-project-id' header.\n"
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: "An optional filter to control the returned results.\nValid options are:\n    * selected: Indicates that only the selected layout should be returned.\n"
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layouts to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layouts that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: fields
        in: query
        description: Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      - name: x-ibm-dx-project-id
        in: header
        description: "Optionally specifies the context for draft overlay. Contains the project id, or special values:\n    * draft for standalone draft overlays\n    * none for no project overlay.\n\nWhen both the 'projectId' query-string parameter AND the 'x-ibm-dx-project-id' header are specified, the 'projectId' query-string parameter will override the 'x-ibm-dx-project-id' header.\n"
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns resolved layouts.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout returned from one of the resolution end points.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                        rev:
                          type: string
                          description: The current revision of the layout.
                          minLength: 1
                          example: 139c63397272172e73f52d22f22f606f6c
                        name:
                          type: string
                          description: The name of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout
                        description:
                          type: string
                          description: The description of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          example: An example description of the sample layout
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout
                        path:
                          type: string
                          description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayouts/SampleLayout.json
                        prerender:
                          type: boolean
                          description: Indicates if the layout should be prerendered.
                          default: false
                          example: false
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        template:
                          type: string
                          minLength: 1
                          example: /mytemplates/template.hbs
                        templateType:
                          type: string
                          description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                          enum:
                          - handlebars
                          - angular
                          default: handlebars
                          example: handlebars
                        thumbnail:
                          type: object
                          description: The reference to the asset that should act as the thumbnail of this layout.
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The content with ID {contentId} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/by-path:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve an existing layout by its path.
      description: 'Use the /layouts/by-path end-point to retrieve an existing layout from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: path
        in: query
        description: The path of the layout to retrieve.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: A comma separated list that when specified, limits the fields returned to just those specified. Any layout field is a valid value.
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n     * metadata: Adds additional details such as creator and last modifier to the response.\n     * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Provide an Etag value from a previous request to check whether the layout retrieved is the most recent version. If the layout is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout back.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            Etag:
              description: The Etag value helps identify this document in future requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                description: An existing layout.
                properties:
                  id:
                    type: string
                    description: The ID of the layout.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                  rev:
                    type: string
                    description: The current revision of the layout.
                    minLength: 1
                    example: 139c63397272172e73f52d22f22f606f6c
                  name:
                    type: string
                    description: The name of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout
                  description:
                    type: string
                    description: The description of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    example: An example description of the sample layout
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  path:
                    type: string
                    description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayouts/SampleLayout.json
                  prerender:
                    type: boolean
                    description: Indicates if the layout should be prerendered.
                    default: false
                    example: false
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  thumbnail:
                    type: object
                    description: 'The reference to the asset that should act as the thumbnail of this layout.

                      The thumbnail can be referred to by either id or path.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                  template:
                    type: string
                    minLength: 1
                    example: /mytemplates/template.hbs
                  templateType:
                    type: string
                    description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                    enum:
                    - handlebars
                    - angular
                    default: handlebars
                    example: handlebars
                  urlTemplate:
                    type: string
                    description: Specifies the pattern for url generation.
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - template
        '304':
          description: Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
        '400':
          description: Invalid path OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with path {path} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/count:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve the total number of layouts.
      description: 'Use the /layouts/count endpoint to obtain the total number of layouts within the database.<br />User roles: admin, manager, editor, viewer'
      responses:
        '200':
          description: layout count
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/{id}:
    put:
      tags:
      - Authoring layouts
      summary: Update an existing layout.
      description: 'Use the /layouts/{id} end-point to update an existing layout within the database.<br />User roles: admin, manager'
      parameters:
      - name: id
        in: path
        description: The ID of the layout document to update.
        required: true
        schema:
          type: string
      - name: forceOverride
        in: query
        description: Specifies whether revision checking should be disabled.
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: An existing layout.
              properties:
                id:
                  type: string
                  description: The ID of the layout.
                  pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                  minLength: 1
                  example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                rev:
                  type: string
                  description: The current revision of the layout.
                  minLength: 1
                  example: 139c63397272172e73f52d22f22f606f6c
                name:
                  type: string
                  description: The name of the layout.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  minLength: 1
                  example: Sample layout
                description:
                  type: string
                  description: The description of the layout.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  example: An example description of the sample layout
                classification:
                  type: string
                  description: Indicates the type of this document.
                  enum:
                  - layout
                creatorId:
                  type: string
                  description: The ID of the user that created the layout.
                  example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                creator:
                  type: string
                  description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                    This field is read only.

                    '
                  example: Thomas Watson
                created:
                  type: string
                  description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                  format: date-time
                lastModifierId:
                  type: string
                  description: The ID of the user that last modified the layout.
                  example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                lastModifier:
                  type: string
                  description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                    This field is read only.

                    '
                  example: Thomas Watson
                lastModified:
                  type: string
                  description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                  format: date-time
                path:
                  type: string
                  description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                  example: /myLayouts/SampleLayout.json
                prerender:
                  type: boolean
                  description: Indicates if the layout should be prerendered.
                  default: false
                  example: false
                tags:
                  type: array
                  items:
                    type: string
                  uniqueItems: true
                  example:
                  - news
                  - sample
                thumbnail:
                  type: object
                  description: 'The reference to the asset that should act as the thumbnail of this layout.

                    The thumbnail can be referred to by either id or path.

                    '
                  properties:
                    id:
                      type: string
                      description: The ID of the asset.
                      example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                    path:
                      type: string
                      description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                        This field is read only.

                        '
                      example: /sales/images/hub.png
                    url:
                      type: string
                      description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                        This field is read only.

                        '
                      example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                template:
                  type: string
                  minLength: 1
                  example: /mytemplates/template.hbs
                templateType:
                  type: string
                  description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                  enum:
                  - handlebars
                  - angular
                  default: handlebars
                  example: handlebars
                urlTemplate:
                  type: string
                  description: Specifies the pattern for url generation.
                isSystem:
                  type: boolean
                  description: Indicates whether this item is a 'system item' or not.
                  default: false
              required:
              - rev
              - name
              - template
        description: Contains the updated layout object to save.
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout.
                properties:
                  id:
                    type: string
                    description: The ID of the layout.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                  rev:
                    type: string
                    description: The current revision of the layout.
                    minLength: 1
                    example: 139c63397272172e73f52d22f22f606f6c
                  name:
                    type: string
                    description: The name of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout
                  description:
                    type: string
                    description: The description of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    example: An example description of the sample layout
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  path:
                    type: string
                    description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayouts/SampleLayout.json
                  prerender:
                    type: boolean
                    description: Indicates if the layout should be prerendered.
                    default: false
                    example: false
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  thumbnail:
                    type: object
                    description: 'The reference to the asset that should act as the thumbnail of this layout.

                      The thumbnail can be referred to by either id or path.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                  template:
                    type: string
                    minLength: 1
                    example: /mytemplates/template.hbs
                  templateType:
                    type: string
                    description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                    enum:
                    - handlebars
                    - angular
                    default: handlebars
                    example: handlebars
                  urlTemplate:
                    type: string
                    description: Specifies the pattern for url generation.
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - template
        '400':
          description: Invalid ID or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '401':
          description: The user is not authorized to run this action.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '409':
          description: Another user updated the document since it was last retrieved OR when changing the path, there is an existing document at that path.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    delete:
      tags:
      - Authoring layouts
      summary: Delete an existing layout.
      description: 'Use the /layouts/{id} endpoint to delete an existing layout from the database.<br />User roles: admin, manager'
      parameters:
      - name: id
        in: path
        description: The ID of the layout to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '401':
          description: The user is not authorized to run this action.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    get:
      tags:
      - Authoring layouts
      summary: Retrieve an existing layout.
      description: 'Use the /layouts/{id} end-point to retrieve an existing layout from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: id
        in: path
        description: The ID of the layout to retrieve.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: A comma separated list that when specified, limits the fields returned to just those specified. Any layout field is a valid value.
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n     * metadata: Adds additional details such as creator and last modifier to the response.\n     * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Provide an Etag value from a previous request to check whether the layout retrieved is the most recent version. If the layout is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout back.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            Etag:
              description: The Etag value helps identify this document in future requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                description: An existing layout.
                properties:
                  id:
                    type: string
                    description: The ID of the layout.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                  rev:
                    type: string
                    description: The current revision of the layout.
                    minLength: 1
                    example: 139c63397272172e73f52d22f22f606f6c
                  name:
                    type: string
                    description: The name of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout
                  description:
                    type: string
                    description: The description of the layout.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    example: An example description of the sample layout
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                  path:
                    type: string
                    description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayouts/SampleLayout.json
                  prerender:
                    type: boolean
                    description: Indicates if the layout should be prerendered.
                    default: false
                    example: false
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  thumbnail:
                    type: object
                    description: 'The reference to the asset that should act as the thumbnail of this layout.

                      The thumbnail can be referred to by either id or path.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          This field is read only.

                          '
                        example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                  template:
                    type: string
                    minLength: 1
                    example: /mytemplates/template.hbs
                  templateType:
                    type: string
                    description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                    enum:
                    - handlebars
                    - angular
                    default: handlebars
                    example: handlebars
                  urlTemplate:
                    type: string
                    description: Specifies the pattern for url generation.
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - template
        '304':
          description: Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/views/by-modified:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layouts in the database ordered by last modified date.
      description: 'Use the /layouts/views/by-modified endpoint to retrieve all layouts from the database and list them in the order of their last modified date.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: start
        in: query
        description: 'Provide the date and time of when the last modifications were made to the layouts that you want returned.

          When the order is ascending (default), the layouts that are modified on or after this date and time are returned.

          When the order is descending, the layouts 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: end
        in: query
        description: 'Provide the date and time of when the last modifications were made to the layouts that you want returned.

          When the order is ascending (default), the layouts that are modified on or before this date and time are returned.

          When the order is descending, the layouts 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: startId
        in: query
        required: false
        description: 'If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.

          '
        schema:
          type: string
      - name: endId
        in: query
        required: false
        description: 'If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.

          '
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layouts to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layouts that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      - name: pageMode
        in: query
        required: false
        description: "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of  times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
        schema:
          type: string
          enum:
          - offset
          - deep
      - name: order
        in: query
        description: Specify whether you want the layout documents to be returned in ascending/oldest-first (default) or descending/newest-first order.
        required: false
        schema:
          type: string
          enum:
          - ascending
          - descending
          default: ascending
      - name: fields
        in: query
        description: Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layouts.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                        rev:
                          type: string
                          description: The current revision of the layout.
                          minLength: 1
                          example: 139c63397272172e73f52d22f22f606f6c
                        name:
                          type: string
                          description: The name of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout
                        description:
                          type: string
                          description: The description of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          example: An example description of the sample layout
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        path:
                          type: string
                          description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayouts/SampleLayout.json
                        prerender:
                          type: boolean
                          description: Indicates if the layout should be prerendered.
                          default: false
                          example: false
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        thumbnail:
                          type: object
                          description: 'The reference to the asset that should act as the thumbnail of this layout.

                            The thumbnail can be referred to by either id or path.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        template:
                          type: string
                          minLength: 1
                          example: /mytemplates/template.hbs
                        templateType:
                          type: string
                          description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                          enum:
                          - handlebars
                          - angular
                          default: handlebars
                          example: handlebars
                        urlTemplate:
                          type: string
                          description: Specifies the pattern for url generation.
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - template
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layouts/views/by-name:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layouts in the database with the specified name.
      description: 'Use the /layouts/views/by-name endpoint to retrieve all layouts from the database with the specified name.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: name
        in: query
        description: The name to query.
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layouts to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layouts that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: fields
        in: query
        description: Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layouts.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                        rev:
                          type: string
                          description: The current revision of the layout.
                          minLength: 1
                          example: 139c63397272172e73f52d22f22f606f6c
                        name:
                          type: string
                          description: The name of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout
                        description:
                          type: string
                          description: The description of the layout.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          example: An example description of the sample layout
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                        path:
                          type: string
                          description: Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayouts/SampleLayout.json
                        prerender:
                          type: boolean
                          description: Indicates if the layout should be prerendered.
                          default: false
                          example: false
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        thumbnail:
                          type: object
                          description: 'The reference to the asset that should act as the thumbnail of this layout.

                            The thumbnail can be referred to by either id or path.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: 'The path of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: 'The URL of the asset. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: /authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        template:
                          type: string
                          minLength: 1
                          example: /mytemplates/template.hbs
                        templateType:
                          type: string
                          description: Specifies the type of template associated with this layout. This field is required when prerender field is set to true.
                          enum:
                          - handlebars
                          - angular
                          default: handlebars
                          example: handlebars
                        urlTemplate:
                          type: string
                          description: Specifies the pattern for url generation.
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - template
        '400':
          description: Invalid name or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings:
    post:
      tags:
      - Authoring layouts
      summary: Create new layout mappings.
      description: 'Use the /layout-mapping end-point to create a new layout mapping.<br />User roles: admin, manager'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: A new layout mapping.
              properties:
                name:
                  type: string
                  description: The name of the layout mapping.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  minLength: 1
                  example: Sample layout mapping
                classification:
                  type: string
                  description: Indicates the type of this document.
                  enum:
                  - layout-mapping
                created:
                  type: string
                  description: Optional creation date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.
                  format: date-time
                path:
                  type: string
                  description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                  example: /myLayoutMappings/SampleMapping.json
                tags:
                  type: array
                  items:
                    type: string
                  uniqueItems: true
                  example:
                  - news
                  - sample
                type:
                  type: object
                  description: 'The mapped content-type. Must be unique.

                    During create and update operations, the mapped content-type can be referred to by either id or name.

                    '
                  properties:
                    id:
                      type: string
                      description: The ID of the mapped content-type.
                      pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                      minLength: 1
                      example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                    name:
                      type: string
                      description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                        '
                      example: Sample Type
                mappings:
                  type: array
                  description: The mapped layouts.
                  items:
                    type: object
                    description: 'an individual layout mapping entry.

                      During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                      '
                    properties:
                      defaultLayout:
                        type: object
                        description: an individual layout reference.
                        properties:
                          id:
                            type: string
                            description: The ID of the referenced layout.
                            pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                            minLength: 1
                            example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                          name:
                            type: string
                            description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                              This field is read only.

                              '
                            example: Sample Layout
                        required:
                        - id
                      layouts:
                        type: array
                        description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                        items:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        minItems: 1
                    required:
                    - defaultLayout
                    - layouts
                  minItems: 1
                  maxItems: 1
                isSystem:
                  type: boolean
                  description: Indicates whether this item is a 'system item' or not.
                  default: false
              required:
              - name
              - type
              - mappings
        description: Contains the layout mapping to create.
        required: true
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '400':
          description: Empty body or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '409':
          description: A layout mapping associated with the same content-type OR path exists.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layout mappings in the database.
      description: 'Use the /layout-mappings endpoint to retrieve all layout mappings from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layout mappings to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layout mappings that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      - name: pageMode
        in: query
        required: false
        description: "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of  times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
        schema:
          type: string
          enum:
          - offset
          - deep
      - name: order
        in: query
        description: Specify whether you want the layout mappings to be returned in ascending (default) or descending order.
        required: false
        schema:
          type: string
          enum:
          - ascending
          - descending
          default: ascending
      - name: fields
        in: query
        description: Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layout mappings.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout mapping.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout mapping.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: e0192c4c-9633-4853-856a-ce04e37ec40c
                        rev:
                          type: string
                          description: The current revision of the layout mapping.
                          minLength: 1
                          example: 1d5fc65f4cd277eb5340355db7ecdfde75
                        name:
                          type: string
                          description: The name of the layout mapping.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout mapping
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout-mapping
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        path:
                          type: string
                          description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayoutMappings/SampleMapping.json
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        type:
                          type: object
                          description: 'The mapped content-type. Must be unique.

                            During create and update operations, the mapped content-type can be referred to by either id or name.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the mapped content-type.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                            name:
                              type: string
                              description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                '
                              example: Sample Type
                        mappings:
                          type: array
                          description: The mapped layouts.
                          items:
                            type: object
                            description: 'an individual layout mapping entry.

                              During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                              '
                            properties:
                              defaultLayout:
                                type: object
                                description: an individual layout reference.
                                properties:
                                  id:
                                    type: string
                                    description: The ID of the referenced layout.
                                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                    minLength: 1
                                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                  name:
                                    type: string
                                    description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                      This field is read only.

                                      '
                                    example: Sample Layout
                                required:
                                - id
                              layouts:
                                type: array
                                description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                                items:
                                  type: object
                                  description: an individual layout reference.
                                  properties:
                                    id:
                                      type: string
                                      description: The ID of the referenced layout.
                                      pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                      minLength: 1
                                      example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                    name:
                                      type: string
                                      description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                        This field is read only.

                                        '
                                      example: Sample Layout
                                  required:
                                  - id
                                minItems: 1
                            required:
                            - defaultLayout
                            - layouts
                          minItems: 1
                          maxItems: 1
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - type
                      - mappings
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings/by-path:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve an existing layout mapping by its path.
      description: 'Use the /layout-mappings/by-path end-point to retrieve an existing layout mapping from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: path
        in: query
        description: The path of the layout mapping to retrieve.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value.
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n     * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n     * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Provide an Etag value from a previous request to check whether the layout mapping retrieved is the most recent version. If the layout mapping is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout mapping back.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            Etag:
              description: The Etag value helps identify this document in future requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '304':
          description: Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
        '400':
          description: Invalid path OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with path {path} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings/by-type/{type-id}:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve an existing layout mapping via its associated content-type.
      description: 'Use the /layout-mappings/by-type/{type-id} end-point to retrieve an existing layout mapping from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: type-id
        in: path
        description: The ID of the content-type whose layout mapping should be retrieved.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value.
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n     * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n     * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Provide an Etag value from a previous request to check whether the layout mapping retrieved is the most recent version. If the layout mapping is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout mapping back.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            Etag:
              description: The Etag value helps identify this document in future requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '304':
          description: Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: There is no layout-mapping associated with the specified content-type OR Current tenant's database is not provisioned OR the operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
    delete:
      tags:
      - Authoring layouts
      summary: Deletes an existing layout mapping via its associated content-type.
      description: 'Use the /layout-mappings/by-type/{type-id} end-point to delete an existing layout mapping from the database.<br />User roles: admin, manager'
      parameters:
      - name: type-id
        in: path
        description: The ID of the content-type whose layout mapping should be deleted.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: There is no layout-mapping associated with the specified content-type OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
  /authoring/v1/layout-mappings/by-type/{type-id}/copy:
    post:
      tags:
      - Authoring layouts
      summary: Copies an existing layout mapping via its associated content-type.
      description: 'Use the /layout-mappings/by-type/{type-id}/copy end-point to create a duplicate of a layout mapping. The new layout mapping will have a name in the format ''Copy [NUMBER] of [SOURCE-NAME]''<br />User roles: admin, manager'
      parameters:
      - name: type-id
        in: path
        description: The ID of the content-type whose layout mapping should be copied.
        required: true
        schema:
          type: string
      - name: targetTypeId
        in: query
        description: The ID of the content-type to associate with the copy.
        required: true
        schema:
          type: string
      - name: name
        in: query
        description: An optional name to associate with the copy. If there is an existing layout mapping with the specified name, then the copied document will have a name in the format 'Copy [NUMBER] of [NAME]'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: There was an existing layout mapping found for the specified content-type.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '201':
          description: Successfully copied the layout mapping.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '404':
          description: A document with the ID {id} was not found or the current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
  /authoring/v1/layout-mappings/count:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve the total number of layout mappings.
      description: 'Use the /layout-mappings/count endpoint to obtain the total number of layout mappings within the database.<br />User roles: admin, manager, editor, viewer'
      responses:
        '200':
          description: layout mapping count
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings/{id}:
    put:
      tags:
      - Authoring layouts
      summary: Update an existing layout mapping.
      description: 'Use the /layout-mappings/{id} end-point to update an existing layout mapping within the database.<br />User roles: admin, manager'
      parameters:
      - name: id
        in: path
        description: The ID of the layout mapping document to update.
        required: true
        schema:
          type: string
      - name: forceOverride
        in: query
        description: Specifies whether revision checking should be disabled.
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: An existing layout mapping.
              properties:
                id:
                  type: string
                  description: The ID of the layout mapping.
                  pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                  minLength: 1
                  example: e0192c4c-9633-4853-856a-ce04e37ec40c
                rev:
                  type: string
                  description: The current revision of the layout mapping.
                  minLength: 1
                  example: 1d5fc65f4cd277eb5340355db7ecdfde75
                name:
                  type: string
                  description: The name of the layout mapping.
                  pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                  minLength: 1
                  example: Sample layout mapping
                classification:
                  type: string
                  description: Indicates the type of this document.
                  enum:
                  - layout-mapping
                creatorId:
                  type: string
                  description: The ID of the user that created the layout mapping.
                  example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                creator:
                  type: string
                  description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                    This field is read only.

                    '
                  example: Thomas Watson
                created:
                  type: string
                  description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                  format: date-time
                  example: '2016-11-02T06:28:47Z'
                lastModifierId:
                  type: string
                  description: The ID of the user that last modified the layout mapping.
                  example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                lastModifier:
                  type: string
                  description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                    This field is read only.

                    '
                  example: Thomas Watson
                lastModified:
                  type: string
                  description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                  format: date-time
                  example: '2016-11-02T06:28:47Z'
                path:
                  type: string
                  description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                  example: /myLayoutMappings/SampleMapping.json
                tags:
                  type: array
                  items:
                    type: string
                  uniqueItems: true
                  example:
                  - news
                  - sample
                type:
                  type: object
                  description: 'The mapped content-type. Must be unique.

                    During create and update operations, the mapped content-type can be referred to by either id or name.

                    '
                  properties:
                    id:
                      type: string
                      description: The ID of the mapped content-type.
                      pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                      minLength: 1
                      example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                    name:
                      type: string
                      description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                        '
                      example: Sample Type
                mappings:
                  type: array
                  description: The mapped layouts.
                  items:
                    type: object
                    description: 'an individual layout mapping entry.

                      During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                      '
                    properties:
                      defaultLayout:
                        type: object
                        description: an individual layout reference.
                        properties:
                          id:
                            type: string
                            description: The ID of the referenced layout.
                            pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                            minLength: 1
                            example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                          name:
                            type: string
                            description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                              This field is read only.

                              '
                            example: Sample Layout
                        required:
                        - id
                      layouts:
                        type: array
                        description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                        items:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        minItems: 1
                    required:
                    - defaultLayout
                    - layouts
                  minItems: 1
                  maxItems: 1
                isSystem:
                  type: boolean
                  description: Indicates whether this item is a 'system item' or not.
                  default: false
              required:
              - rev
              - name
              - type
              - mappings
        description: Contains the updated layout mapping object to save.
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '400':
          description: Invalid ID or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '401':
          description: The user is not authorized to run this action.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '409':
          description: Another user updated the document since it was last retrieved OR when changing the mapped content-type, there is an existing mapping with the chosen content-type OR when changing the path, there is an existing mapping at that path.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    delete:
      tags:
      - Authoring layouts
      summary: Delete an existing layout mapping.
      description: 'Use the /layout-mappings/{id} endpoint to delete an existing layout mapping from the database.<br />User roles: admin, manager'
      parameters:
      - name: id
        in: path
        description: The ID of the layout mapping to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '401':
          description: The user is not authorized to run this action.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
        '500':
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
      x-ibm-dx-security-user-roles:
      - admin
      - manager
    get:
      tags:
      - Authoring layouts
      summary: Retrieve an existing layout mapping.
      description: 'Use the /layout-mappings/{id} end-point to retrieve an existing layout mapping from the database.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: id
        in: path
        description: The ID of the layout mapping to retrieve.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value.
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: "A comma separated list of additional fields (which are normally hidden) to add to the response.\nValid options are:\n     * metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response.\n     * all: Adds all current and future additional fields to the response.\nWhen used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.\n"
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Provide an Etag value from a previous request to check whether the layout mapping retrieved is the most recent version. If the layout mapping is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout mapping back.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          headers:
            Etag:
              description: The Etag value helps identify this document in future requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '304':
          description: Not modified is returned when using If-None-Match header and the value matches the latest version of the item.
        '400':
          description: Invalid ID OR Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '404':
          description: The document with ID {id} was not found OR Current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings/{id}/copy:
    post:
      tags:
      - Authoring layouts
      summary: Copies an existing layout mapping.
      description: 'Use the /layout-mappings/{id}/copy end-point to create a duplicate of a layout mapping. The new layout mapping will have a name in the format ''Copy [NUMBER] of [SOURCE-NAME]''<br />User roles: admin, manager'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the layout mapping that you wish to copy.
        required: true
        schema:
          type: string
      - name: typeId
        in: query
        description: The ID of the content-type to associate with the copy.
        required: true
        schema:
          type: string
      - name: name
        in: query
        description: An optional name to associate with the copy. If there is an existing layout mapping with the specified name, then the copied document will have a name in the format 'Copy [NUMBER] of [NAME]'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: There was an existing layout mapping found for the specified content-type.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '201':
          description: Successfully copied the layout mapping.
          content:
            application/json:
              schema:
                type: object
                description: An existing layout mapping.
                properties:
                  id:
                    type: string
                    description: The ID of the layout mapping.
                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                    minLength: 1
                    example: e0192c4c-9633-4853-856a-ce04e37ec40c
                  rev:
                    type: string
                    description: The current revision of the layout mapping.
                    minLength: 1
                    example: 1d5fc65f4cd277eb5340355db7ecdfde75
                  name:
                    type: string
                    description: The name of the layout mapping.
                    pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                    minLength: 1
                    example: Sample layout mapping
                  classification:
                    type: string
                    description: Indicates the type of this document.
                    enum:
                    - layout-mapping
                  creatorId:
                    type: string
                    description: The ID of the user that created the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  created:
                    type: string
                    description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the layout mapping.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  lastModifier:
                    type: string
                    description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                      This field is read only.

                      '
                    example: Thomas Watson
                  lastModified:
                    type: string
                    description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                    format: date-time
                    example: '2016-11-02T06:28:47Z'
                  path:
                    type: string
                    description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                    example: /myLayoutMappings/SampleMapping.json
                  tags:
                    type: array
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  type:
                    type: object
                    description: 'The mapped content-type. Must be unique.

                      During create and update operations, the mapped content-type can be referred to by either id or name.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the mapped content-type.
                        pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                        minLength: 1
                        example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                      name:
                        type: string
                        description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                          '
                        example: Sample Type
                  mappings:
                    type: array
                    description: The mapped layouts.
                    items:
                      type: object
                      description: 'an individual layout mapping entry.

                        During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                        '
                      properties:
                        defaultLayout:
                          type: object
                          description: an individual layout reference.
                          properties:
                            id:
                              type: string
                              description: The ID of the referenced layout.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                            name:
                              type: string
                              description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                This field is read only.

                                '
                              example: Sample Layout
                          required:
                          - id
                        layouts:
                          type: array
                          description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                          items:
                            type: object
                            description: an individual layout reference.
                            properties:
                              id:
                                type: string
                                description: The ID of the referenced layout.
                                pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                minLength: 1
                                example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                              name:
                                type: string
                                description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                  This field is read only.

                                  '
                                example: Sample Layout
                            required:
                            - id
                          minItems: 1
                      required:
                      - defaultLayout
                      - layouts
                    minItems: 1
                    maxItems: 1
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not.
                    default: false
                required:
                - rev
                - name
                - type
                - mappings
        '404':
          description: A document with the ID {id} was not found or the current tenant's database is not provisioned.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
  /authoring/v1/layout-mappings/views/by-modified:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layout mappings in the database ordered by last modified date.
      description: 'Use the /layout-mappings/views/by-modified endpoint to retrieve all layout mappings from the database and list them in the order of their last modified date.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: start
        in: query
        description: 'Provide the date and time of when the last modifications were made to the layout mappings that you want returned.

          When the order is ascending (default), the layouts that are modified on or after this date and time are returned.

          When the order is descending, the layouts 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: end
        in: query
        description: 'Provide the date and time of when the last modifications were made to the layout mappings that you want returned.

          When the order is ascending (default), the layouts that are modified on or before this date and time are returned.

          When the order is descending, the layouts 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: startId
        in: query
        required: false
        description: 'If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.

          '
        schema:
          type: string
      - name: endId
        in: query
        required: false
        description: 'If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.

          '
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layout mappings to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layout mappings that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      - name: pageMode
        in: query
        required: false
        description: "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of  times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n"
        schema:
          type: string
          enum:
          - offset
          - deep
      - name: order
        in: query
        description: Specify whether you want the layout mapping documents to be returned in ascending/oldest-first (default) or descending/newest-first order.
        required: false
        schema:
          type: string
          enum:
          - ascending
          - descending
          default: ascending
      - name: fields
        in: query
        description: Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layout mappings.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout mapping.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout mapping.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: e0192c4c-9633-4853-856a-ce04e37ec40c
                        rev:
                          type: string
                          description: The current revision of the layout mapping.
                          minLength: 1
                          example: 1d5fc65f4cd277eb5340355db7ecdfde75
                        name:
                          type: string
                          description: The name of the layout mapping.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout mapping
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout-mapping
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        path:
                          type: string
                          description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayoutMappings/SampleMapping.json
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        type:
                          type: object
                          description: 'The mapped content-type. Must be unique.

                            During create and update operations, the mapped content-type can be referred to by either id or name.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the mapped content-type.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                            name:
                              type: string
                              description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                '
                              example: Sample Type
                        mappings:
                          type: array
                          description: The mapped layouts.
                          items:
                            type: object
                            description: 'an individual layout mapping entry.

                              During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                              '
                            properties:
                              defaultLayout:
                                type: object
                                description: an individual layout reference.
                                properties:
                                  id:
                                    type: string
                                    description: The ID of the referenced layout.
                                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                    minLength: 1
                                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                  name:
                                    type: string
                                    description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                      This field is read only.

                                      '
                                    example: Sample Layout
                                required:
                                - id
                              layouts:
                                type: array
                                description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                                items:
                                  type: object
                                  description: an individual layout reference.
                                  properties:
                                    id:
                                      type: string
                                      description: The ID of the referenced layout.
                                      pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                      minLength: 1
                                      example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                    name:
                                      type: string
                                      description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                        This field is read only.

                                        '
                                      example: Sample Layout
                                  required:
                                  - id
                                minItems: 1
                            required:
                            - defaultLayout
                            - layouts
                          minItems: 1
                          maxItems: 1
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - type
                      - mappings
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/layout-mappings/views/by-name:
    get:
      tags:
      - Authoring layouts
      summary: Retrieve all layout mappings in the database with the specified name.
      description: 'Use the /layout-mappings/views/by-name endpoint to retrieve all layout mappings from the database with the specified name.<br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: name
        in: query
        description: The name to query.
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of layout mappings to skip and return the rest.
        required: false
        schema:
          type: number
          format: integer
          default: 0
      - name: limit
        in: query
        description: Set the limit for the number of layout mappings that are returned.
        required: false
        schema:
          type: number
          format: integer
          default: 50
      - name: fields
        in: query
        description: Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list.
        required: false
        schema:
          type: string
      - name: format
        in: query
        required: false
        description: "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n"
        schema:
          type: string
          enum:
          - feed
          - array
          - sequence
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                description: A query result that returns layout mappings.
                properties:
                  offset:
                    type: integer
                    description: number of results to skip.
                  limit:
                    type: integer
                    description: number of results to return.
                  href:
                    type: string
                    description: the url of the current query.
                  next:
                    type: string
                    description: the url for the next page of results. Only present if there are more results.
                  previous:
                    type: string
                    description: the url for the previous page of results. Not present when on the first page.
                  items:
                    type: array
                    items:
                      type: object
                      description: An existing layout mapping.
                      properties:
                        id:
                          type: string
                          description: The ID of the layout mapping.
                          pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                          minLength: 1
                          example: e0192c4c-9633-4853-856a-ce04e37ec40c
                        rev:
                          type: string
                          description: The current revision of the layout mapping.
                          minLength: 1
                          example: 1d5fc65f4cd277eb5340355db7ecdfde75
                        name:
                          type: string
                          description: The name of the layout mapping.
                          pattern: ^[a-zA-Z0-9*. \-+_~$!',()]*$
                          minLength: 1
                          example: Sample layout mapping
                        classification:
                          type: string
                          description: Indicates the type of this document.
                          enum:
                          - layout-mapping
                        creatorId:
                          type: string
                          description: The ID of the user that created the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: 'The display name of the user that created the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        created:
                          type: string
                          description: The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the layout mapping.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        lastModifier:
                          type: string
                          description: 'The display name of the last user that modified the layout mapping. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                            This field is read only.

                            '
                          example: Thomas Watson
                        lastModified:
                          type: string
                          description: The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
                          format: date-time
                          example: '2016-11-02T06:28:47Z'
                        path:
                          type: string
                          description: Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
                          example: /myLayoutMappings/SampleMapping.json
                        tags:
                          type: array
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        type:
                          type: object
                          description: 'The mapped content-type. Must be unique.

                            During create and update operations, the mapped content-type can be referred to by either id or name.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the mapped content-type.
                              pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                              minLength: 1
                              example: 092c46f6-09c0-4ffe-9f21-52d041b4a73c
                            name:
                              type: string
                              description: 'The name of the mapped content-type. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                '
                              example: Sample Type
                        mappings:
                          type: array
                          description: The mapped layouts.
                          items:
                            type: object
                            description: 'an individual layout mapping entry.

                              During creates and updates, if there is only one layout specified within the ''layouts'' property, then the ''defaultLayout'' property is optional (and will be inserted by the system).

                              '
                            properties:
                              defaultLayout:
                                type: object
                                description: an individual layout reference.
                                properties:
                                  id:
                                    type: string
                                    description: The ID of the referenced layout.
                                    pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                    minLength: 1
                                    example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                  name:
                                    type: string
                                    description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                      This field is read only.

                                      '
                                    example: Sample Layout
                                required:
                                - id
                              layouts:
                                type: array
                                description: The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
                                items:
                                  type: object
                                  description: an individual layout reference.
                                  properties:
                                    id:
                                      type: string
                                      description: The ID of the referenced layout.
                                      pattern: ^[a-zA-Z0-9*.\-+_~$!',()]*$
                                      minLength: 1
                                      example: f26044ca-d92d-49e8-acd9-00563c1e0db9
                                    name:
                                      type: string
                                      description: 'The name of the referenced layout. This field is only returned when the ''include'' query string option is set to ''ALL'' or ''metadata''.

                                        This field is read only.

                                        '
                                      example: Sample Layout
                                  required:
                                  - id
                                minItems: 1
                            required:
                            - defaultLayout
                            - layouts
                          minItems: 1
                          maxItems: 1
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not.
                          default: false
                      required:
                      - rev
                      - name
                      - type
                      - mappings
        '400':
          description: Invalid name or Invalid input.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '403':
          description: The operation is not available based on the current tenant's tier.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      description: an individual error, info or warning message.
                      properties:
                        code:
                          type: integer
                          description: The message code.
                        key:
                          type: string
                          description: The message key.
                        message:
                          type: string
                          description: The error message.
                        description:
                          type: string
                          description: Optional detailed error message.
                        more_info:
                          type: string
                          description: Optional additional information for the message.
                        category:
                          type: string
                          description: The message category whereby only user messages are designed to be shown to an end user.
                          enum:
                          - API
                          - USER
                        level:
                          type: string
                          description: Indicates the message level.
                          enum:
                          - INFO
                          - WARNING
                          - ERROR
                        parameters:
                          type: object
                          description: The message parameters of this message.
                        field:
                          type: string
                          description: Only present on field validation errors, indicates the field in error.
                        locale:
                          type: string
                          description: The current locale used to produce the error message.
                  requestId:
                    type: string
                    description: The current request ID.
                  service:
                    type: string
                    description: The name of the service that produced the error.
                  requestMethod:
                    type: string
                    description: The Http method type of the current request.
                  requestUri:
                    type: string
                    description: The current request uri.
        '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'
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
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