openapi: 3.0.1 info: title: IO.Common Accounts DimensionValues API version: '1.0' security: - OAuth2: [] tags: - name: DimensionValues paths: /v1/Dimensions/{dimId}/values: get: tags: - DimensionValues summary: Get dimensions values operationId: Get dimension values parameters: - name: dimId in: path description: Dimension Id required: true schema: type: integer format: int32 - 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: type: array items: $ref: '#/components/schemas/DimensionValueResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common post: tags: - DimensionValues summary: Create dimension value operationId: CreateDimensionValue parameters: - name: dimId in: path description: Dimension id required: true schema: type: integer format: int32 - name: Account in: query description: Account schema: title: Account type: int requestBody: description: Collection of values to create content: application/json-patch+json; x-api-version=1.0: schema: $ref: '#/components/schemas/CreateDimensionValueRequest' application/json; x-api-version=1.0: schema: $ref: '#/components/schemas/CreateDimensionValueRequest' text/json; x-api-version=1.0: schema: $ref: '#/components/schemas/CreateDimensionValueRequest' application/*+json; x-api-version=1.0: schema: $ref: '#/components/schemas/CreateDimensionValueRequest' responses: '201': description: Created content: application/json: schema: type: integer format: int32 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common put: tags: - DimensionValues summary: Update dimension value operationId: UpdateDimensionValue parameters: - name: dimId in: path description: Dimension id required: true schema: type: integer format: int32 - name: Account in: query description: Account schema: title: Account type: int requestBody: description: Collection of values to create content: application/json-patch+json; x-api-version=1.0: schema: $ref: '#/components/schemas/UpdateDimensionValueRequest' application/json; x-api-version=1.0: schema: $ref: '#/components/schemas/UpdateDimensionValueRequest' text/json; x-api-version=1.0: schema: $ref: '#/components/schemas/UpdateDimensionValueRequest' application/*+json; x-api-version=1.0: schema: $ref: '#/components/schemas/UpdateDimensionValueRequest' responses: '200': description: Success '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common /v1/Dimensions/{dimId}/values/{valueId}: get: tags: - DimensionValues summary: Get dimensions value details operationId: GetDimensionValue parameters: - name: dimId in: path description: Dimension Id required: true schema: type: integer format: int32 - name: valueId in: path description: Dimension value Id 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/DimensionValueResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common /v1/Dimensions/{dimId}/values/{valueId}/parents: get: tags: - DimensionValues summary: Get dimensions value parents operationId: GetDimensionValueParents parameters: - name: dimId in: path description: Dimension Id required: true schema: type: integer format: int32 - name: valueId in: path description: Dimension value id required: true schema: type: integer format: int32 - 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/DimensionValueRelResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common /v1/Dimensions/{dimId}/values/{valueId}/children: get: tags: - DimensionValues summary: Get dimensions value children operationId: GetDimensionValueChildren parameters: - name: dimId in: path description: Dimension Id required: true schema: type: integer format: int32 - name: valueId in: path description: Dimension value id required: true schema: type: integer format: int32 - 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/DimensionValueRelResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common post: tags: - DimensionValues summary: Save dimension value children. Full list of children is excpected. operationId: SaveDimensionValueChildren parameters: - name: dimId in: path description: Dimension id required: true schema: type: integer format: int32 - name: valueId in: path description: Parent value id required: true schema: type: integer format: int32 - name: Account in: query description: Account schema: title: Account type: int requestBody: description: List of child value ids content: application/json-patch+json; x-api-version=1.0: schema: type: array items: type: integer format: int32 application/json; x-api-version=1.0: schema: type: array items: type: integer format: int32 text/json; x-api-version=1.0: schema: type: array items: type: integer format: int32 application/*+json; x-api-version=1.0: schema: type: array items: type: integer format: int32 responses: '200': description: Success '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common /v1/Dimensions/{dimId}/values/bulk: post: tags: - DimensionValues summary: Create dimensions values BULK operationId: CreateDimensionValuesBulk parameters: - name: dimId in: path description: Dimension id required: true schema: type: integer format: int32 - name: Account in: query description: Account schema: title: Account type: int requestBody: description: Collection of values to create content: application/json-patch+json; x-api-version=1.0: schema: type: array items: $ref: '#/components/schemas/CreateDimensionValueRequest' application/json; x-api-version=1.0: schema: type: array items: $ref: '#/components/schemas/CreateDimensionValueRequest' text/json; x-api-version=1.0: schema: type: array items: $ref: '#/components/schemas/CreateDimensionValueRequest' application/*+json; x-api-version=1.0: schema: type: array items: $ref: '#/components/schemas/CreateDimensionValueRequest' responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common delete: tags: - DimensionValues summary: Delete dimensions values BULK operationId: DeleteDimensionValuesBulk parameters: - name: dimId in: path required: true schema: type: integer format: int32 - name: Account in: query description: Account schema: title: Account type: int requestBody: description: Collection of value ids to delete content: application/json-patch+json; x-api-version=1.0: schema: uniqueItems: true type: array items: type: integer format: int32 application/json; x-api-version=1.0: schema: uniqueItems: true type: array items: type: integer format: int32 text/json; x-api-version=1.0: schema: uniqueItems: true type: array items: type: integer format: int32 application/*+json; x-api-version=1.0: schema: uniqueItems: true type: array items: type: integer format: int32 responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized '403': description: Forbidden security: - OAuth2: - io.common components: schemas: UpdateDimensionValueRequest: type: object properties: id: type: integer format: int32 dimensionId: type: integer format: int32 key: type: string nullable: true value: type: string nullable: true properties: type: object additionalProperties: type: string nullable: true additionalProperties: false DimensionValueRelResponse: type: object properties: id: type: integer format: int32 key: type: string nullable: true value: type: string nullable: true hasParents: type: boolean hasChildren: type: boolean properties: type: object additionalProperties: type: string nullable: true dimensionId: type: integer format: int32 dimensionName: type: string nullable: true additionalProperties: false DimensionValueResponse: type: object properties: id: type: integer format: int32 key: type: string nullable: true value: type: string nullable: true hasParents: type: boolean hasChildren: type: boolean properties: type: object additionalProperties: type: string nullable: true 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 CreateDimensionValueRequest: type: object properties: key: type: string nullable: true value: type: string nullable: true properties: type: object additionalProperties: type: string nullable: true additionalProperties: false 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