openapi: 3.2.0
info:
  title: Fenergo Journey Summary API
  version: '1.0'
  description: 'Operations tagged JourneySummary across 2 of this provider''s published API definitions: fenergo-businessmetricscommand-v1-0-0-openapi.json, fenergo-businessmetricsquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /businessmetricscommand
- url: /businessmetricsquery
security:
- Bearer: []
tags:
- name: JourneySummary
paths:
  /api/journeysummary:
    post:
      tags:
      - JourneySummary
      summary: Create a Journey Summary
      description: Creates a Journey Summary for a given list of Journey IDs
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Create Journey Summary request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse'
        '202':
          description: Success. Journey Summary request was accepted
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      operationId: postApiJourneysummary
      x-operation-id-source: derived
    servers:
    - url: /businessmetricscommand
  /api/journeysummary/triggerscheduledsummaries:
    post:
      tags:
      - JourneySummary
      summary: Trigger the creation of a Journey Summary for all currently scheduled journeys
      description: A Journey Summary will be created for all currently scheduled journeys on the tenant
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      responses:
        '202':
          description: Success. Trigger scheduled summaries request was accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      operationId: postApiJourneysummaryTriggerscheduledsummaries
      x-operation-id-source: derived
    servers:
    - url: /businessmetricscommand
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    TriggerJourneySummaryRequestDto:
      type: object
      properties:
        journeyIds:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    TriggerJourneySummaryResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/TriggerJourneySummaryResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    TriggerJourneySummaryResponseDto:
      type: object
      properties:
        correlationId:
          type:
          - string
          - 'null'
        journeyIds:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    TriggerJourneySummaryRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/TriggerJourneySummaryRequestDto'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    JourneySummaryRequestDto:
      type: object
      properties:
        journeyIds:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    JourneySummaryRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/JourneySummaryRequestDto'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-businessmetricscommand-v1-0-0-openapi.json
- fenergo-businessmetricsquery-v1-0-openapi.json