openapi: 3.2.0
info:
  version: 1.0.0
  title: DJ Factiva Newsletters Editions API
servers:
- url: https://api.dowjones.com
tags:
- name: Editions
paths:
  /newsletters/{id}/editions:
    get:
      tags:
      - Editions
      summary: Get all Newsletter Editions
      description: Get all newsletter editions
      operationId: EditionsRead
      parameters:
      - name: id
        description: Newsletter ID
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: tkn
        description: Encrypted Newsletter identity
        in: query
        required: false
        schema:
          type: string
      - name: sort
        description: Sort by CreatedDate, LastModified, Name; use '-' for descending
        in: query
        schema:
          type: string
      - name: page[offset]
        description: Starting index into lists
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page[limit]
        description: Max number of editions to return
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parts
        description: Parts to retrieve
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - ExtendedDetails
            - Sections
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/newsletter_editions_list'
        '400':
          description: Bad Request - Incorrect Parameters
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: Internal Server Error - Server encountered an unexpected condition
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/error_response'
        '503':
          $ref: '#/components/schemas/503'
      security:
      - bearerAuth: []
  /newsletters/{id}/editions/{editionId}:
    get:
      tags:
      - Editions
      summary: Get a Newsletter's Edition by ID
      description: Get newsletter edition by id
      operationId: EditionReadById
      parameters:
      - name: id
        description: Newsletter ID
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: editionId
        description: Newsletter's Edition ID
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: tkn
        description: Encrypted Newsletter identity
        in: query
        required: false
        schema:
          type: string
      - name: parts
        description: Parts to retrieve
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - IncludeContent
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/newsletter_editions_item'
        '400':
          description: Bad Request - Incorrect Parameters
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          $ref: '#/components/schemas/404'
        '500':
          description: Internal Server Error - Server encountered an unexpected condition
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/error_response'
        '503':
          $ref: '#/components/schemas/503'
      security:
      - bearerAuth: []
components:
  schemas:
    section:
      type: object
      description: Section
      properties:
        name:
          type: string
          description: Name
        position:
          type: integer
          format: int32
          description: Position
        items:
          type: array
          items:
            type: object
            anyOf:
            - $ref: '#/components/schemas/article_details'
            - $ref: '#/components/schemas/link_details'
            - $ref: '#/components/schemas/rss_details'
            - $ref: '#/components/schemas/chart_details'
          description: Items
        subsections:
          type: array
          items:
            $ref: '#/components/schemas/subsection'
          description: Subsections
        images:
          type: array
          items:
            $ref: '#/components/schemas/image'
          description: Elements
    chart_details:
      type: object
      properties:
        item_id:
          type: number
          example: 12345
          description: Item identity
        item_type:
          type: string
          description: Item Type
          example: Chart
        title:
          type: string
          description: Title
        flag:
          type: string
          enum:
          - Unspecified
          - Hot
          - MustRead
          - New
          description: Flag
        comments:
          type: string
          description: Comments
        description:
          type: string
          description: Description
        chart_image_id:
          type: integer
          format: int64
          description: Chart Image Item ID
        graph_type:
          type: string
          enum:
          - Line
          - Pie
          - HorizontalBar
          - VerticalBar
          - StackedBar
          - Overlay
          - Tagcloud
          description: Graph Type
        date_range:
          $ref: '#/components/schemas/chart_dates'
        position:
          type: integer
          format: int32
          description: Position
          example: 3
        image_url:
          type: string
          description: URL to binary service
      description: Chart Details
    chart_dates:
      type: object
      properties:
        from:
          type: string
          description: Start Date
          example: '1997-07-16'
        to:
          type: string
          description: End Date
          example: '1997-07-16'
      description: Chart Dates
    content_alt_images:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
          name:
            type: string
          width:
            type: number
          height:
            type: number
          size_code:
            type: string
    '503':
      description: Service Unavailable - Server is currently unable to handle the request
    edition_item:
      type: object
      properties:
        name:
          type: string
          description: Name
        parent_workspace_id:
          type: number
          example: 1234
        creation_date:
          type: string
          description: Creation Date
          example: '1997-07-16T19:20:30+00:00'
        last_modified_date:
          type: string
          description: Last Modified Date
          example: '1997-07-16T19:20:30+00:00'
        email_sent_date:
          type: string
          description: Email Sent Date
          example: '1997-07-16T19:20:30+00:00'
        email_job_id:
          type: string
          description: Email Job Id
        document_date:
          type: string
          example: '1997-07-16T19:20:30+00:00'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/section'
          description: Sections
        details:
          type: object
          properties:
            has_snippet_included:
              type: boolean
              description: Include Snippet
            free_text:
              type: string
              description: Free Text
            title:
              type: string
              description: Title
            summary:
              type: string
              description: Description
            has_table_of_contents:
              type: boolean
              description: Show Table of Contents
            has_fulltext_enabled:
              type: boolean
              description: Enable Full Text
            large_masthead:
              type: string
              description: Large Masthead
            small_masthead:
              type: string
              description: Small Masthead
            footer:
              type: string
              description: Small Masthead
            additional_dateline_text:
              type: string
              description: Small Masthead
            image:
              $ref: '#/components/schemas/image'
      description: Edition
    content_item_meta_code_sets_code:
      type: object
      properties:
        code:
          type: string
        code_scheme:
          type: string
        chartingsymbol:
          type: string
        symbol:
          type: string
        significance:
          type: string
        descriptor:
          type: string
    newsletter_editions_list:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/common_id'
              type:
                $ref: '#/components/schemas/newsletter_edition_type'
              attributes:
                $ref: '#/components/schemas/edition_item'
              links:
                $ref: '#/components/schemas/self_editions_link'
        meta:
          $ref: '#/components/schemas/newsletter_list_meta'
        links:
          $ref: '#/components/schemas/list_edition_links'
    list_edition_links:
      type: object
      properties:
        self:
          type: string
          example: https://localhost:8080/assets/newsletters/9876/editions
        first:
          type: string
          example: https://localhost:8080/assets/newsletters/9876/editions/?page[offset]=0&page[limit]=10
        prev:
          type: string
          example: https://localhost:8080/assets/newsletters/9876/editions/?page[offset]=0&page[limit]=10
        next:
          type: string
          example: https://localhost:8080/assets/newsletters/9876/editions/?page[offset]=20&page[limit]=20
        last:
          type: string
          example: https://localhost:8080/assets/newsletters/9876/editions/?page[offset]=40&page[limit]=20
    article_details:
      type: object
      properties:
        item_id:
          type: number
          example: 12345
          description: Item identity
        item_type:
          type: string
          description: Item Type
          example: Article
        drn:
          type: string
          description: DRN
        original_doc_id:
          type: string
          description: Original Document Id (ex. accession_number)
        flag:
          type: string
          enum:
          - Unspecified
          - Hot
          - MustRead
          - New
          description: Flag
        comments:
          type: string
          description: Comments
        content_category:
          type: string
          enum:
          - Unspecified
          - External
          - Publication
          - Website
          - Picture
          - Multimedia
          - Blog
          - Board
          - Internal
          - Summary
          - CustomerDoc
          description: Content Category
        related_article_drn:
          type: string
          description: DRN
        related_article_original_doc_id:
          type: string
          description: Original Document Id (ex. accession_number)
        position:
          type: integer
          format: int32
          description: Position
          example: 0
      description: Article Details
    edition_included:
      type: array
      items:
        $ref: '#/components/schemas/content_item'
    rss_details:
      type: object
      properties:
        item_id:
          type: number
          example: 12345
          description: Item identity
        item_type:
          type: string
          description: Item Type
          example: RSS
        title:
          type: string
          description: Title
        description:
          type: string
          description: Description
        flag:
          type: string
          enum:
          - Unspecified
          - Hot
          - MustRead
          - New
          description: Flag
        comments:
          type: string
          description: Comments
        url:
          type: string
          description: URL
        source_name:
          type: string
          description: Source Name
        author:
          type: string
          description: Author
        publication_date:
          type: string
          description: Publication Date
          example: '1997-07-16'
        language:
          type: string
          description: Language
          example: en
        body:
          type: string
          description: Body
        position:
          type: integer
          format: int32
          description: Position
          example: 2
    image:
      type: object
      properties:
        image_id:
          type: string
          description: Image id
        image_type:
          type: string
          enum:
          - Internal
          - External
          description: Image type
        position:
          type: integer
          format: int32
          description: Position
        drn:
          type: string
          description: DRN
        original_doc_id:
          type: string
          description: Original Document Id (ex. accession_number)
        image_url:
          type: string
          description: URL to binary service
    content_text_base:
      type: object
      properties:
        text:
          type: string
    content:
      type: object
      properties:
        type:
          type: string
        colspan:
          type: number
        display:
          type: string
        paragraph_type:
          type: string
        text:
          type: string
        ordered:
          type: boolean
        alternate_text:
          type: string
        alt_images:
          $ref: '#/components/schemas/content_alt_images'
        caption:
          $ref: '#/components/schemas/content_text_base'
        credit:
          type: string
        media_type:
          type: string
        name:
          type: string
        uri:
          type: string
        slug:
          type: string
        width:
          type: number
        height:
          type: number
        api:
          type: string
        sub_type:
          type: string
        fragment_id:
          type: string
        icon:
          type: string
        link_type:
          type: string
        external:
          type: boolean
        ref:
          type: string
        entity_type:
          type: string
        background_info:
          type: string
        code:
          type: string
        code_scheme:
          type: string
        significance:
          type: string
        ticker:
          type: string
        emphasis_type:
          type: string
    content_body:
      type: array
      items:
        type: object
        properties:
          type:
            type: string
          display:
            type: string
          paragraph_type:
            type: string
          text:
            type: string
          content:
            $ref: '#/components/schemas/content_list'
          sub_type:
            type: string
          fragment_id:
            type: string
          alternate_text:
            type: string
          alt_images:
            $ref: '#/components/schemas/content_alt_images'
          caption:
            $ref: '#/components/schemas/content_text_base'
          credit:
            type: string
          media_type:
            type: string
          name:
            type: string
          uri:
            type: string
          slug:
            type: string
          width:
            type: number
          height:
            type: number
          format:
            type: string
          inset_type:
            type: string
          ref:
            type: string
          ordered:
            type: boolean
          content_encoding:
            type: string
          value:
            type: string
    edition_relationships:
      type: object
      properties:
        content:
          type: object
          properties:
            links:
              type: object
              properties:
                related:
                  type: string
            data:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    example: content
                  id:
                    type: string
    self_editions_link:
      type: object
      properties:
        self:
          type: string
          description: link to this single resourceType (self)
          example: https://localhost:8080/assets/newsletters/9876/editions/1234
    subsection:
      type: object
      description: Section
      properties:
        name:
          type: string
          description: Name
        position:
          type: integer
          format: int32
          description: Position
        items:
          type: array
          items:
            type: object
            anyOf:
            - $ref: '#/components/schemas/article_details'
            - $ref: '#/components/schemas/link_details'
            - $ref: '#/components/schemas/rss_details'
            - $ref: '#/components/schemas/chart_details'
          description: Items
        images:
          type: array
          items:
            $ref: '#/components/schemas/image'
          description: Elements
    content_item_attribute:
      type: object
      properties:
        content_type:
          type: string
          example: Article
        art:
          $ref: '#/components/schemas/content_text_base'
        associations:
          type: object
          properties:
            root_id:
              type: string
            parent_id:
              type: string
            parent_id_ref:
              type: string
        authors:
          type: array
          items:
            type: object
            properties:
              full_name:
                type: string
              topic_id:
                type: string
        best_date:
          type: string
        best_time:
          type: string
        body:
          $ref: '#/components/schemas/content_body'
        byline:
          $ref: '#/components/schemas/content_text_base'
        column_name:
          type: string
        contact:
          $ref: '#/components/schemas/content_text_base'
        content_status:
          type: string
        copyright:
          $ref: '#/components/schemas/content_text_base'
        corrections:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
              content:
                $ref: '#/components/schemas/content_list'
        credit:
          $ref: '#/components/schemas/content_text_base'
        headline:
          $ref: '#/components/schemas/content_headline'
        live_date:
          type: string
        live_time:
          type: string
        load_date:
          type: string
        load_time:
          type: string
        modification_date:
          type: string
        modification_time:
          type: string
        notes:
          $ref: '#/components/schemas/content_text_base'
        page:
          type: string
        publication_date:
          type: string
        publication_time:
          type: string
        publisher:
          type: object
          properties:
            code:
              type: string
            name:
              type: string
            group_code:
              type: string
            group_name:
              type: string
        section_name:
          $ref: '#/components/schemas/content_text_base'
        seo_id:
          type: string
        snippet:
          type: object
          properties:
            content:
              type: array
              items:
                $ref: '#/components/schemas/content_text_base'
        summary:
          type: object
          properties:
            destination_type:
              type: string
            byline:
              $ref: '#/components/schemas/content_text_base'
            headline:
              $ref: '#/components/schemas/content_headline'
            body:
              $ref: '#/components/schemas/content_body'
            pages:
              type: array
              items:
                type: string
            related_links:
              type: array
              items:
                type: object
                properties:
                  text:
                    type: string
                  content:
                    $ref: '#/components/schemas/content_list'
            variant:
              type: string
        upstream_origin:
          type: string
        upstream_origin_id:
          type: string
        volume:
          type: string
        bytes:
          type: number
        external:
          type: boolean
        height:
          type: number
        width:
          type: number
        id_ref:
          type: string
        size_code:
          type: string
        is_responsive:
          type: boolean
        mime_type:
          type: string
        slug:
          type: string
        sub_type:
          type: string
    link_details:
      type: object
      properties:
        item_id:
          type: number
          example: 12345
          description: Item identity
        item_type:
          type: string
          description: Item Type
          example: Link
        title:
          type: string
          description: Title
        description:
          type: string
          description: Description
        flag:
          type: string
          enum:
          - Unspecified
          - Hot
          - MustRead
          - New
          description: Flag
        comments:
          type: string
          description: Comments
        url:
          type: string
          description: URL
        source_name:
          type: string
          description: Source Name
        author:
          type: string
          description: Author
        publication_date:
          type: string
          description: Publication Date
          example: '1997-07-16'
        language:
          type: string
          description: Language
          example: en
        body:
          type: string
          description: Body
        position:
          type: integer
          format: int32
          description: Position
          example: 1
        type:
          type: string
          enum:
          - Url
          - DocUrl
          - RssHeadlineUrl
    newsletter_edition_type:
      type: string
      description: Resource type
      example: editions
    common_id:
      type: string
      example: '1234'
    links:
      type: object
      properties:
        self:
          type: string
    '404':
      description: Newsletter Not Found
    content_item_meta_code_sets:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
          type:
            type: string
          codes:
            type: array
            items:
              $ref: '#/components/schemas/content_item_meta_code_sets_code'
    error_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
    content_list:
      type: array
      items:
        $ref: '#/components/schemas/content'
    newsletter_editions_item:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/common_id'
            type:
              $ref: '#/components/schemas/newsletter_edition_type'
            attributes:
              $ref: '#/components/schemas/edition_item'
            relationships:
              $ref: '#/components/schemas/edition_relationships'
        included:
          $ref: '#/components/schemas/edition_included'
        links:
          $ref: '#/components/schemas/self_editions_link'
    content_item_meta:
      type: object
      properties:
        alternate_document_id:
          type: string
        alternate_document_ref:
          type: string
        count:
          type: number
        context:
          type: string
        code_sets:
          $ref: '#/components/schemas/content_item_meta_code_sets'
        edition:
          type: object
          properties:
            name:
              type: string
            print:
              type: object
              properties:
                value:
                  type: string
                page:
                  type: string
                headlline:
                  type: string
                section:
                  type: string
                date:
                  type: string
        emphasis:
          type: object
          properties:
            hot:
              type: boolean
            dominant:
              type: boolean
            analysis:
              type: boolean
        geo_relevance:
          type: array
          items:
            type: object
            properties:
              latitude:
                type: number
              longitude:
                type: number
        is_translation_allowed:
          type: boolean
        keywords:
          type: array
          items:
            type: string
        language:
          type: object
          properties:
            code:
              type: string
              example: en
            descriptor:
              type: string
        metrics:
          type: object
          properties:
            character_count:
              type: number
              example: 1024
            word_count:
              type: number
              example: 256
            image_count:
              type: number
              example: 4
            chart_count:
              type: number
              example: 2
        original_doc_id:
          type: string
        source:
          type: object
          properties:
            code:
              type: string
            name:
              type: string
            logo:
              type: object
              properties:
                alternate_text:
                  type: string
                alt_images:
                  $ref: '#/components/schemas/content_alt_images'
                caption:
                  $ref: '#/components/schemas/content_text_base'
                credit:
                  type: string
                media_type:
                  type: string
                name:
                  type: string
                uri:
                  type: string
                slug:
                  type: string
                width:
                  type: number
                height:
                  type: number
                type:
                  type: string
        bill_data:
          type: string
    newsletter_list_meta:
      type: object
      properties:
        count:
          description: Count
          type: integer
          format: int32
        total_count:
          description: Total Count
          type: integer
          format: int32
        total_pages:
          description: Total Pages Count
          type: integer
          format: int32
        paging:
          type: object
          properties:
            offset:
              type: object
              properties:
                first:
                  type: integer
                  format: int32
                prev:
                  type: integer
                  format: int32
                next:
                  type: integer
                  format: int32
                last:
                  type: integer
                  format: int32
                current:
                  type: integer
                  format: int32
    error:
      type: object
      required:
      - code
      - title
      - status
      properties:
        code:
          type: string
          description: Error code
        title:
          type: string
          description: error class summary message
        status:
          type: integer
          format: int32
          description: HTTP status code
        detail:
          type: string
          description: error detail about this instance of error
        meta:
          type: string
          description: Meta object
    content_headline:
      type: object
      properties:
        flashline:
          $ref: '#/components/schemas/content_text_base'
        main:
          $ref: '#/components/schemas/content_text_base'
        deck:
          $ref: '#/components/schemas/content_text_base'
    content_item:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          example: content
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/content_item_meta'
        attributes:
          $ref: '#/components/schemas/content_item_attribute'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT