Fenergo Significance Result API

openapi: 3.2.0
info:
  title: Fenergo Significance Result API
  version: '1.0'
  description: 'Operations tagged SignificanceResult across 2 of this provider''s published API definitions: fenergo-significancecommand-v1-0-openapi.json, fenergo-significancequery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /significancecommand
- url: /significancequery
security:
- Bearer: []
tags:
- name: SignificanceResult
paths:
  /api/v1/SignificanceResult/{journeyId}/{taskId}:
    put:
      tags:
      - SignificanceResult
      summary: Updates a SignificanceResult
      description: 'Required permissions:

        At least one of the following permissions is required: SignificanceRuleAccess, SignificanceTaskEdit'
      parameters:
      - name: journeyId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyType
        in: query
        description: ''
        schema:
          type: string
      - name: taskType
        in: query
        description: ''
        schema:
          type: string
      - name: taskName
        in: query
        description: ''
        schema:
          type: string
      - 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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateSignificanceResultRequestListServiceRequest'
      responses:
        '202':
          description: Success. SignificanceResult created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request object has missing or 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
                  type: Error
                  errorCode: Error Code
        '401':
          description: Unauthorized. You are missing the required permissions to execute this action
        '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: putApiV1SignificanceResultByJourneyIdByTaskId
      x-operation-id-source: derived
    get:
      tags:
      - SignificanceResult
      summary: Retrieves the significance result for a given task ID
      operationId: GetSignificanceResultByTaskId
      parameters:
      - name: journeyId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: query
        description: Optional entity ID to filter properties for a specific entity.
        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. The significance result is returned in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSignificanceResultByTaskIdDtoServiceResponse'
        '400':
          description: Bad request. The request is invalid or missing required values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: Internal server error. An unexpected error occurred.
        '401':
          description: Unauthorized. The caller lacks the required permissions.
        '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: /significancecommand
  /api/v1/SignificanceResult/override/{journeyId}/{taskId}:
    put:
      tags:
      - SignificanceResult
      summary: Overrides the classification of one or more properties in a SignificanceResult…
      description: 'Required permissions:

        At least one of the following permissions is required: SignificanceRuleAccess, SignificanceTaskEdit'
      parameters:
      - name: journeyId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyType
        in: query
        description: ''
        schema:
          type: string
      - name: taskType
        in: query
        description: ''
        schema:
          type: string
      - name: taskName
        in: query
        description: ''
        schema:
          type: string
      - 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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OverrideSignificanceResultRequestListServiceRequest'
      responses:
        '202':
          description: Success. SignificanceResult override applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request object has missing or 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
                  type: Error
                  errorCode: Error Code
        '401':
          description: Unauthorized. You are missing the required permissions to execute this action
        '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: putApiV1SignificanceResultOverrideByJourneyIdByTaskId
      x-operation-id-source: derived
    servers:
    - url: /significancecommand
components:
  schemas:
    UpdateSignificanceResultRequestListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UpdateSignificanceResultRequest'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    OverrideSignificanceResultRequestListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OverrideSignificanceResultRequest'
      additionalProperties: false
    OverrideSignificanceResultRequest:
      allOf:
      - $ref: '#/components/schemas/UpdateSignificanceResultRequest'
      - type: object
        properties:
          isReviewed:
            type:
            - boolean
            - 'null'
        additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    UpdateSignificanceResultRequest:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        evaluation:
          type: string
        explanation:
          type: string
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        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
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetSignificanceResultByTaskIdDto:
      type: object
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/GetSignificanceResultByTaskIdProperty'
        error:
          type:
          - string
          - 'null'
        rationale:
          type:
          - string
          - 'null'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        ruleContext:
          allOf:
          - $ref: '#/components/schemas/SignificanceRuleContext'
        auditHistory:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AuditEntryDto'
        ruleName:
          type:
          - string
          - 'null'
        ruleId:
          type:
          - string
          - 'null'
        autonomyLevel:
          type:
          - string
          - 'null'
        agentName:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetSignificanceResultByTaskIdProperty:
      type: object
      properties:
        id:
          type: string
        nameMetadata:
          type: array
          items:
            type: string
        name:
          type: string
        displayName:
          type: string
        beforeValue:
          type: string
        afterValue:
          type: string
        hasSignificantChange:
          type: boolean
        modelEvaluation:
          type:
          - string
          - 'null'
        modelExplanation:
          type: string
        userEvaluation:
          type:
          - string
          - 'null'
        userExplanation:
          type:
          - string
          - 'null'
        entityId:
          type:
          - string
          - 'null'
        isReviewed:
          type: boolean
        reviewedBy:
          type:
          - string
          - 'null'
        reviewedAt:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    SignificanceRuleContext:
      enum:
      - MainEntityData
      - RelationshipData
      - RelatedPartyData
      type: string
    GetSignificanceResultByTaskIdDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetSignificanceResultByTaskIdDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AuditEntryDto:
      type: object
      properties:
        action:
          type: string
        propertyId:
          type: string
        propertyName:
          type: string
        fromValue:
          type:
          - string
          - 'null'
        toValue:
          type:
          - string
          - 'null'
        performedBy:
          type: string
        performedAt:
          type: string
          format: date-time
        explanation:
          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-significancecommand-v1-0-openapi.json
- fenergo-significancequery-v1-0-openapi.json