openapi: 3.2.0
info:
  title: Fenergo Workspace API
  version: '1.0'
  description: 'Operations tagged Workspace across 2 of this provider''s published API definitions: fenergo-policycommand-v2-0-openapi.json, fenergo-policyquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policycommand
- url: /policyquery
security:
- Bearer: []
tags:
- name: Workspace
paths:
  /api/v2/workspaces:
    post:
      tags:
      - Workspace
      summary: Create workspace
      description: 'Required permissions:

        Following permissions are required: PolicyWorkspaceConfigurationEdit'
      operationId: CreateWorkspace
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateWorkspaceRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Workspace created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponseDtoServiceResponse'
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policycommand
  /api/v2/workspaces/{workspaceId}:
    put:
      tags:
      - Workspace
      summary: Update workspace
      description: 'Required permissions:

        Following permissions are required: PolicyWorkspaceConfigurationEdit'
      operationId: UpdateWorkspace
      parameters:
      - name: workspaceId
        in: path
        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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateWorkspaceRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Workspace updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://tools.ietf.org/html/rfc7231#section-6.5.4
                title: Resource not found
                detail: Not Found
                status: 404
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policycommand
  /api/v2/workspaces/bulk-delete:
    put:
      tags:
      - Workspace
      summary: Bulk soft delete workspaces
      description: 'Required permissions:

        Following permissions are required: PolicyWorkspaceConfigurationEdit'
      operationId: BulkDeleteWorkspaces
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BulkSoftDeleteWorkspaceRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Success. Workspaces soft deleted
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policycommand
  /api/v2/workspaces/current:
    put:
      tags:
      - Workspace
      summary: Update workspace preference for the current user
      operationId: UpdateCurrentUserWorkspace
      parameters:
      - name: workspaceId
        in: query
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Present workspace updated
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policycommand
  /api/v4/policies/{entityPolicyId}/workspaces:
    get:
      tags:
      - Workspace
      summary: Get available workspaces
      description: 'Returns non-deleted and used workspaces grouped by change type


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: ListAvailableWorkspaces
      parameters:
      - name: entityPolicyId
        in: path
        description: ID of the policy
        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 workspaces is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableWorkspaceItemResponseDtoListServiceResponse'
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policyquery
  /api/v4/policies/{entityPolicyId}/changes:
    get:
      tags:
      - Workspace
      summary: Get workspace changes
      description: 'Returns page of changes made to current policy in workspace context


        Required permissions:

        Following permissions are required: PolicyConfigurationAccess'
      operationId: ListWorkspaceChanges
      parameters:
      - name: entityPolicyId
        in: path
        description: ID of the policy
        required: true
        schema:
          type: string
          format: uuid
      - name: PageSize
        in: query
        description: Page size
        schema:
          type: integer
          format: int32
          example: 100
        example: 100
      - name: PaginationToken
        in: query
        description: Pagination token
        schema:
          type: string
      - name: workspaceId
        in: query
        description: ID of the workspace. If not provided, default workspace will be used
        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 workspaces is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceChangeListItemViewModelDtoItemsPageServiceResponse'
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policyquery
  /api/v4/workspaces:
    get:
      tags:
      - Workspace
      summary: Get workspaces
      description: 'Returns workspaces.


        Required permissions:

        Following permissions are required: PolicyWorkspaceConfigurationAccess'
      operationId: ListActiveWorkspaces
      parameters:
      - name: PageSize
        in: query
        description: Page size
        schema:
          type: integer
          format: int32
          example: 100
        example: 100
      - name: PaginationToken
        in: query
        description: Pagination token
        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:
        '200':
          description: Success. List of workspaces is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveWorkspaceViewModelDtoItemsPageServiceResponse'
        '400':
          description: One or more validation errors occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1
                title: One or more validation errors occurred
                detail: Name is required
                status: 400
                errorCode: VALIDATION_ERROR
                validationErrors:
                - propertyName: Name
                  errorMessage: Name is required
                  attemptedValue: ''
                  validatorType: NotEmptyValidator
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policyquery
  /api/v4/workspaces/current:
    get:
      tags:
      - Workspace
      summary: Get the user's current workspace
      description: Returns a user's current workspace.
      operationId: GetCurrentWorkspace
      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. User's current workspace is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCurrentWorkspaceResponseDtoServiceResponse'
        '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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3
                title: Access to resource is forbidden.
                detail: 'Access denied. Following permissions are required: Permission1, Permission2'
                status: 403
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1
                title: Internal server exception. Please, contact your provider.
                detail: null
                status: 500
                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/ProblemDetails'
              example:
                type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9
                title: 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.
                detail: This endpoint is obsolete and was terminated on yyyy-MM-dd
                status: 410
                errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /policyquery
components:
  schemas:
    CreateWorkspaceRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateWorkspaceRequestDto'
          description: Create workspace request
      additionalProperties: false
      description: Service request data
    UpdateWorkspaceRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateWorkspaceRequestDto'
          description: Update workspace request
      additionalProperties: false
      description: Service request data
    CreateWorkspaceResponseDto:
      required:
      - workspaceId
      type: object
      properties:
        workspaceId:
          type: string
          description: Unique identifier of Workspace
          format: uuid
          example: 46b34a29-d426-407e-b1cc-98d727ed4883
      additionalProperties: false
      description: Response DTO representing created Workspace
    BulkSoftDeleteWorkspaceRequestDto:
      required:
      - ids
      type: object
      properties:
        ids:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: List of workspace IDs to delete. A maximum of 20 IDs can be provided per request.
      additionalProperties: false
      description: Delete workspaces in bulk request
    CreateWorkspaceRequestDto:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 60
          minLength: 1
          type: string
          description: Name of Workspace
          example: Global configurators
        description:
          maxLength: 255
          type:
          - string
          - 'null'
          description: Description of Workspace
          example: Workspace for global configurators
      additionalProperties: false
      description: Create workspace request
    BulkSoftDeleteWorkspaceRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/BulkSoftDeleteWorkspaceRequestDto'
          description: Delete workspaces in bulk request
      additionalProperties: false
      description: Service request data
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    CreateWorkspaceResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateWorkspaceResponseDto'
          description: Response DTO representing created Workspace
        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
    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
    UpdateWorkspaceRequestDto:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 60
          minLength: 1
          type: string
          description: Name of Workspace
          example: Global configurators
        description:
          maxLength: 255
          type:
          - string
          - 'null'
          description: Description of Workspace
          example: Workspace for global configurators.
      additionalProperties: false
      description: Update workspace request
    AvailableWorkspaceItemResponseDto:
      type: object
      properties:
        workspaceId:
          type: string
          description: Unique identifier of Workspace
          format: uuid
          example: 46b34a29-d426-407e-b1cc-98d727ed4883
        name:
          type:
          - string
          - 'null'
          description: Name of Workspace
          example: Global configurators
        description:
          type:
          - string
          - 'null'
          description: Description of Workspace
          example: Workspace created to implement Commercial Banking features
        group:
          allOf:
          - $ref: '#/components/schemas/AvailableWorkspaceGroup'
          description: Group of Workspace
          example: ContainsChanges
      additionalProperties: false
      description: Workspace DTO
    WorkspaceChangeListItemViewModelDtoItemsPage:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WorkspaceChangeListItemViewModelDto'
          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
    WorkspaceChangeListItemViewModelDtoItemsPageServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/WorkspaceChangeListItemViewModelDtoItemsPage'
          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
    ActiveWorkspaceViewModelDtoItemsPageServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ActiveWorkspaceViewModelDtoItemsPage'
          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
    AvailableWorkspaceItemResponseDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AvailableWorkspaceItemResponseDto'
          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
    ActiveWorkspaceViewModelDtoItemsPage:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ActiveWorkspaceViewModelDto'
          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
    ActiveWorkspaceViewModelDto:
      type: object
      properties:
        workspaceId:
          type: string
          description: Unique identifier of Workspace
          format: uuid
          example: 46b34a29-d426-407e-b1cc-98d727ed4883
        name:
          type:
          - string
          - 'null'
          description: Name of Workspace
          example: Global configurators
        description:
          type:
          - string
          - 'null'
          description: Description of Workspace
          example: Workspace for global configurators.
      additionalProperties: false
      description: Workspace DTO
    GetCurrentWorkspaceResponseDto:
      required:
      - workspaceId
      type: object
      properties:
        workspaceId:
          type: string
          description: Unique identifier of Workspace
          format: uuid
          example: 46b34a29-d426-407e-b1cc-98d727ed4883
      additionalProperties: false
      description: Represents user preferred workspace
    GetCurrentWorkspaceResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetCurrentWorkspaceResponseDto'
          description: Represents user preferred workspace
        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
    WorkspaceChangeListItemViewModelDto:
      type: object
      properties:
        entityPolicyId:
          type: string
          description: Unique identifier of policy
          format: uuid
          example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b
        resourceType:
          enum:
          - Jurisdiction
          - Field
          - Document
          - eSignature Document
          - Related Party
          type:
          - string
          - 'null'
          description: Type of the entity that the policy is applied to
          example: Jurisdiction
        resourceId:
          type: string
          description: ID of the resource
          format: uuid
          example: 80e92251-db0c-47e0-8e50-490d4bd1db6e
        name:
          type:
          - string
          - 'null'
          description: Name of the resource
          example: Global
        changeType:
          enum:
          - Added
          - Updated
          - Deleted
          type:
          - string
          - 'null'
          description: Change Type of the resource
          example: Unchanged
        lastUpdatedBy:
          type:
          - string
          - 'null'
          description: Identifier of the user who last updated the resource
        lastUpdatedOn:
          type: string
          description: The date and time when the policy or resource was last updated.
          format: date-time
          example: '2023-10-05T14:30:00Z'
      additionalProperties: false
      description: Represents a change in the workspace
    AvailableWorkspaceGroup:
      enum:
      - NoChanges
      - PendingRemoval
      - ContainsChanges
      - LockedPendingReview
      type: string
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-policycommand-v2-0-openapi.json
- fenergo-policyquery-v4-0-openapi.json