Thomson Reuters Support API

openapi: 3.2.0
info:
  title: ONESOURCE Help and Search Support API
  description: API for querying help and support information related to ONESOURCE products.
  version: 1.0.0
servers:
- url: https://api.onesourcetax.com
  description: ONESOURCE AMER region
- url: https://api.onesourcetax.com
  description: ONESOURCE APAC region
- url: https://api.onesourcetax.com
  description: ONESOURCE EMEA region
tags:
- name: Support
paths:
  /help-support/eap/search:
    post:
      tags:
      - Support
      summary: Search for Help and Support Information
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SearchModel'
          application/json:
            schema:
              $ref: '#/components/schemas/SearchModel'
          text/json:
            schema:
              $ref: '#/components/schemas/SearchModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SearchModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
      security:
      - Bearer: []
      x-tr-jtp-reference:
        $ref: '#/x-tr-jtp/default'
      operationId: postHelpSupportEapSearch
      x-operation-id-source: derived
components:
  schemas:
    SearchResponse:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items: {}
      additionalProperties: false
    SearchModel:
      type: object
      properties:
        q:
          type:
          - string
          - 'null'
          description: 'Field to indicate: The q parameter is a string that represents the query being made. It is used to pass search terms or keywords to the API, allowing it to return relevant results based on the input provided.<br> Default:  (means empty string)<br> Example:<br>  { <br>&nbsp;&nbsp;q: my search term or keywords here,<br> &nbsp;&nbsp;noOfResultsToSee: 20<br> }'
        product:
          type:
          - string
          - 'null'
          description: 'Field to indicate the product(s) to include in the search results.  This is a pre-filter item, and if this string is used, then only the products specifically denoted will be included in search results.   Alternatively, leaving this field blank allows the user to search all TR products for which there is Help & Support content.<br>Example:  Onesource suite of products<br>{ <br>&nbsp;&nbsp;q: Tax, <br>&nbsp;&nbsp;suite: onesource <br>} <br><br>Example: single product (Calendar or ONESOURCE Income Tax): <br>{ <br>&nbsp;&nbsp;product:  Calendar | ONESOURCE Income Tax , <br>&nbsp;&nbsp;q: Tax, <br>&nbsp;&nbsp;noOfResultsToSkip: 0, <br>&nbsp;&nbsp;noOfResultsToSee: 10, <br>} <br><br>List of all products:  <br>-&nbsp;ONESOURCE API Administration <br>-&nbsp;ONESOURCE Calendar <br>-&nbsp;ONESOURCE DataFlow <br>-&nbsp;ONESOURCE Determination <br>-&nbsp;ONESOURCE E-Invoicing <br>-&nbsp;ONESOURCE Income Tax Express RS <br>-&nbsp;ONESOURCE Income Tax <br>-&nbsp;ONESOURCE Indirect Tax Compliance <br>-&nbsp;ONESOURCE Indirect Tax <br>-&nbsp;ONESOURCE Platform <br>-&nbsp;ONESOURCE Sales and Use Tax Compliance <br>-&nbsp;ONESOURCE State Apportionment <br>-&nbsp;ONESOURCE Tax Provision <br>-&nbsp;ONESOURCE Workpapers <br>-&nbsp;onesource-workflow-manager <br>'
        noOfResultsToSkip:
          type: integer
          format: int32
          description: 'Field to pagination. Using the field noOfResultsToSkip means skipping a specified number of results before starting to display the next set of results. This helps in efficiently navigating through large datasets by controlling how many items are shown per page and which items to start from. Default value is: 0 <br>Example: (second page, after getting the first 20) <br>{ <br>&nbsp;&nbsp;q: Tax, <br>&nbsp;&nbsp;noOfResultsToSee: 20, <br>&nbsp;&nbsp;noOfResultsToSkip: 20 <br>}'
        noOfResultsToSee:
          type: integer
          format: int32
          description: 'Field to indicate the number of search results displayed.<br> Default value is: 10 <br>Example (body for the request):  <br>{ <br>&nbsp;&nbsp;q: Tax, <br>&nbsp;&nbsp;noOfResultsToSee: 20 <br>}'
        sortCriteria:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: JWT Authorization header using the Bearer scheme.
      name: Authorization
      in: header
x-tr-jtp:
  default:
    array-element-count: 20
    container-depth: 10
    object-entry-count: 3000
    object-entry-name-length: 50
    string-value-length: 500
x-tr-cors-enabled: false
x-tr-identity-provider: ONESOURCE
x-tr-proxy-name: ONESOURCE-Search
x-tr-api-version: eap
x-tr-asset-insight-id: '206044'
x-tr-apigee-base-path: /help-support/eap/search
x-tr-logging-provider:
- DataDog
x-tr-servers:
  default:
    onesourceZuulServer: false
    basePath: /v2/search/help-and-support
    regions:
    - amer
    - apac
    - emea
    environments:
      uat:
        host: api.thomsonreuters.com
        port: 443
        ssl: true
      trexternal:
        host: api.thomsonreuters.com
        port: 443
        ssl: true
x-tr-deploy-permissions:
- dc-A8bQzXjSn1fRCWeFxc4J1j
x-tr-promote-permissions:
- dc-A8bQzXjSn1fRCWeFxc4J1j
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/56cfeb36-22f1-53c7-9ad3-02bf58385494
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)