Clarivate Feed API

openapi: 3.2.0
info:
  title: RIC Feed API
  version: 0.2.649dde3-18
servers:
- url: https://api.clarivate.com
security:
- key: []
tags:
- name: Feed
paths:
  /ric/download/v1/requestPackage:
    post:
      tags:
      - Feed
      summary: Request Package
      description: Start package preparation
      operationId: request_package_ric_download_v1_requestPackage_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPackageInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestPackageResult'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Authorization Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /ric/download/v1/checkPackageStatus:
    get:
      tags:
      - Feed
      summary: Check Package Status
      description: Check package status
      operationId: check_package_status_ric_download_v1_checkPackageStatus_get
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
          description: Unique identifier in uuid4 format representing a data feed package that has been requested.
          title: Token
        description: Unique identifier in uuid4 format representing a data feed package that has been requested.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckPackageStatusResult'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Authorization Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /ric/download/v1/downloadPackage:
    get:
      tags:
      - Feed
      summary: Download Package
      description: Download result package
      operationId: download_package_ric_download_v1_downloadPackage_get
      parameters:
      - name: token
        in: query
        required: true
        schema:
          type: string
          description: Unique identifier in uuid4 format representing a generated file.
          title: Token
        description: Unique identifier in uuid4 format representing a generated file.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Authorization Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /ric/download/v1/info:
    get:
      tags:
      - Feed
      summary: Get Subscriptions Info
      description: Get content subscriptions information
      operationId: get_subscriptions_info_ric_download_v1_info_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsInfoResult'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Authorization Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Format:
      type: string
      enum:
      - json
      - parquet
      title: Format
    Filter:
      properties:
        field:
          type: string
          title: Field
          description: Name of the filter. Only "internalChangeNumber" is currently supported.
        op:
          allOf:
          - $ref: '#/components/schemas/OperationEnum'
          description: Filter's operator. Possible values are 'gt' (greater than), 'lt' (lower than).
        value:
          title: Value
          description: Filter's value corresponding to the maxInternalChangeNumber field value returned from a previous call by the checkPackageStatus endpoint.
      additionalProperties: false
      type: object
      required:
      - field
      - op
      - value
      title: Filter
    RequestPackageInput:
      properties:
        requestId:
          anyOf:
          - type: string
            maxLength: 40
            minLength: 1
          - type: 'null'
          title: Requestid
          description: Request Id
        contentSet:
          type: string
          title: Contentset
          description: Name of the subscribed content set/data set.
        preset:
          type: string
          title: Preset
          description: Name of the preset (E.g., Standard, Full, or the name of the custom dataset).
        format:
          allOf:
          - $ref: '#/components/schemas/Format'
          description: File output format (E.g., JSON, parquet). Default value is JSON.
          default: json
        splitFiles:
          type: boolean
          title: Splitfiles
          description: true or false (default). Return big files in chunks of 1GB each.
          default: false
        filters:
          anyOf:
          - $ref: '#/components/schemas/FilterGroup'
          - type: 'null'
          description: List of filtering options that can be passed
      additionalProperties: false
      type: object
      required:
      - contentSet
      - preset
      title: RequestPackageInput
    RequestPackageResult:
      properties:
        token:
          type: string
          format: uuid4
          title: Token
          description: Unique identifier in uuid4 format representing a data feed package that has been requested.
      type: object
      required:
      - token
      title: RequestPackageResult
    ErrorResponse:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/Error'
          type: array
          title: Errors
      type: object
      required:
      - errors
      title: ErrorResponse
      description: 'Customize Validation Error

        https://github.com/tiangolo/fastapi/issues/1376'
    CheckPackageStatusResult:
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          description: 'Status of the package preparation.values can be: pending, running, done-no-match or done.'
        dateCompleted:
          anyOf:
          - type: string
          - type: 'null'
          title: Datecompleted
          description: Date-time the package preparation completed.
        maxInternalChangeNumber:
          anyOf:
          - items:
              $ref: '#/components/schemas/MaxInternalChangeNumber'
            type: array
          - type: 'null'
          title: Maxinternalchangenumber
          description: Maximal value of the internal Change Number field.
        files:
          items:
            $ref: '#/components/schemas/CheckPackageStatusResultFile'
          type: array
          title: Files
          description: List of files that can be downloaded.
      type: object
      required:
      - status
      - dateCompleted
      - maxInternalChangeNumber
      - files
      title: CheckPackageStatusResult
    ConjunctionEnum:
      type: string
      enum:
      - OR
      - AND
      title: ConjunctionEnum
    FileTypeEnum:
      type: string
      enum:
      - json
      - parquet
      - resources
      - schema
      title: FileTypeEnum
    StatusEnum:
      type: string
      enum:
      - pending
      - running
      - done
      - failed
      - outdated
      - done-no-match
      title: StatusEnum
    ContentSubscriptionResponse:
      properties:
        name:
          type: string
          title: Name
          description: Name of the subscribed dataset
        contentSet:
          type: string
          title: Contentset
          description: Name of the content set parameter to be passed in the API calls
        preset:
          type: string
          title: Preset
          description: Name of the preset parameter to be passed in the API calls
        description:
          type: string
          title: Description
          description: 'Description of the subscribed dataset '
      type: object
      required:
      - name
      - contentSet
      - preset
      - description
      title: ContentSubscriptionResponse
    SubscriptionsInfoResult:
      properties:
        subscriptions:
          items:
            $ref: '#/components/schemas/ContentSubscriptionResponse'
          type: array
          title: Subscriptions
          description: List of subscribed datasets
      type: object
      required:
      - subscriptions
      title: SubscriptionsInfoResult
    OperationEnum:
      type: string
      enum:
      - eq
      - lt
      - gt
      - le
      - ge
      - ne
      - in
      - is
      - like
      - any of
      - not in
      - is not
      - not like
      title: OperationEnum
    MaxInternalChangeNumber:
      properties:
        contentSet:
          type: string
          title: Contentset
          description: Content set/data set name (value could be "custom").
        preset:
          type: string
          title: Preset
          description: Preset of the dataset (E.g., Standard, Full, or the name of the custom dataset).
        value:
          type: integer
          title: Value
          description: Maximal Internal Change Number value.
      type: object
      required:
      - contentSet
      - preset
      - value
      title: MaxInternalChangeNumber
    CheckPackageStatusResultFile:
      properties:
        token:
          type: string
          format: uuid4
          title: Token
          description: Unique identifier in uuid4 format representing a generated file.
        tokenUsed:
          type: boolean
          title: Tokenused
          description: Flag which shows if the file has been downloaded already at least once.
        fileName:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: File name.
        fileType:
          anyOf:
          - $ref: '#/components/schemas/FileTypeEnum'
          - type: 'null'
          description: File output format (E.g., JSON, parquet).
        fileSize:
          anyOf:
          - type: string
          - type: 'null'
          title: Filesize
          description: Size of the file in Kilo Bytes.
        checksumName:
          anyOf:
          - type: string
          - type: 'null'
          title: Checksumname
          description: Checksum name.
        checksum:
          anyOf:
          - type: string
          - type: 'null'
          title: Checksum
          description: Checksum.
        numberOfRecords:
          anyOf:
          - type: integer
          - type: 'null'
          title: Numberofrecords
          description: Number of records.
      type: object
      required:
      - token
      - tokenUsed
      - fileName
      - fileType
      - fileSize
      - checksumName
      - checksum
      - numberOfRecords
      title: CheckPackageStatusResultFile
    Error:
      properties:
        code:
          type: integer
          title: Code
        message:
          type: string
          title: Message
        location:
          anyOf:
          - items:
              anyOf:
              - type: string
              - type: integer
            type: array
          - type: 'null'
          title: Location
      type: object
      required:
      - code
      - message
      title: Error
    FilterGroup:
      items:
        anyOf:
        - $ref: '#/components/schemas/Filter'
        - $ref: '#/components/schemas/ConjunctionEnum'
        - $ref: '#/components/schemas/FilterGroup'
      type: array
      minLength: 0
      title: FilterGroup
  securitySchemes:
    key:
      type: apiKey
      in: header
      name: X-ApiKey