OutSystems Analysis Status API

openapi: 3.2.0
info:
  title: Code Quality Analysis Status API
  description: Provides APIs to submit code analysis requests and retrieve information about code quality findings, application scores, and analysis results.
  version: v1
servers:
- url: https://ODC_PORTAL_DOMAIN/api/code-quality/v1
  description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/code-quality/v1
  description: Replace {odc-portal-domain} with the domain of your organization.
  variables:
    odc-portal-domain:
      default: ODC_PORTAL_DOMAIN
      description: The domain of your organization
tags:
- name: Analysis Status
paths:
  /analysis-status:
    get:
      tags:
      - Analysis Status
      summary: Retrieves the current synchronization status of Code Quality data.
      description: 'Retrieves the current synchronization status of Code Quality data, including the latest and last successful analysis details with metrics about new and resolved findings.


        Example: GET /code-quality/v1/analysis-status


        API Client needs the **Analyze > View Code Quality findings** permission.'
      operationId: SyncControllerV_GetAnalysisStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusSyncResponseV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusSyncResponseV1'
      security:
      - bearerAuth: []
      x-os-permissions: API Client needs the **Analyze > View Code Quality findings** permission.
components:
  schemas:
    NextAnalysisV1:
      title: NextAnalysis
      type: object
      properties:
        scheduledOn:
          type: string
          description: The date and time of when the analysis was scheduled to run
          format: date-time
      additionalProperties: false
      description: Represents the next scheduled analysis
    LatestAnalysisV1:
      title: LatestAnalysis
      type: object
      properties:
        startedOn:
          type: string
          description: The date and time of when the analysis started
          format: date-time
        completedOn:
          type: string
          description: The date and time of when the analysis finished
          format: date-time
        status:
          type:
          - string
          - 'null'
          description: The status of the analysis
        newFindingsCount:
          type:
          - integer
          - 'null'
          description: The count of the new findings
          format: int32
        solvedFindingsCount:
          type:
          - integer
          - 'null'
          description: The count of the solved findings
          format: int32
        errorCode:
          type:
          - string
          - 'null'
          description: The error code returned in case the latest analysis has failed status
        errorMessage:
          type:
          - string
          - 'null'
          description: The error message returned in case the latest analysis has failed status
      additionalProperties: false
      description: Represents the latest analysis (may include error information)
    LastSuccessfulAnalysisV1:
      title: LastSuccessfulAnalysis
      type: object
      properties:
        startedOn:
          type: string
          description: The date and time of when the analysis started
          format: date-time
        completedOn:
          type: string
          description: The date and time of when the analysis finished
          format: date-time
        status:
          type:
          - string
          - 'null'
          description: The status of the analysis
        newFindingsCount:
          type:
          - integer
          - 'null'
          description: The count of the new findings
          format: int32
        solvedFindingsCount:
          type:
          - integer
          - 'null'
          description: The count of the solved findings
          format: int32
      additionalProperties: false
      description: Represents the last successful analysis
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: A URI reference that identifies the problem type.
        title:
          type:
          - string
          - 'null'
          description: A short, human-readable summary of the problem.
        status:
          type:
          - integer
          - 'null'
          description: The HTTP status code applicable to the problem.
          format: int32
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation of the error.
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        traceId:
          type: string
          description: This field helps OutSystems support track and investigate specific error occurrences. Providing this identifier when reporting an issue allows for more precise and faster troubleshooting.
        errorCode:
          type: string
          description: This error code serves the purpose to communicate with OutSystems Support and help diagnose errors.
      description: A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
    StatusSyncResponseV1:
      title: StatusAnalysisResponse
      type: object
      properties:
        result:
          title: StatusAnalysisResponseResult
          allOf:
          - $ref: '#/components/schemas/StatusSyncResponseResultV1'
          description: The result of the status sync
      additionalProperties: false
    StatusSyncResponseResultV1:
      title: StatusAnalysisResponseResult
      type: object
      properties:
        lastSuccessfulAnalysis:
          title: LastSuccessfulAnalysis
          allOf:
          - $ref: '#/components/schemas/LastSuccessfulAnalysisV1'
          description: Info about the latest successful analysis
        latestAnalysis:
          title: LatestAnalysis
          allOf:
          - $ref: '#/components/schemas/LatestAnalysisV1'
          description: Info about the latest analysis
        nextAnalysis:
          title: NextAnalysis
          allOf:
          - $ref: '#/components/schemas/NextAnalysisV1'
          description: Info about the next analysis
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      description: Enter your bearer token in the format 'Bearer {token}'
      scheme: bearer
      bearerFormat: JWT