openapi: 3.2.0
info:
  title: Fenergo Significance Rule API
  version: '1.0'
  description: 'Operations tagged SignificanceRule 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: SignificanceRule
paths:
  /api/v1/SignificanceRule:
    post:
      tags:
      - SignificanceRule
      summary: Creates a new SignificanceRule
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleEdit'
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateSignificanceRuleRequestServiceRequest'
      responses:
        '202':
          description: Success. SignificanceRule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuidServiceResponse'
        '400':
          description: Bad request. The request object has missing or invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: postApiV1SignificanceRule
      x-operation-id-source: derived
    delete:
      tags:
      - SignificanceRule
      summary: Deletes a SignificanceRule
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleDelete'
      parameters:
      - name: id
        in: query
        description: ''
        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:
        '202':
          description: Success. SignificanceRule 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
      deprecated: true
      operationId: deleteApiV1SignificanceRule
      x-operation-id-source: derived
    get:
      tags:
      - SignificanceRule
      summary: Get a list of all available SignificanceRules
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleAccess'
      operationId: GetSignificanceRules
      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 SignificanceRules returned in the response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSignificanceRulesItemDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request object has missing or invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: Internal Server Error
        '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
        '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/SignificanceRule/{id}:
    put:
      tags:
      - SignificanceRule
      summary: Updates a SignificanceRule
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleEdit'
      parameters:
      - name: id
        in: path
        description: ''
        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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateSignificanceRuleRequestServiceRequest'
      responses:
        '202':
          description: Success. SignificanceRule 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: putApiV1SignificanceRuleById
      x-operation-id-source: derived
    delete:
      tags:
      - SignificanceRule
      summary: Deletes a SignificanceRule by route id
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleDelete'
      parameters:
      - name: id
        in: path
        description: ''
        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:
        '202':
          description: Success. SignificanceRule deleted
          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: deleteApiV1SignificanceRuleById
      x-operation-id-source: derived
    get:
      tags:
      - SignificanceRule
      summary: Get a SignificanceRule by Id
      description: 'Required permissions:

        At least one of the following permissions is required: SignificanceRuleAccess, SignificanceTaskAccess'
      operationId: GetSignificanceRuleById
      parameters:
      - name: id
        in: path
        description: ''
        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. The SignificanceRule returned in the response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSignificanceRuleDtoServiceResponse'
        '400':
          description: Bad request. The request object has missing or invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: Internal Server Error
        '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
        '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/SignificanceRule/getSignificanceRulesByListOfIds:
    post:
      tags:
      - SignificanceRule
      summary: Get a list of the SignificanceRules by a list of Ids
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleAccess'
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetSignificanceRulesByListOfIdsRequestServiceRequest'
      responses:
        '200':
          description: Success. List of SignificanceRules returned in the response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSignificanceRulesItemDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request object has missing or invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '500':
          description: Internal Server Error
        '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
        '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: postApiV1SignificanceRuleGetSignificanceRulesByListOfIds
      x-operation-id-source: derived
    servers:
    - url: /significancequery
  /api/v1/SignificanceRule/simulate-evaluation:
    post:
      tags:
      - SignificanceRule
      summary: Simulates the evaluation of a significance rule
      description: 'Required permissions:

        Following permissions are required: SignificanceRuleAccess'
      operationId: SimulateSignificanceRuleEvaluation
      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: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SimulateSignificanceRuleEvaluationRequestServiceRequest'
      responses:
        '200':
          description: Success. Significance rule evaluation simulated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateSignificanceRuleEvaluationDtoServiceResponse'
        '400':
          description: Bad request. The request object has missing or invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '403':
          description: Forbidden. Your client is not authorized to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: Unauthorized. You are missing the required permissions to execute this action
        '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: /significancequery
components:
  schemas:
    ServiceResponse:
      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
    CreateSignificanceRuleRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateSignificanceRuleRequest'
      additionalProperties: false
    CreateSignificanceRuleRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        definition:
          type: string
        context:
          allOf:
          - $ref: '#/components/schemas/SignificanceRuleContext'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    UpdateSignificanceRuleRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        definition:
          type: string
        context:
          allOf:
          - $ref: '#/components/schemas/SignificanceRuleContext'
      additionalProperties: false
    GuidServiceResponse:
      type: object
      properties:
        data:
          type: string
          format: uuid
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    UpdateSignificanceRuleRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateSignificanceRuleRequest'
      additionalProperties: false
    SignificanceRuleContext:
      enum:
      - MainEntityData
      - RelationshipData
      - RelatedPartyData
      type: string
    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
    GetSignificanceRulesByListOfIdsRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
            format: uuid
      additionalProperties: false
    SimulateSignificanceRuleEvaluationRequest:
      type: object
      properties:
        ruleDefinition:
          type: string
        beforeValue: {}
        afterValue: {}
      additionalProperties: false
    SimulateSignificanceRuleEvaluationRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SimulateSignificanceRuleEvaluationRequest'
      additionalProperties: false
    GetSignificanceRulesByListOfIdsRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetSignificanceRulesByListOfIdsRequest'
      additionalProperties: false
    GetSignificanceRuleDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetSignificanceRuleDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SignificanceRuleEvaluationProperty:
      type: object
      properties:
        nameMetadata:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        beforeValue:
          type:
          - string
          - 'null'
        afterValue:
          type:
          - string
          - 'null'
        evaluation:
          type:
          - string
          - 'null'
        explanation:
          type:
          - string
          - 'null'
        entityId:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetSignificanceRulesItemDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        definition:
          type: string
        updatedAt:
          type: string
          format: date-time
        context:
          allOf:
          - $ref: '#/components/schemas/SignificanceRuleContext'
      additionalProperties: false
    SimulateSignificanceRuleEvaluationDto:
      type: object
      properties:
        error:
          type:
          - string
          - 'null'
        properties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SignificanceRuleEvaluationProperty'
      additionalProperties: false
    SimulateSignificanceRuleEvaluationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SimulateSignificanceRuleEvaluationDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetSignificanceRuleDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        definition:
          type: string
        updatedAt:
          type: string
          format: date-time
        context:
          allOf:
          - $ref: '#/components/schemas/SignificanceRuleContext'
      additionalProperties: false
    GetSignificanceRulesItemDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GetSignificanceRulesItemDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      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