openapi: 3.2.0
info:
  title: Fenergo Entity Drafts In Scope API
  version: '1.0'
  description: 'Operations tagged EntityDraftsInScope across 2 of this provider''s published API definitions: fenergo-entitydataquery-v1-0-openapi.json, fenergo-entitydataquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /entitydataquery
security:
- Bearer: []
tags:
- name: EntityDraftsInScope
paths:
  /api/drafts-in-scope/searchentitydrafts:
    post:
      tags:
      - EntityDraftsInScope
      summary: Search entity drafts
      description: 'Returns list of entity draft for a given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchEntityDrafts
      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 with search criteria
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchEntityDraftsDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entity draft is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDraftDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: /entitydataquery
  /api/v2/drafts-in-scope/searchentitydrafts:
    post:
      tags:
      - EntityDraftsInScope
      summary: Search entity drafts
      description: 'Returns list of entity draft for a given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2DraftsInScopeSearchentitydrafts
      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 with search criteria
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchEntityDraftsDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entity draft is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDraftDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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
      x-operation-id-source: normalized
      x-operation-id-original: SearchEntityDrafts
    servers:
    - url: /entitydataquery
  /api/v2/drafts-in-scope/search-entity-drafts-light:
    post:
      tags:
      - EntityDraftsInScope
      summary: Search entity drafts (light projection)
      description: 'Returns a paginated light projection (entity id / draft id only) of entity drafts for a

        given search criteria. Omit `pageOptions` to get the first page with the default page

        size (100). Keep requesting the next page (passing the returned `paginationToken` back as

        `pageOptions.paginationToken`) until it comes back null - pages may be short or empty

        before the results are exhausted.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchEntityDraftsLight
      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 with search criteria
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchEntityDraftsLightRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. A page of entity drafts is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDraftsLightDtoItemsPageServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: /entitydataquery
components:
  schemas:
    EntityRiskDto:
      type: object
      properties:
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category
          example: Low
        riskLevel:
          type:
          - number
          - 'null'
          description: Risk level
          format: double
          example: 1
      additionalProperties: false
      description: Response DTO representing the entity risk data
    PropertiesDto:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        collectionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionPropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    SearchEntityDraftsDto:
      type: object
      properties:
        journeyId:
          type: string
          description: Journey id
          format: uuid
          example: e51b9087-7565-4d8d-864d-fa57177a8bea
        entityId:
          type:
          - string
          - 'null'
          description: Entity id
          format: uuid
          example: bb88430f-48ec-46de-92dc-905876e0e8eb
          deprecated: true
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Entity ids
      additionalProperties: false
      description: Request DTO representing entity drafts search criteria
    AccessLayerDto:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
        geographicDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of geographic access layers with details about inheritance
        businessRelatedDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of business related access layers with details about inheritance
      additionalProperties: false
      description: Response DTO representing associated access layers
    PropertyDto:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Property is not used in generated models. We need it to deserialize correctly to specific type in generated DotNet Client.
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of properties.
          readOnly: true
      additionalProperties: false
      description: Abstraction that represents properties
      discriminator:
        propertyName: discriminator
        mapping:
          Collection: '#/components/schemas/CollectionPropertyDto'
          Custom: '#/components/schemas/CustomPropertyDto'
          Single: '#/components/schemas/SinglePropertyDto'
    EntityRoleDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Role of the entity
          example: Client
      additionalProperties: false
      description: Response DTO representing the entity role data
    RiskConfigurationVersionDto:
      type: object
      properties:
        riskModel:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskVersionDto'
          description: The list of Risk Models and their versions used in the Entity Draft
        riskConfigurationModel:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskVersionDto'
          description: The list of Risk Configuration Models and their versions used in the Entity Draft
        thresholdModel:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskVersionDto'
          description: The list of Threshold Models and their versions used in the Entity Draft
      additionalProperties: false
      description: Dto to store the risk configuration models and versions used in the Entity Draft
    SearchEntityDraftsDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchEntityDraftsDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntityDraftDto:
      type: object
      properties:
        id:
          type: string
          description: Entity draft id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        sourceEntityId:
          type: string
          description: Source entity id
          format: uuid
          example: bb88430f-48ec-46de-92dc-905876e0e8eb
        parentDraftId:
          type:
          - string
          - 'null'
          description: Parent draft Id
          format: uuid
          example: cb88430f-55ed-64bb-97dc-905876e0e8ec
        sourceEntityVersion:
          type: integer
          description: Source entity version
          format: int32
          example: 1
        sourcePropertiesVersion:
          type: integer
          description: The version of the source entity properties when the draft was created
          format: int32
          example: 5
        conflictsResolvedSourceEntityVersion:
          type: integer
          description: Conflicts resolved aggregate version
          format: int32
          example: 5
        conflictsResolvedPropertiesVersion:
          type: integer
          description: Conflicts resolved properties version
          format: int32
          example: 2
        journeyId:
          type: string
          description: Journey id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
        type:
          type:
          - string
          - 'null'
          description: Entity draft type
          example: Individual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Main entity draft properties
        draftProperties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
          description: Draft Only properties
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity draft risk
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto'
          description: Entity draft role
        status:
          type:
          - string
          - 'null'
          description: Status
          example: InProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: List of Jurisdictions associated with EntityDraft
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto'
          description: Jurisdictions associated from parents
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: List of evaluated jurisdictions
        riskVersion:
          allOf:
          - $ref: '#/components/schemas/RiskConfigurationVersionDto'
          description: List of Risk Configurations associated with EntityDraft
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Entity access layers determining the access to the entity Draft
        version:
          type: integer
          description: Version number for given EntityDraft
          format: int32
          example: 1
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template VersionId - used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
      additionalProperties: false
      description: Response DTO representing entity draft data
    CollectionItemDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
      additionalProperties: false
    CollectionPropertyDto2:
      type: object
      properties:
        items:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionItemDto'
        collectionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    AccessLayerDetailsDto:
      type: object
      properties:
        dataKey:
          type:
          - string
          - 'null'
          description: Access layer data key
          example: Global
        inheritedFrom:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: List of entity ids that access layer is inherited from
        isInherited:
          type: boolean
          description: Flag indicating if access layer is inherited by default
      additionalProperties: false
    SharedDataTemplateDto:
      type: object
      properties:
        sharedDataTemplateId:
          type: string
          description: The Shared Data Template Id
          format: uuid
        versionNumber:
          type: integer
          description: The version of the shared data template linked to the entity
          format: int32
      additionalProperties: false
      description: Request DTO to query for a shared data template linked to an entity group
    VersionedJurisdictionDto:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    EntityDraftDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityDraftDto'
          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
    SinglePropertyDto2:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
          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
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          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
    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
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    CustomPropertyDto2:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    MaskedPropertiesDto:
      type: object
      properties:
        singleProperties:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Masked single data requirement properties
          example:
          - property1
      additionalProperties: false
      description: Property name list of sensitive data requirements with masked value
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    AssociatedVersionedJurisdictionDto:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
        isOffboarded:
          type: boolean
          description: Flag to determine if previously associated jurisdiction is now offboarded
          example: false
      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
    RiskVersionDto:
      type: object
      properties:
        id:
          type: string
          description: The Id of the risk model
          format: uuid
        version:
          type: integer
          description: The version of the model
          format: int32
      additionalProperties: false
      description: Stores the Id and the Version of a Risk Configuration Model
    SearchEntityDraftsLightDtoItemsPage:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchEntityDraftsLightDto'
          description: The items result set
        paginationToken:
          type:
          - string
          - 'null'
          description: The token for retrieving the next page of results
      additionalProperties: false
      description: Query Result Page
    PageOptions:
      type: object
      properties:
        paginationToken:
          type:
          - string
          - 'null'
          description: 'Position token for the search results to start

            (leave empty to start from the 1st item)'
        pageSize:
          type: integer
          description: Size of the page (result set)
          format: int32
          example: 10
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder'
          description: Sort Order (Ascending or Descending)
      additionalProperties: false
      description: Options for setting up the results page
    SearchEntityDraftsLightRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchEntityDraftsLightRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    SortOrder:
      enum:
      - 0
      - 1
      type: integer
      description: Sort Order (Ascending or Descending)
      format: int32
    SearchEntityDraftsLightDtoItemsPageServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchEntityDraftsLightDtoItemsPage'
          description: Query Result Page
        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
    SearchEntityDraftsLightRequestDto:
      type: object
      properties:
        journeyId:
          type: string
          description: Journey id
          format: uuid
          example: e51b9087-7565-4d8d-864d-fa57177a8bea
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Entity ids
        pageOptions:
          allOf:
          - $ref: '#/components/schemas/PageOptions'
          description: Options for setting up the results page
      additionalProperties: false
      description: Request DTO representing entity drafts search criteria, paged via Fenergo.Nebula.EntityData.Query.Application.Dto.SearchEntityDraftsLightRequestDto.PageOptions
    SearchEntityDraftsLightDto:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        entityDraftId:
          type: string
          format: uuid
      additionalProperties: false
      description: 'Light projection of an entity draft, for callers that only need to know

        which entities already have a draft in a journey (not the full draft body)'
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-entitydataquery-v1-0-openapi.json
- fenergo-entitydataquery-v2-0-openapi.json