Fenergo Tag API

openapi: 3.2.0
info:
  title: Fenergo Tag API
  version: '1.0'
  description: 'Operations tagged Tag across 2 of this provider''s published API definitions: fenergo-policyquery-v1-0-openapi.json, fenergo-policyquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policyquery
security:
- Bearer: []
tags:
- name: Tag
paths:
  /api/tag/requirements:
    get:
      tags:
      - Tag
      summary: Get requirements by tags list
      description: 'Returns list of requirements searched by tags


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetRequirementsByTags
      parameters:
      - name: tags
        in: query
        description: List of tags
        schema:
          type: array
          items:
            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
      responses:
        '200':
          description: Success. List of requirements is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequirementDtoListServiceResponse'
        '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: /policyquery
  /api/tag:
    get:
      tags:
      - Tag
      summary: Get list of published tags for tenant
      description: 'Returns list of published tags for tenant


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetTagsByTenant
      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 tags is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
        '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: /policyquery
  /api/tag/requirement-set/{setId}:
    get:
      tags:
      - Tag
      summary: Get list of tags in Requirement Set
      description: 'Returns list of tags in Requirement Set


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetTagsByRequirementSetId
      parameters:
      - name: setId
        in: path
        description: Requirement Set 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. List of tags is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
        '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: /policyquery
  /api/v2/tag/requirements:
    get:
      tags:
      - Tag
      summary: Get requirements by tags list
      description: 'Returns list of requirements searched by tags


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetRequirementsByTags
      parameters:
      - name: tags
        in: query
        description: List of tags
        schema:
          type: array
          items:
            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
      responses:
        '200':
          description: Success. List of requirements is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequirementDtoListServiceResponse'
        '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: /policyquery
  /api/v2/tag:
    get:
      tags:
      - Tag
      summary: Get list of published tags for tenant
      description: 'Returns list of published tags for tenant


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetTagsByTenant
      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 tags is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
        '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: /policyquery
  /api/v2/tag/requirement-set/{setId}:
    get:
      tags:
      - Tag
      summary: Get list of tags in Requirement Set
      description: 'Returns list of tags in Requirement Set


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: GetTagsByRequirementSetId
      parameters:
      - name: setId
        in: path
        description: Requirement Set 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. List of tags is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListServiceResponse'
        '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: /policyquery
components:
  schemas:
    RegexRuleDto2:
      type: object
      properties:
        active:
          type: boolean
          description: Validation rule active flag
          example: true
        message:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        isCaseSensitive:
          type: boolean
          description: Flag that indicate if regex is case sensitive
          example: false
        regexValue:
          type:
          - string
          - 'null'
          description: Regex expression
          example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$
      additionalProperties: false
      description: Request DTO representing regex rule metadata
    EmptyRuleDtoConditionalValueDto:
      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
        value:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDto'
          description: Request DTO representing rule with no parameters
        priority:
          type: integer
          description: Priority of the value in case when multiple conditional values are evaluated
          format: int32
          example: 1
      additionalProperties: false
    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
    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
    AccessLayerDto:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    EmptyRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDto'
          description: Static validation rule always applied when active
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto'
          description: Conditional validation rules
      additionalProperties: false
    ValueLimitRuleDtoConditionalValueDto:
      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
        value:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
          description: Request DTO representing value limit rule metadata
        priority:
          type: integer
          description: Priority of the value in case when multiple conditional values are evaluated
          format: int32
          example: 1
      additionalProperties: false
    DateLimitRuleDto:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        minDate:
          type:
          - string
          - 'null'
          description: Minimum date
          format: date-time
          example: '2020-01-01T14:48:00.000Z'
        maxDate:
          type:
          - string
          - 'null'
          description: Maximum date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
      additionalProperties: false
      description: Request DTO representing date limit rule metadata
    OwnershipValidationDataDto:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
          description: Request DTO representing basic validation rule metadata
        partyCount:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto2'
          description: Request DTO representing value limit rule metadata
        addAllParties:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
          description: Request DTO representing basic validation rule metadata
        idvIsMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
          description: Request DTO representing basic validation rule metadata
        idvPartyCount:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto2'
          description: Request DTO representing value limit rule metadata
        idvAllParties:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
          description: Request DTO representing basic validation rule metadata
      additionalProperties: false
    DateTimePeriodFormulaVariableDto:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
        timePeriodKind:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        timeZoneId:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionMaximumCountRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
          description: Static validation rule always applied when active
      additionalProperties: false
    BasicRuleDtoConditionalValueDto:
      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
        value:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Request DTO representing basic validation rule metadata
        priority:
          type: integer
          description: Priority of the value in case when multiple conditional values are evaluated
          format: int32
          example: 1
      additionalProperties: false
    DateTimePeriodFormulaSchemaDto:
      type: object
      properties:
        formulaSetId:
          type: string
          format: uuid
        versionNumber:
          type:
          - integer
          - 'null'
          format: int32
        formulaString:
          type:
          - string
          - 'null'
        dateTimePeriodFormulaVariables:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto'
      additionalProperties: false
    RequirementDto:
      type: object
      properties:
        rootVersionId:
          type: string
          description: The UiD of the root requirement set version
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        versionNumber:
          type: integer
          description: Requirement set version number
          format: int32
          example: 1
        id:
          type: string
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        tenant:
          type:
          - string
          - 'null'
          description: The UiD of the tenant
          example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1
        category:
          type:
          - string
          - 'null'
          description: Requirement business category
          example: Basic Details
        description:
          type:
          - string
          - 'null'
          description: Requirement description
          example: This is the client first name
        template:
          type:
          - string
          - 'null'
          description: Requirement template
          example: Product
        entityType:
          type:
          - string
          - 'null'
          description: Requirement entity type
          example: Individual
        name:
          type:
          - string
          - 'null'
          description: Requirement name
          example: First Name
        isSensitiveData:
          type: boolean
          description: Requirement sensitive data flag
          example: true
        isMaterialData:
          type: boolean
          description: Requirement material data flag
          example: true
        isCoreDefinition:
          type: boolean
          description: Requirement is defined as core and cannot be deleted or altered
          example: false
        jurisdiction:
          type:
          - string
          - 'null'
          description: Requirement jurisdiction
          example: Global
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReferenceDto'
          description: Requirement references list
        targetEntity:
          type:
          - string
          - 'null'
          description: Requirement target entity
          example: Client
        classification:
          type:
          - string
          - 'null'
          description: Requirement classification
          example: Customer Profiling
        type:
          type:
          - string
          - 'null'
          description: Requirement type
          example: Data
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Requirement conditions list
        RequirementSetId:
          type: string
          description: The UiD of the current requirement set version
          format: uuid
          example: c060f297-70a2-4d4c-9360-9b5b39060ff0
        versionId:
          type: string
          description: The UiD of the current requirement set version
          format: uuid
          example: e060f297-70a2-4d4c-9360-9b5b39060ff0
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto'
          description: Data Field
        dataProtectionJurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction for data protection
          example: Global
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        defaultValue:
          type:
          - string
          - 'null'

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-tag-api-openapi.yml