Fenergo Evaluate Review Dates Task State API

openapi: 3.2.0
info:
  title: Fenergo Evaluate Review Dates Task State API
  version: '1.0'
  description: 'Operations tagged EvaluateReviewDatesTaskState across 2 of this provider''s published API definitions: fenergo-reviewcommand-v1-0-openapi.json, fenergo-reviewquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /reviewcommand
- url: /reviewquery
security:
- Bearer: []
tags:
- name: EvaluateReviewDatesTaskState
paths:
  /api/evaluate-review-dates-task-state:
    post:
      tags:
      - EvaluateReviewDatesTaskState
      summary: Creates state for a EvaluateReviewDates task
      description: 'This method creates state for a EvaluateReviewDates task.


        The method returns the state of the EvaluateReviewDates task'
      operationId: CreateTaskState
      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
      requestBody:
        description: The state of the EvaluateReviewDates task
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDtoServiceRequest'
      responses:
        '202':
          description: An instance of the Fenergo.Nebula.Review.Common.Dto.EvaluateReviewDatesTaskStateDto class
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: /reviewcommand
  /api/evaluate-review-dates-task-state/{entityId}/{journeyId}/{taskId}:
    put:
      tags:
      - EvaluateReviewDatesTaskState
      summary: Update state for a EvaluateReviewDates task
      description: Updates the existing state for a EvaluateReviewDates task.
      operationId: UpdateTaskState
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task 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
      requestBody:
        description: The state of the EvaluateReviewDates task
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateStateForEvaluateReviewDatesTaskRequestServiceRequest'
      responses:
        '202':
          description: Success. Task state updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDtoServiceResponse'
        '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. Review with given id does not exist
                  type: Error
                  errorCode: Error Code
        '409':
          description: Conflict saving changes in expected version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes
                  type: Error
                  errorCode: CONFLICT
        '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:
      - EvaluateReviewDatesTaskState
      summary: Get task state
      description: Returns the state of a EvaluateReviewDates task.
      operationId: GetTaskState
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task 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
      responses:
        '200':
          description: Success. EvaluateReviewDatesTaskStateDto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Review 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: /reviewcommand
components:
  schemas:
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    EvaluateReviewDatesTaskStateDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateStateForEvaluateReviewDatesTaskRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateStateForEvaluateReviewDatesTaskRequest'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EvaluateReviewDatesTaskStateDto:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        entityDraftId:
          type: string
          format: uuid
        journeyId:
          type: string
          format: uuid
        taskId:
          type: string
          format: uuid
        reviewsToUpdate:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EvaluateReviewDatesReviewDto'
      additionalProperties: false
    EvaluateReviewDatesReviewDto:
      required:
      - calculatedDate
      - journeyType
      - launchDate
      - reviewId
      - reviewType
      - ruleId
      type: object
      properties:
        reviewId:
          minLength: 1
          type: string
          format: uuid
        ruleId:
          minLength: 1
          type: string
          format: uuid
        typeId:
          type: string
          format: uuid
        reviewType:
          minLength: 1
          type: string
        journeyType:
          minLength: 1
          type: string
        launchDate:
          minLength: 1
          type: string
          format: date-time
        calculatedDate:
          minLength: 1
          type: string
          format: date-time
      additionalProperties: false
    UpdateStateForEvaluateReviewDatesTaskRequest:
      type: object
      properties:
        reviewsToUpdate:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EvaluateReviewDatesReviewDto'
      additionalProperties: false
    EvaluateReviewDatesTaskStateDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateReviewDatesTaskStateDto'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    EvaluateReviewDatesReviewDto_2:
      type: object
      properties:
        reviewId:
          type: string
          format: uuid
        ruleId:
          type: string
          format: uuid
        typeId:
          type: string
          format: uuid
        reviewType:
          type:
          - string
          - 'null'
        journeyType:
          type:
          - string
          - 'null'
        launchDate:
          type: string
          format: date-time
        calculatedDate:
          type: string
          format: date-time
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-reviewcommand-v1-0-openapi.json
- fenergo-reviewquery-v1-0-openapi.json