openapi: 3.2.0
info:
  title: Fenergo Journey Launch Controls API
  version: '1.0'
  description: 'Operations tagged JourneyLaunchControls across 2 of this provider''s published API definitions: fenergo-journeycommand-v1-0-openapi.json, fenergo-journeyquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /journeycommand
- url: /journeyquery
security:
- Bearer: []
tags:
- name: JourneyLaunchControls
paths:
  /api/journey-launch-controls:
    post:
      tags:
      - JourneyLaunchControls
      summary: Create Journey Launch Controls
      description: 'Creates a new journey launch controls definition.


        Required permissions:

        Following permissions are required: JourneyLaunchControlsEdit'
      operationId: CreateJourneyLaunchControls
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateJourneyLaunchControlsDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Journey Launch Controls created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateJourneyLaunchControlsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
    put:
      tags:
      - JourneyLaunchControls
      summary: Update Journey Launch Controls
      description: 'Updates a new journey launch controls definition.


        Required permissions:

        Following permissions are required: JourneyLaunchControlsEdit'
      operationId: UpdateJourneyLaunchControls
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateJourneyLaunchControlsDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Journey Launch Controls updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateJourneyLaunchControlsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
        '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
    get:
      tags:
      - JourneyLaunchControls
      summary: Get All Journey Launch Controls
      description: 'Returns a new journey launch controls definition.


        Required permissions:

        Following permissions are required: JourneyLaunchControlsAccess'
      operationId: GetJourneyLaunchControls
      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
      responses:
        '200':
          description: Success. List of Journey Launch Controls returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyLaunchControlsListDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
    servers:
    - url: /journeycommand
  /api/journey-launch-controls/{journeyLaunchControlsId}:
    delete:
      tags:
      - JourneyLaunchControls
      summary: Delete Journey Launch Controls
      description: 'Deletes the selected version of an existing Journey Launch Controls.


        Required permissions:

        Following permissions are required: JourneyLaunchControlsDelete'
      operationId: DeleteJourneyLaunchControls
      parameters:
      - name: journeyLaunchControlsId
        in: path
        description: Journey Launch Controls Id
        required: true
        schema:
          type: string
          format: uuid
      - 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. Journey Launch Controls deleted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Journey Launch Controls with given id does not exist
                  type: Error
                  errorCode: Error Code
        '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
    servers:
    - url: /journeycommand
  /api/journey-launch-controls/{id}:
    get:
      tags:
      - JourneyLaunchControls
      summary: Get Journey Launch Controls by Id
      description: 'Returns a new journey launch controls definition.


        Required permissions:

        Following permissions are required: JourneyLaunchControlsAccess'
      operationId: GetJourneyLaunchControlsById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: Success. Journey Launch Controls returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyLaunchControlsDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
    servers:
    - url: /journeyquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    CreateJourneyLaunchControlsDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateJourneyLaunchControlsDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    ValueField:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          description: Value of DataSource used to filter field values
        field:
          type:
          - string
          - 'null'
          description: Field value used to validate conditional value
      additionalProperties: false
    ConditionDefinitionDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Name of the field to evaluate
          example: EntityType
        value:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of values
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of value ids
        valueType:
          type:
          - string
          - 'null'
          description: Type of the value
          example: text
        dataSource:
          type:
          - string
          - 'null'
          description: Data source from which field is retrieved. If empty then Entity Data properties will be used.
          example: entityDataMetadata
        operation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed to match the values
          example: equal
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed on the operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
        valueField:
          allOf:
          - $ref: '#/components/schemas/ValueField'
          description: Field value used for conditional limit validation
      additionalProperties: false
      description: Represents condition
    CreateJourneyLaunchControlsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateJourneyLaunchControlsResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    CreateJourneyLaunchControlsResponseDto:
      type: object
      properties:
        createJourneyLaunchControls:
          allOf:
          - $ref: '#/components/schemas/CreateJourneyLaunchControlsDto'
          description: Created Journey Launch Controls
      additionalProperties: false
    UpdateJourneyLaunchControlsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateJourneyLaunchControlsResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    UpdateJourneyLaunchControlsDto:
      required:
      - conditions
      type: object
      properties:
        id:
          type: string
          description: The UiD of the journey launch controls
          format: uuid
        description:
          type:
          - string
          - 'null'
          description: The journey description for journey launch controls
        conditions:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Logic engine conditions for journey launch controls
      additionalProperties: false
      description: Request DTO representing journey launch controls data
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    CreateJourneyLaunchControlsDto:
      required:
      - conditions
      - journeyType
      type: object
      properties:
        id:
          type: string
          description: The UiD of the journey launch controls
          format: uuid
        journeyType:
          type: string
          description: Journey Type for the journey launch controls
        description:
          type:
          - string
          - 'null'
          description: The journey description for journey launch controls
        conditions:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Logic engine conditions for journey launch controls
      additionalProperties: false
      description: Request DTO representing journey launch controls data
    ConditionDto:
      required:
      - logicalOperation
      - name
      - operands
      type: object
      properties:
        id:
          type: string
          description: The ID of the condition
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          minLength: 1
          type: string
          description: The name of the condition
          example: Company-type only
        description:
          type:
          - string
          - 'null'
          description: The description of the condition
          example: Applicable only when EntityType=Company
        logicalOperation:
          minLength: 1
          type: string
          description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
          example: AND
        operands:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
      additionalProperties: false
      description: Represents condition root
      example:
        id: 118313c6-91e6-4b05-a537-5a1ab906418f
        name: Company-type only
        description: Applicable only when EntityType=Company
        logicalOperation: AND
        operands:
        - fieldName: EntityType
          value:
          - string
          valueType: text
          operation: equal
          operands: []
    UpdateJourneyLaunchControlsResponseDto:
      type: object
      properties:
        journeyLaunchControls:
          allOf:
          - $ref: '#/components/schemas/UpdateJourneyLaunchControlsDto'
          description: Updated Journey Launch Controls
      additionalProperties: false
    UpdateJourneyLaunchControlsDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateJourneyLaunchControlsDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    JourneyLaunchControlsDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/JourneyLaunchControlsDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    JourneyLaunchControlsDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the journey launch controls
          format: uuid
        journeyType:
          type:
          - string
          - 'null'
          description: The journey type for journey launch controls
        description:
          type:
          - string
          - 'null'
          description: The journey description for journey launch controls
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto_2'
          description: Logic engine conditions for journey launch controls
      additionalProperties: false
      description: Response DTO representing journey launch controls data
    JourneyLaunchControlsListDto:
      type: object
      properties:
        journeyLaunchControls:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JourneyLaunchControlsDto'
          description: List of Journey Launch Controls
      additionalProperties: false
      description: Response DTO representing list of journey launch controls data
    ConditionDto_2:
      type: object
      properties:
        id:
          type: string
          description: The ID of the condition
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          type:
          - string
          - 'null'
          description: The name of the condition
          example: Company-type only
        description:
          type:
          - string
          - 'null'
          description: The description of the condition
          example: Applicable only when EntityType=Company
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
      additionalProperties: false
      description: Represents condition root
    JourneyLaunchControlsListDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/JourneyLaunchControlsListDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-journeycommand-v1-0-openapi.json
- fenergo-journeyquery-v1-0-openapi.json