PagoPA Massive operation observability APIs - v1 API

openapi: 3.2.0
info:
  title: Pagopa Massive operation observability APIs - v1 API
  version: 0.5.3
  termsOfService: https://www.pagopa.gov.it/
  description: 'Operations tagged Massive operation observability APIs - v1 across 2 of this provider''s published API definitions: gpd_massive.json, pagopa-gpd-massive-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.platform.pagopa.it/upload/gpd/debt-positions-service/v1
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Massive operation observability APIs - v1
paths:
  /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{upload-id}/status:
    get:
      tags:
      - Massive operation observability APIs - v1
      summary: Returns the debt positions upload status
      description: Returns the debt positions upload status.
      operationId: get-debt-positions-upload-status
      parameters:
      - name: broker-code
        in: path
        description: The broker code
        required: true
        schema:
          minLength: 1
          type: string
      - name: organization-fiscal-code
        in: path
        description: The organization fiscal code
        required: true
        schema:
          minLength: 1
          type: string
      - name: upload-id
        in: path
        description: The unique identifier for file upload
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '200':
          description: Upload found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadStatus'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '401':
          description: Wrong or missing function key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Upload not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '429':
          description: Too many requests.
          content:
            text/json: {}
        '500':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
    servers:
    - url: https://api.platform.pagopa.it/upload/gpd/debt-positions-service/v1
  /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/file/{file-id}/report:
    get:
      tags:
      - Massive operation observability APIs - v1
      summary: Returns the debt positions upload report
      description: Returns the debt positions upload report.
      operationId: get-debt-positions-upload-report
      parameters:
      - name: broker-code
        in: path
        description: The broker code
        required: true
        schema:
          minLength: 1
          type: string
      - name: organization-fiscal-code
        in: path
        description: The organization fiscal code
        required: true
        schema:
          minLength: 1
          type: string
      - name: file-id
        in: path
        description: The unique identifier for file upload
        required: true
        schema:
          minLength: 1
          type: string
      responses:
        '200':
          description: Upload report found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadReport'
              example:
                uploadID: string
                processedItem: 0
                submittedItem: 0
                responses:
                - statusCode: 400
                  statusMessage: Bad request caused by invalid email address
                  requestIDs:
                  - string
                startTime: '2024-10-08T02:55:16.0000000+00:00'
                endTime: '2024-10-08T02:55:16.0000000+00:00'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '401':
          description: Wrong or missing function key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Upload report not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '429':
          description: Too many requests.
          content:
            text/json: {}
        '500':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
    servers:
    - url: https://api.platform.pagopa.it/upload/gpd/debt-positions-service/v1
  /brokers/{broker-code}/organizations/{organization-fiscal-code}/debtpositions/files:
    get:
      tags:
      - Massive operation observability APIs - v1
      summary: Returns the list of fileIds for a broker/organization in the given date range…
      description: Returns the list of fileIds for a broker/organization in the given date range (max 7 days).
      operationId: get-debt-positions-fileids
      parameters:
      - name: broker-code
        in: path
        description: The broker code
        required: true
        schema:
          minLength: 1
          type: string
      - name: organization-fiscal-code
        in: path
        description: The organization fiscal code
        required: true
        schema:
          minLength: 1
          type: string
      - name: from
        in: query
        description: Start date (YYYY-MM-DD), Europe/Rome
        schema:
          type: string
        example: '2025-09-01'
      - name: to
        in: query
        description: End date (YYYY-MM-DD), Europe/Rome
        schema:
          type: string
        example: '2025-09-06'
      - name: size
        in: query
        description: Max items per page (default 100, min 100, max 500)
        schema:
          type: integer
          format: int32
          default: 100
      - name: x-continuation-token
        in: header
        description: Continuation token (opaque). Pass it back to get the next page.
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: FileIds retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileIdListResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '401':
          description: Wrong or missing function key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
        '429':
          description: Too many requests.
          content:
            text/json: {}
        '500':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
              example:
                title: string
                status: 400
                detail: There was an error processing the request
    servers:
    - url: https://api.platform.pagopa.it/upload/gpd/debt-positions-service/v1
components:
  schemas:
    ResponseEntry:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
          example: 400
        statusMessage:
          type: string
          example: Bad request caused by invalid email address
        requestIDs:
          type: array
          items:
            type: string
    UploadStatus:
      type: object
    ProblemJson:
      type: object
      properties:
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable'
        status:
          type: integer
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          format: int32
          example: 400
        detail:
          type: string
          description: A human readable explanation specific to this occurrence of the problem.
          example: There was an error processing the request
      description: Object returned as response in case of an error.
    FileIdListResponse:
      type: object
    UploadReport:
      type: object
      properties:
        uploadID:
          type: string
        processedItem:
          type: integer
          format: int32
        submittedItem:
          type: integer
          format: int32
        responses:
          type: array
          items:
            $ref: '#/components/schemas/ResponseEntry'
        startTime:
          type: string
          format: date-time
          example: '2024-10-08T02:55:16.0000000+00:00'
        endTime:
          type: string
          format: date-time
          example: '2024-10-08T02:55:16.0000000+00:00'
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
x-refined-from:
- gpd_massive.json
- pagopa-gpd-massive-v1-openapi.yml