Invendor OperationDimGroups API

openapi: 3.0.1
info:
  title: IO.Common Accounts OperationDimGroups API
  version: '1.0'
security:
- OAuth2: []
tags:
- name: OperationDimGroups
paths:
  /v1/OperationDimGroups:
    get:
      tags:
      - OperationDimGroups
      summary: Get list of operation dimension groups. Used for grouping metadata for different validation rule groups
      operationId: Get operation dimension groups
      parameters:
      - name: Filter
        in: query
        schema:
          type: string
      - name: Page
        in: query
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: SortColumn
        in: query
        schema:
          type: string
      - name: SortOrder
        in: query
        schema:
          type: string
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationDimGroupResponsePagedResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
    post:
      tags:
      - OperationDimGroups
      summary: Create operation metadata (dimension) group
      operationId: Create operation dimension group
      parameters:
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateOperationDimGroupRequest'
          application/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateOperationDimGroupRequest'
          text/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateOperationDimGroupRequest'
          application/*+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/CreateOperationDimGroupRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ResourceCreatedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
  /v1/OperationDimGroups/{id}:
    get:
      tags:
      - OperationDimGroups
      summary: Get operation dimension group. Used for grouping metadata for different validation rule groups
      operationId: Get operation dimension group
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationDimGroupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
    put:
      tags:
      - OperationDimGroups
      summary: Update operation metadata (dimension) group
      operationId: Update operation dimension group
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      requestBody:
        description: ''
        content:
          application/json-patch+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateOperationDimGroupRequest'
          application/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateOperationDimGroupRequest'
          text/json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateOperationDimGroupRequest'
          application/*+json; x-api-version=1.0:
            schema:
              $ref: '#/components/schemas/UpdateOperationDimGroupRequest'
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ResourceCreatedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
    delete:
      tags:
      - OperationDimGroups
      summary: Delete operation metadata (dimension) group
      operationId: Delete operation dimension group
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: integer
          format: int32
      - name: Account
        in: query
        description: Account
        schema:
          title: Account
          type: int
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ResourceCreatedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.common
components:
  schemas:
    OperationDimGroupResponsePagedResult:
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        totalCount:
          type: integer
          format: int32
          readOnly: true
        filteredCount:
          type: integer
          format: int32
          readOnly: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/OperationDimGroupResponse'
          nullable: true
          readOnly: true
      additionalProperties: false
    OperationDimGroupResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
          nullable: true
        validationRule:
          $ref: '#/components/schemas/ValidationRulesEnum'
      additionalProperties: false
    Int32ResourceCreatedResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
    ApiErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          nullable: true
      additionalProperties: false
    UpdateOperationDimGroupRequest:
      type: object
      properties:
        name:
          type: string
          nullable: true
        validationRule:
          $ref: '#/components/schemas/ValidationRulesEnum'
      additionalProperties: false
    CreateOperationDimGroupRequest:
      type: object
      properties:
        name:
          type: string
          nullable: true
        validationRule:
          $ref: '#/components/schemas/ValidationRulesEnum'
      additionalProperties: false
    ValidationRulesEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
      format: int32
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://identity.scanbro.com/connect/authorize
          tokenUrl: https://identity.scanbro.com/connect/token
          scopes:
            io.common: default scope