openapi: 3.2.0
info:
  title: Acoustic Authoring content API
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  description: 'Operations tagged Authoring content 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 content
  description: ' ## General

    Use the Content content authoring data service Rest APIs to work with content documents. Content includes items that you compose in your content hub and upload from outside your content subscription. You can create, retrieve, and update content documents in a database. You can also create draft versions, change the status, and get a count of the total content in your database.


    ## Content workflow (status)

    The status of a content item can be determined by the **suffix** of the ID:

    - An ID like xxxx:**draft** indicates that the item is a draft. This is the initial status of a new content item until it is published. A draft of a published content item will also have this suffix.

    - An ID like xxxx:***[publishing_job_id]*** - indicates that the content item has been scheduled for publish in the given publishing job.

    - An ID like xxxx with no suffix indicates that the content is **published** or **retired**.

    A draft can be created from published. When such a draft is published, it will override the previously published content.


    **Key notes:**

    - The base ID (xxxx) does not change. Only the suffix changes according to the workflow status of the item.

    - Where content and assets are referenced from within a content item, the ''raw'' ID form, without a suffix, is always used. For example, when a draft content item is referenced by another draft content item, the reference appears as a raw ID, and thus does not change when the items are published.

    - API clients should not depend on the ID format and should not attempt to parse it. Instead, the ***linkedDocId*** and ***links*** properties should be used.

    - Draft item have a property ***linkedDocId***. This is the Id that the draft item will have when it is published.

    - Draft items that have a published version will have a ***linkedDoc*** property within the ***links*** property. This property will not appear for drafts that do not have a published version.'
paths:
  /authoring/v1/content:
    get:
      summary: List all content items in the database.
      description: 'Use the /content endpoint to list all content items in the database.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest.
        required: false
        schema:
          type: number
          format: integer
      - name: fields
        in: query
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Set the limit for the maximum number of content items to return in a single result. The default value is 50.
        required: false
        schema:
          type: number
          format: integer
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully lists a paged result view of all content items in the database.
          content:
            application/json:
              schema:
                type: object
                properties:
                  limit:
                    type: integer
                    description: The page size.
                    example: 50
                  offset:
                    type: integer
                    description: The number of items to skip from the beginning of the list.
                    example: 0
                  href:
                    type: string
                    description: A link to the current page.
                    example: /authoring/v1/content?offset=50&limit=50
                  next:
                    type: string
                    description: A link to the next page. Only shown if a next page exists.
                    example: /authoring/v1/content?offset=100&limit=50
                  previous:
                    type: string
                    description: A link to the previous page. Only shown if a previous page exists.
                    example: /authoring/v1/content?offset=0&limit=50
                  items:
                    type: array
                    items:
                      title: Content Schema
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the content item.
                          example: 925d1454-167b-431b-a54c-6cbf0354398d
                        rev:
                          type: string
                          description: The current revision of the document.
                          example: 25-2ba981d0661c3129c31cc4993e569e3f
                        name:
                          type: string
                          description: The name of the content item.
                          example: Sample Content
                        description:
                          type: string
                          description: The description of the content item.
                          example: An example description of the sample content
                        typeId:
                          type: string
                          description: The ID of the content type this item belongs to.
                          example: b0798e67-3da2-48b4-b044-016495fa3ead
                        type:
                          type: string
                          description: The name of the content type this item belongs to. Only included when using include=metadata
                          example: Article
                        kind:
                          type: string
                          description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                          example: email
                        lastModified:
                          type: string
                          format: date-time
                          description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the content.
                          example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                        lastModifier:
                          type: string
                          description: The display name of the user that last modified the content.
                          example: Thomas Watson
                        created:
                          type: string
                          format: date-time
                          description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        creatorId:
                          type: string
                          description: The ID of the creator of the content.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: The display name of the user that created the content.
                          example: Thomas Watson
                        classification:
                          description: The classification defines the document type. For content items, all documents are classified as "content".
                          enum:
                          - content
                        status:
                          description: the workflow status of the content.
                          enum:
                          - draft
                          - ready
                          - retired
                        linkedDocId:
                          type: string
                          description: Provided on drafts of existing items. This is the ID of the primary item.
                          example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                        elements:
                          type: object
                          description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                          example:
                            videokey:
                              elementType: video
                              asset:
                                id: a21b3718-a801-4343-8a73-6f94ee2763ba
                                resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                                fileSize: 448338
                                fileName: testVideo.mp4
                                mediaType: video/mp4
                              thumbnail:
                                resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                                resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                                fileName: cap.jpg
                            categorykey:
                              elementType: category
                              categoryIds:
                              - ae607a10216249805ee0488d3e0f1e64
                            datekey:
                              elementType: datetime
                              value: '2016-11-07T10:09:00Z'
                            textkey:
                              elementType: text
                              value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                            togglekey:
                              elementType: toggle
                              value: true
                            linkkey:
                              elementType: link
                              linkURL: http://acoustic.com
                              linkText: Acoustic
                            imagekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                                  source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                              asset:
                                id: 400974f1-10d8-4db9-a711-a840e315fdef
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                                fileName: cap.jpg
                                fileSize: 113730
                                mediaType: image/jpeg
                            filekey:
                              elementType: file
                              asset:
                                id: 913099e2-3e53-497c-b264-77ed974b1694
                                resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                                fileSize: 145592
                                fileName: news.pdf
                                mediaType: application/pdf
                            numberkey:
                              elementType: number
                              value: 42
                            imagewithprofilekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                                mobile:
                                  renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                              asset:
                                id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                                fileName: tree-738816_1920.jpg
                                fileSize: 273419
                                mediaType: image/jpeg
                        tags:
                          type: array
                          description: The tags describing the content item.
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        links:
                          type: object
                          properties:
                            self:
                              type: object
                              description: The default link back to this document
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                            linkedDoc:
                              type: object
                              description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            draft:
                              type: object
                              description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            create-draft:
                              type: object
                              description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                            ready:
                              type: object
                              description: This link will appear for items that can be transitioned to the ready state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                            retire:
                              type: object
                              description: This link will appear for items that can be transitioned to the retired state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                            type:
                              type: object
                              description: This is the link to the content's type.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                        thumbnail:
                          type: object
                          description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                            This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: The path of the resource.
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: The url of the resource.
                              example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                          default: false
                        libraryId:
                          type: string
                          description: If this property is set it points to library id that the item is assigned to.
                      additionalProperties: false
        '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'
        '503':
          description: Unable to list the content items in the database as the service is currently unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
    post:
      summary: Create content items.
      description: "Use the /content endpoint to create content. A content type must be specified through the typeId property. You cannot create content without a content type.\n\n### Example: ###\nCreates a readied content that contains the name and birthday of a person.\n#\n~~~\n{\n  \"name\": \"Person\",\n  \"typeId\": \"b0798e67-3da2-48b4-b044-016495fa3ead\",\n  \"status\": \"ready\",\n  \"elements\": {\n    \"name\": {\n      \"elementType\": \"text\",\n      \"value\": \"Thomas Watson\"\n    },\n    \"birthday\": {\n      \"elementType\": \"datetime\",\n      \"value\": \"1874-02-17T00:00:00Z\"\n    }\n  }\n}\n~~~\n<br />User roles: admin, manager, editor"
      parameters:
      - name: x-ibm-dx-publish-priority
        in: header
        description: Specify `now` to bypass the publishing schedule. Specify `next` to use publishing schedule.
        schema:
          type: string
          format: string
          enum:
          - now
          - next
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the content item.
                  example: Sample Content
                typeId:
                  type: string
                  description: The ID of the content type this content item is based on.
                  example: b0798e67-3da2-48b4-b044-016495fa3ead
                elements:
                  type: object
                  description: 'Elements are defined in the content type. A content type for a content is referenced through the typeId attribute. The elements in the content are based on the content type that is referenced.  A content can have multiple elements such as text, number, video, images. For example, to include a text element include \"someTextElement\":{\"elementType\": \"text\", \"value\": \"some text goes here\" }. For a complete list of content elements, see https://developer.goacoustic.com/acoustic-content/reference#authoring-content

                    '
                isSystem:
                  type: boolean
                  description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                  default: false
                libraryId:
                  type: string
                  description: If this property is set it points to library id that the item is assigned to.
              required:
              - name
              - typeId
        description: Provide the content item fields such as name, typeId, status and tags. The name and typeId fields are required.
        required: true
      tags:
      - Authoring content
      responses:
        '201':
          description: Successfully created a content item with the specified content type.
          headers:
            x-ibm-dx-validation-warnings:
              description: The number of validation warnings that occurred. Use the /content/{id}/validate endpoint for a full list of any warnings.
              schema:
                type: integer
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The url of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library id that the item is assigned to.
                additionalProperties: false
        '400':
          description: The body parameter is empty or has an invalid input. Provide valid type fields that are required to create the new content item.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to create the content item as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
  /authoring/v1/content/{id}:
    get:
      summary: Retrieve an existing content item.
      description: 'Use the /content/{id} endpoint to retrieve an existing content item from the database. This endpoint returns the API representation of a content item.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item that you want to retrieve.
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: Optional. Parameters used to include additional fields inside each returned content item. Use "links" to include the links section, which contains URLs for actions that can be performed on the content item. Use "metadata" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, "include=links, metadata".
        schema:
          type: string
      - name: fields
        in: query
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        required: false
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully retrieved the API representation for the existing content item that matches the ID that you provided.
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The url of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library id that the item is assigned to.
                additionalProperties: false
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to retrieve the content item from the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
    put:
      summary: Update an existing content item.
      description: 'Use the /content/{id} end point to update an existing content item. You must retrieve the content item first by using the GET endpoint before you can update. This endpoint requires the full representation of the content item to update it. If there is a need to preview and/or review changes to the item prior to the update going live, first use the /content/{id}/create-draft endpoint to create a draft of the item and perform the update on the draft version. Following this, the draft may then be readied via the /content/{id}/ready endpoint to finalize the update. However, if there is no need to preview and/or review the update, then the update can be directly performed on an item with "ready" status.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item that you want to update.
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: Optional. Parameters used to include additional fields inside each returned content item. Use "links" to include the links section, which contains URLs for actions that can be performed on the content item. Use "metadata" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, "include=links, metadata".
        schema:
          type: string
      - name: fields
        in: query
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        required: false
        schema:
          type: string
      - name: forceOverride
        in: query
        description: Force this update over the existing content item. When set to true, this request will overwrite the stored content, regardless of a difference in revisions (ignoring or reverting changes that were made since the item was last retrieved).
        required: false
        schema:
          type: boolean
      - name: x-ibm-dx-publish-priority
        in: header
        description: Specify `now` to bypass the publishing schedule. Specify `next` to use publishing schedule.
        schema:
          type: string
          format: string
          enum:
          - now
          - next
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rev:
                  type: string
                  description: The current revision of the document.
                  example: 25-2ba981d0661c3129c31cc4993e569e3f
                typeId:
                  type: string
                  description: The ID of the content type this content item is based on.
                  example: b0798e67-3da2-48b4-b044-016495fa3ead
        description: Provide the body fields such as name, typeId, tags, and data of the content item that you want to update. If you do not provide any information, the content item will not be updated before it is moved to the published stage. The current revision must be provided in order to update the content.
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully updated the content item that matches the ID that you provided.
          headers:
            x-ibm-dx-validation-warnings:
              description: The number of validation warnings that occurred. Use the /content/{id}/validate endpoint for a full list of any warnings.
              schema:
                type: integer
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The url of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library id that the item is assigned to.
                additionalProperties: false
        '400':
          description: The update request is invalid or the request failed validation.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '409':
          description: Unable to update the content item with the ID {id} because another user updated the content item since it was last retrieved. Retrieve the content item again and reapply your changes.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to retrieve the content item from the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
    delete:
      summary: Delete an existing content item immediately.
      description: 'Use the /content/{id} endpoint to delete an existing content item in the database. If the content item that you want to delete has an active draft version, then you cannot delete it. Delete the draft version of the content item and then delete the content item.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item that you want to delete.
        required: true
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully deleted the content item that matches the ID that you provided.
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '409':
          description: Unable to delete the content item with the ID "{0}" because another user updated the content item since it was last retrieved.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to delete the content item in the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
  /authoring/v1/content/views/by-type:
    get:
      summary: Retrieve all content of the specified type.
      description: 'Use the /content/views/by-type endpoint to retrieve all content items of a specified content type from the database.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: id
        in: query
        description: Provide the ID of the content type by which you want to filter the content items.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest.
        required: false
        schema:
          type: number
          format: integer
      - name: limit
        in: query
        description: Set the limit for the maximum number of content items to return in a single result. The default value is 50.
        required: false
        schema:
          type: number
          format: integer
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully lists a paged result view of all content items of a specified content type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  limit:
                    type: integer
                    description: The page size.
                    example: 50
                  offset:
                    type: integer
                    description: The number of items to skip from the beginning of the list.
                    example: 0
                  href:
                    type: string
                    description: A link to the current page.
                    example: /authoring/v1/content?offset=50&limit=50
                  next:
                    type: string
                    description: A link to the next page. Only shown if a next page exists.
                    example: /authoring/v1/content?offset=100&limit=50
                  previous:
                    type: string
                    description: A link to the previous page. Only shown if a previous page exists.
                    example: /authoring/v1/content?offset=0&limit=50
                  items:
                    type: array
                    items:
                      title: Content Schema
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the content item.
                          example: 925d1454-167b-431b-a54c-6cbf0354398d
                        rev:
                          type: string
                          description: The current revision of the document.
                          example: 25-2ba981d0661c3129c31cc4993e569e3f
                        name:
                          type: string
                          description: The name of the content item.
                          example: Sample Content
                        description:
                          type: string
                          description: The description of the content item.
                          example: An example description of the sample content
                        typeId:
                          type: string
                          description: The ID of the content type this item belongs to.
                          example: b0798e67-3da2-48b4-b044-016495fa3ead
                        type:
                          type: string
                          description: The name of the content type this item belongs to. Only included when using include=metadata
                          example: Article
                        kind:
                          type: string
                          description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                          example: email
                        lastModified:
                          type: string
                          format: date-time
                          description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the content.
                          example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                        lastModifier:
                          type: string
                          description: The display name of the user that last modified the content.
                          example: Thomas Watson
                        created:
                          type: string
                          format: date-time
                          description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        creatorId:
                          type: string
                          description: The ID of the creator of the content.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: The display name of the user that created the content.
                          example: Thomas Watson
                        classification:
                          description: The classification defines the document type. For content items, all documents are classified as "content".
                          enum:
                          - content
                        status:
                          description: the workflow status of the content.
                          enum:
                          - draft
                          - ready
                          - retired
                        linkedDocId:
                          type: string
                          description: Provided on drafts of existing items. This is the ID of the primary item.
                          example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                        elements:
                          type: object
                          description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                          example:
                            videokey:
                              elementType: video
                              asset:
                                id: a21b3718-a801-4343-8a73-6f94ee2763ba
                                resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                                fileSize: 448338
                                fileName: testVideo.mp4
                                mediaType: video/mp4
                              thumbnail:
                                resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                                resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                                fileName: cap.jpg
                            categorykey:
                              elementType: category
                              categoryIds:
                              - ae607a10216249805ee0488d3e0f1e64
                            datekey:
                              elementType: datetime
                              value: '2016-11-07T10:09:00Z'
                            textkey:
                              elementType: text
                              value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                            togglekey:
                              elementType: toggle
                              value: true
                            linkkey:
                              elementType: link
                              linkURL: http://acoustic.com
                              linkText: Acoustic
                            imagekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                                  source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                              asset:
                                id: 400974f1-10d8-4db9-a711-a840e315fdef
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                                fileName: cap.jpg
                                fileSize: 113730
                                mediaType: image/jpeg
                            filekey:
                              elementType: file
                              asset:
                                id: 913099e2-3e53-497c-b264-77ed974b1694
                                resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                                fileSize: 145592
                                fileName: news.pdf
                                mediaType: application/pdf
                            numberkey:
                              elementType: number
                              value: 42
                            imagewithprofilekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                                mobile:
                                  renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                              asset:
                                id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                                fileName: tree-738816_1920.jpg
                                fileSize: 273419
                                mediaType: image/jpeg
                        tags:
                          type: array
                          description: The tags describing the content item.
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        links:
                          type: object
                          properties:
                            self:
                              type: object
                              description: The default link back to this document
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                            linkedDoc:
                              type: object
                              description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            draft:
                              type: object
                              description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            create-draft:
                              type: object
                              description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                            ready:
                              type: object
                              description: This link will appear for items that can be transitioned to the ready state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                            retire:
                              type: object
                              description: This link will appear for items that can be transitioned to the retired state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                            type:
                              type: object
                              description: This is the link to the content's type.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                        thumbnail:
                          type: object
                          description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                            This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: The path of the resource.
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: The url of the resource.
                              example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                          default: false
                        libraryId:
                          type: string
                          description: If this property is set it points to library id that the item is assigned to.
                      additionalProperties: false
        '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'
        '503':
          description: Unable to list the content items in the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/content/views/by-modified:
    get:
      summary: Retrieve all content modified within the specified date.
      description: 'Use the /content/views/by-modified endpoint to retrieve all content items that was modified within the date range specified.

        <br />User roles: admin, manager, editor, viewer'
      parameters:
      - name: start
        in: query
        required: false
        description: 'Provide the date and time of when the last modifications were made to the content items that you want returned. The content items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end.'
        schema:
          type: string
          format: date-time
      - name: end
        in: query
        required: false
        description: 'Provide the date and time of when the last modifications were made to the content items that you want returned. The content items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ. Note: when reversing the order you do not switch start and end.'
        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. Note: when reversing the order you do not switch start and end ids.'
        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. Note: when reversing the order you do not switch start and end ids.'
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Set the limit for the maximum number of content items to return in a single result. The default value is 50. You can pass 0 to unset the limit and stream all available results. A streaming parser can be avoided with format=sequence.
        schema:
          type: number
          format: integer
      - 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: offset
        in: query
        required: false
        description: 'Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest. Note: large offsets perform poorly. Use start keys to index into large result sets. Also see pageMode.'
        schema:
          type: number
          format: integer
      - 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: fields
        in: query
        required: false
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        schema:
          type: string
      - name: order
        in: query
        required: false
        description: "Specify the order of the results.\n * `ascending` - (default) result keys are increasing\n * `descending` - result keys are decreasing\n\nIt is not necessary to switch the start and end keys and ids when reversing the order.\n"
        schema:
          type: string
          enum:
          - ascending
          - descending
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully lists a paged result view of all content items that was modified within the date range specified.
          content:
            application/json:
              schema:
                type: object
                properties:
                  limit:
                    type: integer
                    description: The page size.
                    example: 50
                  offset:
                    type: integer
                    description: The number of items to skip from the beginning of the list.
                    example: 0
                  href:
                    type: string
                    description: A link to the current page.
                    example: /authoring/v1/content?offset=50&limit=50
                  next:
                    type: string
                    description: A link to the next page. Only shown if a next page exists.
                    example: /authoring/v1/content?offset=100&limit=50
                  previous:
                    type: string
                    description: A link to the previous page. Only shown if a previous page exists.
                    example: /authoring/v1/content?offset=0&limit=50
                  items:
                    type: array
                    items:
                      title: Content Schema
                      type: object
                      properties:
                        id:
                          type: string
                          description: The ID of the content item.
                          example: 925d1454-167b-431b-a54c-6cbf0354398d
                        rev:
                          type: string
                          description: The current revision of the document.
                          example: 25-2ba981d0661c3129c31cc4993e569e3f
                        name:
                          type: string
                          description: The name of the content item.
                          example: Sample Content
                        description:
                          type: string
                          description: The description of the content item.
                          example: An example description of the sample content
                        typeId:
                          type: string
                          description: The ID of the content type this item belongs to.
                          example: b0798e67-3da2-48b4-b044-016495fa3ead
                        type:
                          type: string
                          description: The name of the content type this item belongs to. Only included when using include=metadata
                          example: Article
                        kind:
                          type: string
                          description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                          example: email
                        lastModified:
                          type: string
                          format: date-time
                          description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        lastModifierId:
                          type: string
                          description: The ID of the user that last modified the content.
                          example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                        lastModifier:
                          type: string
                          description: The display name of the user that last modified the content.
                          example: Thomas Watson
                        created:
                          type: string
                          format: date-time
                          description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                          example: '2016-11-02T06:28:47Z'
                        creatorId:
                          type: string
                          description: The ID of the creator of the content.
                          example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                        creator:
                          type: string
                          description: The display name of the user that created the content.
                          example: Thomas Watson
                        classification:
                          description: The classification defines the document type. For content items, all documents are classified as "content".
                          enum:
                          - content
                        status:
                          description: the workflow status of the content.
                          enum:
                          - draft
                          - ready
                          - retired
                        linkedDocId:
                          type: string
                          description: Provided on drafts of existing items. This is the ID of the primary item.
                          example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                        elements:
                          type: object
                          description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                          example:
                            videokey:
                              elementType: video
                              asset:
                                id: a21b3718-a801-4343-8a73-6f94ee2763ba
                                resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                                fileSize: 448338
                                fileName: testVideo.mp4
                                mediaType: video/mp4
                              thumbnail:
                                resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                                resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                                fileName: cap.jpg
                            categorykey:
                              elementType: category
                              categoryIds:
                              - ae607a10216249805ee0488d3e0f1e64
                            datekey:
                              elementType: datetime
                              value: '2016-11-07T10:09:00Z'
                            textkey:
                              elementType: text
                              value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                            togglekey:
                              elementType: toggle
                              value: true
                            linkkey:
                              elementType: link
                              linkURL: http://acoustic.com
                              linkText: Acoustic
                            imagekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                                  source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                              asset:
                                id: 400974f1-10d8-4db9-a711-a840e315fdef
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                                fileName: cap.jpg
                                fileSize: 113730
                                mediaType: image/jpeg
                            filekey:
                              elementType: file
                              asset:
                                id: 913099e2-3e53-497c-b264-77ed974b1694
                                resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                                fileSize: 145592
                                fileName: news.pdf
                                mediaType: application/pdf
                            numberkey:
                              elementType: number
                              value: 42
                            imagewithprofilekey:
                              elementType: image
                              renditions:
                                default:
                                  renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                                mobile:
                                  renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                                  source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                              asset:
                                id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                                resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                                fileName: tree-738816_1920.jpg
                                fileSize: 273419
                                mediaType: image/jpeg
                        tags:
                          type: array
                          description: The tags describing the content item.
                          items:
                            type: string
                          uniqueItems: true
                          example:
                          - news
                          - sample
                        links:
                          type: object
                          properties:
                            self:
                              type: object
                              description: The default link back to this document
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                            linkedDoc:
                              type: object
                              description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            draft:
                              type: object
                              description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                            create-draft:
                              type: object
                              description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                            ready:
                              type: object
                              description: This link will appear for items that can be transitioned to the ready state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                            retire:
                              type: object
                              description: This link will appear for items that can be transitioned to the retired state.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                            type:
                              type: object
                              description: This is the link to the content's type.
                              properties:
                                href:
                                  type: string
                              example:
                                href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                        thumbnail:
                          type: object
                          description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                            This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                            '
                          properties:
                            id:
                              type: string
                              description: The ID of the asset.
                              example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                            path:
                              type: string
                              description: The path of the resource.
                              example: /sales/images/hub.png
                            url:
                              type: string
                              description: The url of the resource.
                              example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                        isSystem:
                          type: boolean
                          description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                          default: false
                        libraryId:
                          type: string
                          description: If this property is set it points to library id that the item is assigned to.
                      additionalProperties: false
        '401':
          description: You do not have authorization to retrieve the content items from the database.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to list the content items in the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
  /authoring/v1/content/{id}/create-draft:
    post:
      summary: Create a draft version of an existing content item.
      description: 'Use the /content/{id}/create-draft endpoint to create a draft version of an existing content item. You can create a draft version when a content item document is in ready or retired status. If a draft of the content item already exists, you cannot create a draft.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item that you want to create a draft version.
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: Provide an revision value from a previous request to check when a content item was last updated. If the value that you provide is old, the call returns a 412 with the latest version of the content item.
        schema:
          type: string
      - name: include
        in: query
        description: Optional. Parameters used to include additional fields inside each returned content item. Use "links" to include the links section, which contains URLs for actions that can be performed on the content item. Use "metadata" to include additional fields for each of the items referenced by the content item, such as the URL of the referenced assets. You can specify multiple fields as a comma-separated value. For example, "include=links, metadata".
        schema:
          type: string
      - name: fields
        in: query
        description: Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.
        required: false
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully created a draft version of the content item.
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The url of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library id that the item is assigned to.
                additionalProperties: false
        '400':
          description: The content item is not in the ready state and cannot create a draft.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '409':
          description: A draft already exists with the given ID or unable to create a draft of the content item as it was updated by another user since you retrieved it.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '412':
          description: The If-Match pre-condition failed. The revision value that you provided in the If-Match parameter did not match the recent document version. The error message includes the recent version of the document.
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The url of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library id that the item is assigned to.
                additionalProperties: false
        '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'
        '503':
          description: Unable to change the status of the content item as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
  /authoring/v1/content/count:
    get:
      summary: Retrieve the total number of content items in the database.
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully returns the count of the total number of content items in the database.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                example:
                  count: 348
                required:
                - count
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      description: '<br />User roles: admin, manager, editor, viewer'
  /authoring/v1/content/{id}/analyze:
    post:
      summary: AI analyzes and provides tag recommendations for the content.
      description: 'Use the /content/{id}/analyze endpoint to perform AI analysis on content text.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item that you need to perform AI analytics.
        required: true
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully retrieved cognitive tags for content text.
          content:
            application/json:
              schema:
                type: object
                properties:
                  concepts:
                    type: array
                    items:
                      type: string
                    example:
                    - news
                    - sample
                  entities:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        type:
                          type: string
        '400':
          description: The content locale is not supported by AI Text API.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
  /authoring/v1/content/{id}/validate:
    post:
      summary: Validate the specified content item against its type.
      description: 'Use the /content/{id}/validate end-point to validate if the content item specified matches its recorded content type.<br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content document that you want to validate.
        required: true
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Completed the validation, which failed for this content item. See the results to find out what validation errors occurred.
          content:
            application/json:
              schema:
                type: object
                description: a validation response.
                properties:
                  failedIds:
                    type: array
                    description: The submitted ID which failed validation.
                    items:
                      type: string
                      description: The ID of the content item which failed validation
                      example: b0798e67-3da2-48b4-b044-016495fa3ead
                  messages:
                    type: object
                    description: The validation errors which occurred for the content item
                    properties:
                      SOME_ID:
                        type: array
                        description: The array of error messages for this id
                        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.
                          required:
                          - code
                          - key
                          - message
                          - description
                          - more_info
                          - category
                          - level
                          - parameters
                          - field
                          - locale
        '204':
          description: Successfully completed the validation; validation passed.
        '400':
          description: The ID that you provided is invalid, provide a valid ID.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '401':
          description: You do not have authorization to validate this content item.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '404':
          description: A content item 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:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to validate the content item as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request uri
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
  /authoring/v1/content/{id}/unpublish:
    post:
      summary: Unpublish a published item.
      description: 'Use the /content/{id}/unpublish endpoint to unpublish an existing published content item in the database.

        <br />User roles: admin, manager, editor'
      parameters:
      - name: id
        in: path
        description: Provide the ID of the content item to unpublish.
        required: true
        schema:
          type: string
      tags:
      - Authoring content
      responses:
        '200':
          description: Successfully unpublished the item.
          headers:
            x-ibm-dx-validation-warnings:
              description: The number of validation warnings that occurred. Use the /content/{id}/validate endpoint for a full list of any warnings.
              schema:
                type: integer
          content:
            application/json:
              schema:
                title: Content Schema
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the content item.
                    example: 925d1454-167b-431b-a54c-6cbf0354398d
                  rev:
                    type: string
                    description: The current revision of the document.
                    example: 25-2ba981d0661c3129c31cc4993e569e3f
                  name:
                    type: string
                    description: The name of the content item.
                    example: Sample Content
                  description:
                    type: string
                    description: The description of the content item.
                    example: An example description of the sample content
                  typeId:
                    type: string
                    description: The ID of the content type this item belongs to.
                    example: b0798e67-3da2-48b4-b044-016495fa3ead
                  type:
                    type: string
                    description: The name of the content type this item belongs to. Only included when using include=metadata
                    example: Article
                  kind:
                    type: string
                    description: The kind of the content. Recognized values are "site", "page", "landing-page", "email"
                    example: email
                  lastModified:
                    type: string
                    format: date-time
                    description: The last modified date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read-only.
                    example: '2016-11-02T06:28:47Z'
                  lastModifierId:
                    type: string
                    description: The ID of the user that last modified the content.
                    example: 63b800fa-51a7-4602-8cbe-ab3b9cee28b9
                  lastModifier:
                    type: string
                    description: The display name of the user that last modified the content.
                    example: Thomas Watson
                  created:
                    type: string
                    format: date-time
                    description: The created date of this content item in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read-only.
                    example: '2016-11-02T06:28:47Z'
                  creatorId:
                    type: string
                    description: The ID of the creator of the content.
                    example: 8c622bbb-5f5b-45d4-89e1-fce1c054138f
                  creator:
                    type: string
                    description: The display name of the user that created the content.
                    example: Thomas Watson
                  classification:
                    description: The classification defines the document type. For content items, all documents are classified as "content".
                    enum:
                    - content
                  status:
                    description: the workflow status of the content.
                    enum:
                    - draft
                    - ready
                    - retired
                  linkedDocId:
                    type: string
                    description: Provided on drafts of existing items. This is the ID of the primary item.
                    example: b289c02e-2c61-4643-aba6-e6b4e94c76e3
                  elements:
                    type: object
                    description: The elements section is dependent on the content type of this content. (Referenced via the typeId attribute) with Elements are defined in the content type and therefore  the elements section is dependent on the content type of this content. The content type is referenced through the typeId attribute. A content can have multiple elements such as text, number, video, images etc. For a complete list of content elements see, https://developer.goacoustic.com/acoustic-content/reference#authoring-content
                    example:
                      videokey:
                        elementType: video
                        asset:
                          id: a21b3718-a801-4343-8a73-6f94ee2763ba
                          resourceUri: /authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1
                          fileSize: 448338
                          fileName: testVideo.mp4
                          mediaType: video/mp4
                        thumbnail:
                          resourceId: ef2e1f5fa89f2f93dfba19520f629c84
                          resourceUri: /authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84
                          fileName: cap.jpg
                      categorykey:
                        elementType: category
                        categoryIds:
                        - ae607a10216249805ee0488d3e0f1e64
                      datekey:
                        elementType: datetime
                        value: '2016-11-07T10:09:00Z'
                      textkey:
                        elementType: text
                        value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
                      togglekey:
                        elementType: toggle
                        value: true
                      linkkey:
                        elementType: link
                        linkURL: http://acoustic.com
                        linkText: Acoustic
                      imagekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 61096914-e33a-4021-9a5d-be06337206fd
                            source: /authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg
                        asset:
                          id: 400974f1-10d8-4db9-a711-a840e315fdef
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82
                          fileName: cap.jpg
                          fileSize: 113730
                          mediaType: image/jpeg
                      filekey:
                        elementType: file
                        asset:
                          id: 913099e2-3e53-497c-b264-77ed974b1694
                          resourceUri: /authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b
                          fileSize: 145592
                          fileName: news.pdf
                          mediaType: application/pdf
                      numberkey:
                        elementType: number
                        value: 42
                      imagewithprofilekey:
                        elementType: image
                        renditions:
                          default:
                            renditionId: 39a94d18-9063-4785-80f8-cc5520255afe
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg
                          mobile:
                            renditionId: 583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b
                            source: /authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0
                        asset:
                          id: b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545
                          resourceUri: /authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                          fileName: tree-738816_1920.jpg
                          fileSize: 273419
                          mediaType: image/jpeg
                  tags:
                    type: array
                    description: The tags describing the content item.
                    items:
                      type: string
                    uniqueItems: true
                    example:
                    - news
                    - sample
                  links:
                    type: object
                    properties:
                      self:
                        type: object
                        description: The default link back to this document
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d
                      linkedDoc:
                        type: object
                        description: This link will appear if this item is a draft of an existing item. The link points to the primary item
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      draft:
                        type: object
                        description: This link will appear on an item if there exists a draft of this item. The link points to the draft.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9
                      create-draft:
                        type: object
                        description: This link will appear for items in ready and retired state that don't already have an existing draft. It will create a draft of this item.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft
                      ready:
                        type: object
                        description: This link will appear for items that can be transitioned to the ready state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready
                      retire:
                        type: object
                        description: This link will appear for items that can be transitioned to the retired state.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire
                      type:
                        type: object
                        description: This is the link to the content's type.
                        properties:
                          href:
                            type: string
                        example:
                          href: /authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead
                  thumbnail:
                    type: object
                    description: 'The reference to the resource that should act as the thumbnail of this content item.

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

                      This field is read-only, and is determined by the contentThumbnail field on the content type. The type can specify an image element on this content item, or a specific image resource.

                      '
                    properties:
                      id:
                        type: string
                        description: The ID of the asset.
                        example: 6c622bbb-5f5b-45d4-89e1-fce1c054138f
                      path:
                        type: string
                        description: The path of the resource.
                        example: /sales/images/hub.png
                      url:
                        type: string
                        description: The URL of the resource.
                        example: /authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8
                  isSystem:
                    type: boolean
                    description: Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
                    default: false
                  libraryId:
                    type: string
                    description: If this property is set it points to library ID that the item is assigned to.
                additionalProperties: false
        '404':
          description: The content item with ID {id} was not found.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request URI
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '409':
          description: Unable to unpublish the content item with the ID "{0}" because another user updated the content item since it was last retrieved.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request URI
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        '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'
        '503':
          description: Unable to unpublish the content item in the database as the service is unavailable. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request URI
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                type: object
                description: an error response.
                properties:
                  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 request URI
                  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.
                      required:
                      - code
                      - key
                      - message
                      - description
                      - more_info
                      - category
                      - level
                      - parameters
                      - field
                      - locale
                required:
                - requestId
                - service
                - requestMethod
                - requestUri
                - errors
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
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