Fenergo Get Fields Grouped Lookup Options API

openapi: 3.2.0
info:
  title: Fenergo Get Fields Grouped Lookup Options API
  version: '1.0'
  description: 'Operations tagged GetFieldsGroupedLookupOptions across 2 of this provider''s published API definitions: fenergo-policyquery-v2-0-openapi.json, fenergo-productpolicyquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policyquery
- url: /productpolicyquery
security:
- Bearer: []
tags:
- name: GetFieldsGroupedLookupOptions
paths:
  /api/v2/requirement-set/fields/grouped-lookup-options:
    post:
      tags:
      - GetFieldsGroupedLookupOptions
      summary: Gets grouped lookup options for fields based on specified criteria
      description: 'Required permissions:

        Following permissions are required: PolicySearch'
      operationId: GetFieldsGroupedLookupOptions
      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: Request containing filter parameters for field lookup options
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FieldsGroupedLookupOptionsRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Grouped lookup options for fields are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsGroupedLookupOptionsDtoServiceResponse'
        '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
                  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: /policyquery
  /api/product-requirement-set/fields/grouped-lookup-options:
    post:
      tags:
      - GetFieldsGroupedLookupOptions
      summary: Gets grouped lookup options for fields based on specified criteria
      description: 'Required permissions:

        Following permissions are required: ProductConfigurationSearch'
      operationId: GetFieldsGroupedLookupOptions
      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: Request containing filter parameters for field lookup options
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FieldsGroupedLookupOptionsRequestDtoServiceRequest_2'
      responses:
        '200':
          description: Success. Grouped lookup options for fields are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsGroupedLookupOptionsDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found
                  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_2'
              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_2'
              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_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicyquery
components:
  schemas:
    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
    FieldsGroupedLookupOptionsDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FieldsGroupedLookupOptionsDto'
          description: Response DTO containing grouped lookup options for fields
        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
    FieldsGroupedLookupOptionsDto:
      type: object
      properties:
        options:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupedLookupOptionsDto'
          description: Collection of grouped lookup options
      additionalProperties: false
      description: Response DTO containing grouped lookup options for fields
    GroupedLookupOptionsDto:
      type: object
      properties:
        dataKey:
          type:
          - string
          - 'null'
          description: The identifier key for the data field
          example: legalEntityName
        fieldTypeId:
          type: string
          description: The unique identifier for the field type
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        fieldType:
          type:
          - string
          - 'null'
          description: Field type associated with this data key
          example: '["multiselect", "select"]'
        names:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of display names used for this field across different contexts
          example:
          - Business Name
          - Business Name 1
        jurisdictions:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of jurisdiction names where this field is used
          example:
          - California
          - New York
          - Texas
      additionalProperties: false
      description: Represents grouped lookup options for a field with associated metadata
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    FieldsGroupedLookupOptionsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FieldsGroupedLookupOptionsRequestDto'
          description: Request DTO representing parameters to filter returned data fields
      additionalProperties: false
      description: Service request data
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    FieldsGroupedLookupOptionsRequestDto:
      type: object
      properties:
        draftRequirementSetVersionId:
          type:
          - string
          - 'null'
          description: Draft Requirement Set Version Id
          format: uuid
          example: e8aa237d-a534-48a1-922e-a933a14460cc
        excludeRequirementId:
          type:
          - string
          - 'null'
          description: Excludes the currently edited requirement ID from the results. This applies only when `DraftRequirementSetVersionId` is defined.
          format: uuid
        targetEntity:
          type:
          - string
          - 'null'
          description: Requirement target entity
          example: Client
        entityType:
          type:
          - string
          - 'null'
          description: Requirement entity type
          example: Individual
        journeyLevelDataOnly:
          type: boolean
          description: Flag indicating if returned requirements will be Journey Level Data only
          example: false
      additionalProperties: false
      description: Request DTO representing parameters to filter returned data fields
    ServiceResponseMessage_2:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    FieldsGroupedLookupOptionsDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FieldsGroupedLookupOptionsDto'
          description: Response DTO containing grouped lookup options for fields
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    ObjectServiceResponse_2:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
    FieldsGroupedLookupOptionsRequestDtoServiceRequest_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FieldsGroupedLookupOptionsRequestDto'
          description: Request DTO representing parameters to filter returned data fields
      additionalProperties: false
    StringServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-policyquery-v2-0-openapi.json
- fenergo-productpolicyquery-v1-0-openapi.json