openapi: 3.0.1
info:
  title: Reports API
  version: v1
servers:
- url: https://api-emea.onesourcetax.com/corporate-tax/v1/reports
- url: https://api-apac.onesourcetax.com/corporate-tax/v1/reports
paths:
  /definitions:
    get:
      tags:
      - Reports
      summary: This endpoint is used to fetch the list of all Reports (Both Standard
        and Custom).
      operationId: Reports_GetReports
      parameters:
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse'
  /definitions/{id}:
    get:
      tags:
      - Reports
      summary: This endpoint fetches the input parameters required to run a specific
        Report and also lists output fields.
      operationId: Reports_GetReportMetdata
      parameters:
      - name: id
        in: path
        description: Report-definition-header id
        required: true
        schema:
          type: integer
          format: int32
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata'
  /:
    post:
      tags:
      - Reports
      summary: "This endpoint is used to Queue reports for execution, based on the\
        \ input parameters and to fetch the matching data."
      operationId: Reports_GetData
      parameters:
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput'
          text/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput'
          text/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput'
        required: true
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
      x-codegen-request-body-name: input
  /operations/{id}:
    get:
      tags:
      - Reports
      summary: This endpoint is used to fetch the status of the report basing on the
        input parameters from the Queue reports API.
      operationId: Reports_GetOperationStatusFromCache
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse'
        "404":
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
  /{id}:
    get:
      tags:
      - Reports
      summary: This endpoint is used to fetch the data basing on the input parameters
        from the Queue reports API.
      operationId: Reports_GetDataFromCache
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput'
        "404":
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/System.Web.Http.Results.NotFoundResult'
components:
  schemas:
    TRTA.Athena.Models.Api.V4.Reports.ReportListResponse:
      type: object
      properties:
        items:
          type: array
          description: Reports
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.Report'
    TRTA.Athena.Models.Api.V4.Reports.Report:
      type: object
      properties:
        id:
          type: integer
          description: Report id value
          format: int32
        name:
          type: string
          description: Name of report
        description:
          type: string
          description: Detailed description of report
    TRTA.Athena.Models.Api.V4.Reports.ReportMetadata:
      type: object
      properties:
        id:
          type: integer
          description: Report Id
          format: int32
        name:
          type: string
          description: Report name
        parameters:
          type: array
          description: Input Parameters
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameter'
        resultFields:
          type: array
          description: Result columns
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportField'
    TRTA.Athena.Models.Api.V4.Reports.ReportParameter:
      type: object
      properties:
        name:
          type: string
          description: Name of parameter
        description:
          type: string
          description: Detailed description of parameter
        dataType:
          type: string
          description: "Datatype of parameter(ex: string, date)"
        format:
          type: string
          description: "Format of value (ex: for date it is yyyy-mm-dd)"
        acceptMultiple:
          type: boolean
          description: Indicate that value of parameter accepts multiple values to
            be passed together.
    TRTA.Athena.Models.Api.V4.Reports.ReportField:
      type: object
      properties:
        Name:
          type: string
          description: Name of the column
        Caption:
          type: string
          description: Display property of the column
        DataType:
          type: string
          description: Datatype of the column
    TRTA.Athena.Models.Api.V4.Reports.ReportInput:
      type: object
      properties:
        id:
          type: integer
          description: Report-definition id
          format: int32
        parameters:
          type: array
          description: Report parameter
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput'
    TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput:
      type: object
      properties:
        name:
          type: string
          description: Name of parameter
        value:
          type: string
          description: Value of parameter
    TRTA.Athena.Models.Api.V4.Reports.ReportOutput:
      type: object
      properties:
        id:
          type: integer
          description: Report Id
          format: int32
        name:
          type: string
          description: Report Name
        runId:
          type: string
          description: Runid of report.
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        parameters:
          type: array
          description: Parameter supplied as input for the report
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput'
        status:
          type: string
          description: Status of report (In-Progress/Ready/Invalid)
        items:
          type: array
          description: "Report data, It will only have data when status is Ready."
          items:
            type: object
            additionalProperties:
              type: string
        count:
          type: integer
          format: int32
    TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse:
      type: object
      properties:
        status:
          type: string
        resourceLocation:
          type: string
        count:
          type: integer
          format: int32
    System.Web.Http.Results.NotFoundResult:
      type: object
      properties:
        Request:
          type: object
          properties: {}
          readOnly: true
x-original-swagger-version: "2.0"