Fenergo Entity Profile Configuration API

openapi: 3.2.0
info:
  title: Fenergo Entity Profile Configuration API
  version: '1.0'
  description: 'Operations tagged EntityProfileConfiguration across 2 of this provider''s published API definitions: fenergo-entityprofilecommand-v1-0-openapi.json, fenergo-entityprofilequery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /entityprofilecommand
- url: /entityprofilequery
security:
- Bearer: []
tags:
- name: EntityProfileConfiguration
paths:
  /api/EntityProfileConfiguration:
    post:
      tags:
      - EntityProfileConfiguration
      summary: Create the configuration for the entity profile page
      description: 'Required permissions:

        Following permissions are required: EntityProfileConfigurationEdit'
      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 object containing the new configuration values
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateConfigurationCommandRequest'
      responses:
        '202':
          description: Success. Entity Profile Configuration 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'
        '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: postApiEntityProfileConfiguration
      x-operation-id-source: derived
    servers:
    - url: /entityprofilecommand
  /api/EntityProfileConfiguration/{id}:
    put:
      tags:
      - EntityProfileConfiguration
      summary: Update an existing configuration for the entity profile page
      description: 'Required permissions:

        Following permissions are required: EntityProfileConfigurationEdit'
      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: Request object containing the updated configuration values
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateConfigurationCommandRequest'
      responses:
        '202':
          description: Success. Entity Profile Configuration created
        '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
        '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: putApiEntityProfileConfigurationById
      x-operation-id-source: derived
    servers:
    - url: /entityprofilecommand
  /api/EntityProfileConfiguration/{entityId}/{perfomedAction}:
    post:
      tags:
      - EntityProfileConfiguration
      summary: Log Entity Profile Action
      operationId: LogEntityProfileAccess
      parameters:
      - name: entityId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: perfomedAction
        in: path
        description: ''
        required: true
        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
      responses:
        '202':
          description: Success. Action was logged
        '400':
          description: Bad Request
          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: /entityprofilecommand
  /api/entityprofileconfiguration:
    get:
      tags:
      - EntityProfileConfiguration
      summary: Get the configurations for every entity type
      operationId: GetConfigurations
      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 Entity Profile Configuration objects returned in the response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigurationDtoIEnumerableServiceResponse'
        '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: /entityprofilequery
  /api/entityprofileconfiguration/{id}:
    get:
      tags:
      - EntityProfileConfiguration
      summary: Get the configuration for a specific entity type
      operationId: GetConfiguration
      parameters:
      - name: id
        in: path
        description: GUID of the requested configuration
        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. Entity Profile Configuration object returned in the response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigurationDtoServiceResponse'
        '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: /entityprofilequery
components:
  schemas:
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityGroupConfigurableColumns:
      allOf:
      - $ref: '#/components/schemas/BaseConfigurableColumns'
      - type: object
        properties:
          jurisdiction:
            type:
            - string
            - 'null'
        additionalProperties: false
    GuidServiceResponse:
      type: object
      properties:
        data:
          type: string
          format: uuid
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AgencyConfiguration:
      type: object
      properties:
        underlyingPrincipalsCategory:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CommonConfiguration:
      type: object
      properties:
        documentUploadVersion:
          type: integer
          format: int32
        configurableDocumentColumns:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BaseConfigurableColumns'
        showInvestmentAccountAssociations:
          type: boolean
        screeningOutcomes:
          type: boolean
      additionalProperties: false
    UpdateConfigurationCommandRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
        orderAlphabetically:
          type: boolean
        overviewCategory:
          type:
          - string
          - 'null'
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
        hiddenStatusChips:
          type:
          - array
          - 'null'
          items:
            type: string
        entityGroupConfigurableColumns:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityGroupConfigurableColumns'
        commonConfiguration:
          allOf:
          - $ref: '#/components/schemas/CommonConfiguration'
        agencyConfiguration:
          allOf:
          - $ref: '#/components/schemas/AgencyConfiguration'
        rightHandDrawerCategory:
          type:
          - string
          - 'null'
        entityType:
          allOf:
          - $ref: '#/components/schemas/EntityTypeDto'
      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
    EntityTypeDto:
      enum:
      - Individual
      - Company
      - Other
      - Group
      - Managed Relationship
      - Product
      type: string
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateConfigurationCommandRequest:
      type: object
      properties:
        entityType:
          enum:
          - Individual
          - Company
          - Other
          - Group
          - Managed Relationship
          - Product
          type: string
          allOf:
          - $ref: '#/components/schemas/EntityTypeDto'
        orderAlphabetically:
          type: boolean
        overviewCategory:
          type:
          - string
          - 'null'
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
        hiddenStatusChips:
          type:
          - array
          - 'null'
          items:
            type: string
        entityGroupConfigurableColumns:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityGroupConfigurableColumns'
        commonConfiguration:
          allOf:
          - $ref: '#/components/schemas/CommonConfiguration'
        agencyConfiguration:
          allOf:
          - $ref: '#/components/schemas/AgencyConfiguration'
        rightHandDrawerCategory:
          type:
          - string
          - 'null'
      additionalProperties: false
    BaseConfigurableColumns:
      type: object
      properties:
        displayName:
          type:
          - string
          - 'null'
        keyName:
          type:
          - string
          - 'null'
        propertyType:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetConfigurationDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetConfigurationDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GetConfigurationDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetConfigurationDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        entityType:
          enum:
          - Individual
          - Company
          - Other
          - Group
          - Managed Relationship
          - Product
          type: string
          allOf:
          - $ref: '#/components/schemas/EntityTypeDto'
        orderAlphabetically:
          type: boolean
        overviewCategory:
          type:
          - string
          - 'null'
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
        lastUpdated:
          type:
          - string
          - 'null'
          format: date-time
        hiddenStatusChips:
          type:
          - array
          - 'null'
          items:
            type: string
        entityGroupConfigurableColumns:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityGroupConfigurableColumns'
        commonConfiguration:
          allOf:
          - $ref: '#/components/schemas/CommonConfiguration'
        agencyConfiguration:
          allOf:
          - $ref: '#/components/schemas/AgencyConfiguration'
        rightHandDrawerCategory:
          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-entityprofilecommand-v1-0-openapi.json
- fenergo-entityprofilequery-v1-0-openapi.json