Invendor Operations API
The Operations API from Invendor — 18 operation(s) for operations.
The Operations API from Invendor — 18 operation(s) for operations.
openapi: 3.0.1
info:
title: IO.Common Accounts Operations API
version: '1.0'
security:
- OAuth2: []
tags:
- name: Operations
paths:
/v1/Operations/types:
get:
tags:
- Operations
summary: Get list of possible generic operation types
operationId: Get generic operation types
parameters:
- 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/GenericOperationType'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations:
get:
tags:
- Operations
summary: Get all the available operations for an account
operationId: Get operations list
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/OperationResponsePagedResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Operations
summary: Create base operation - usable and visible to all the accounts
operationId: Create base operation
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/CreateBaseOperationRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateBaseOperationRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateBaseOperationRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateBaseOperationRequest'
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/Operations/{id}:
get:
tags:
- Operations
summary: Get operation details
operationId: Get operation details
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/OperationDetailsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
put:
tags:
- Operations
summary: Update operation details
operationId: Update operation details
parameters:
- name: id
in: path
description: Opeartion Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: UpdateOperationDetailsRequest DTO
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDetailsRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDetailsRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDetailsRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDetailsRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
delete:
tags:
- Operations
summary: Delete operation
operationId: Delete operation
parameters:
- name: id
in: path
description: Opeartion Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/properties:
get:
tags:
- Operations
summary: Get the list of all the properties added to operations
operationId: GetAllUsedOperationProperties
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/definedProperties:
get:
tags:
- Operations
summary: Get the defined properties for operations
operationId: Get defined properties for operations
parameters:
- 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/GetDefinedPropertyParametersResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Operations
summary: Create new operation property with parameters
operationId: Create operation defined property with parameters
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/CreateDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
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/Operations/definedProperties/{id}:
put:
tags:
- Operations
summary: Update existing operation property with parameters
operationId: Update operation defined property with parameters
parameters:
- name: id
in: path
description: Property parameter Id
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/UpdateDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
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
delete:
tags:
- Operations
summary: Delete existing operation property with parameters
operationId: Delete operation defined propety with parameters
parameters:
- name: id
in: path
description: Property parameter Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
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/Operations/definedProperties/bulk:
post:
tags:
- Operations
summary: Bulk upsert/delete operation properties with parameters
operationId: Create or update operation defined propeties with parameters
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:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
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/Operations/extend:
post:
tags:
- Operations
summary: Create account specific extended operation from base operation.
operationId: Create extended operation
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/CreateExtendedOperationRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateExtendedOperationRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateExtendedOperationRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateExtendedOperationRequest'
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/Operations/{operationId}/unique-item-statuses:
put:
tags:
- Operations
summary: Update the Issue / Receive unique-item status assignments for an operation.
operationId: Update operation unique-item statuses
parameters:
- name: operationId
in: path
description: Operation Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: Unique-item status assignments (both nullable; null clears).
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationUniqueItemStatusesRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationUniqueItemStatusesRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationUniqueItemStatusesRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationUniqueItemStatusesRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/{operationId}/operation-flags:
put:
tags:
- Operations
summary: "Bulk-replace the per-operation flag configuration. PUT semantics: the body\r\nlists every desired `(FlagTypeId, FlagActionType)` tuple; missing rows\r\nare deleted, new rows are added, intersections are kept untouched. Rejects\r\nany payload that declares both `Raise` and `Clear` for the same\r\n`FlagTypeId`. Feature-gated on `\"UNIQUE_ITEMS\"`."
operationId: Update operation flags (bulk replace)
parameters:
- name: operationId
in: path
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationFlagsRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationFlagsRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationFlagsRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationFlagsRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/{opId}/dimensions:
get:
tags:
- Operations
summary: Get operation dimensions
operationId: Get operation dimensions
parameters:
- name: opId
in: path
description: ''
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/OperationDimensionResponsePagedResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Operations
summary: Add operation dimension
operationId: Create operation dimensions
parameters:
- name: opId
in: path
description: Operation id
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/CreateOperationDimensionRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateOperationDimensionRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateOperationDimensionRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateOperationDimensionRequest'
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
put:
tags:
- Operations
summary: Bulk update operation dimensions
operationId: Update operation dimensions (bulk)
parameters:
- name: opId
in: path
description: Operation Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: Collection of operation dimensions to update
content:
application/json-patch+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpdateOperationDimensionRequest'
application/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpdateOperationDimensionRequest'
text/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpdateOperationDimensionRequest'
application/*+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpdateOperationDimensionRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/dimensions/properties:
get:
tags:
- Operations
summary: Get the list of all the properties added to operations
operationId: GetAllUsedOperationDimProperties
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/{opId}/dimensions/{id}:
put:
tags:
- Operations
summary: Update operation dimension
operationId: Update operation dimension
parameters:
- name: opId
in: path
description: Operation Id
required: true
schema:
type: integer
format: int32
- name: id
in: path
description: Operation dimension Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: Operation dimension update request
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDimensionRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDimensionRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDimensionRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateOperationDimensionRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
delete:
tags:
- Operations
summary: Remove operation dimension
operationId: Remove operation dimensions
parameters:
- name: opId
in: path
description: OperationId
required: true
schema:
type: integer
format: int32
- name: id
in: path
description: Operation dimension Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Operations/{id}/questions:
get:
tags:
- Operations
summary: Get operation questons
operationId: Get operation questions
parameters:
- name: id
in: path
description: Operation 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/OperationQuestionResponsePagedResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Operations
summary: Add operation question
operationId: Add operation questions
parameters:
- name: id
in: path
description: Operation id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: Request payload
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/AddOperationQuestionRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/AddOperationQuestionRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/AddOperationQuestionRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/AddOperationQuestionRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
put:
tags:
- Operations
summary: Bulk update operation questions
operationId: Bulk update operation questions
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: List of operation questions update requests
content:
application/json-patch+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateOperationQuestionRequest'
application/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateOperationQuestionRequest'
text/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateOperationQuestionRequest'
application/*+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UpdateOperationQuestionRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorRe
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/invendor/refs/heads/main/openapi/invendor-operations-api-openapi.yml