openapi: 3.2.0 info: title: Fenergo Bulk Actions API version: '1.0' description: 'Operations tagged BulkActions across 2 of this provider''s published API definitions: fenergo-advanceddashboardcommand-v1-0-openapi.json, fenergo-advanceddashboardquery-v1-0-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /advanceddashboardcommand - url: /advanceddashboardquery security: - Bearer: [] tags: - name: Bulk Actions paths: /api/bulk-actions: post: tags: - Bulk Actions summary: Create Bulk Action description: 'Creates Bulk Action for provided tasks. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: CreateBulkAction 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: Fenergo.Nebula.Dashboard.Advanced.Command.Application.Dto.BulkActions.CreateBulkActionRequestDto class that represents Create Bulk Action request. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateBulkActionRequestDtoServiceRequest' responses: '202': description: Success. Bulk Action created content: application/json: schema: $ref: '#/components/schemas/CreateBulkActionResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '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: /advanceddashboardcommand /api/bulk-actions/{actionId}/execute: post: tags: - Bulk Actions summary: Execute Bulk Action description: 'Executes Bulk Action. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: ExecuteBulkAction parameters: - name: actionId in: path description: Action ID 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: description: Fenergo.Nebula.Dashboard.Advanced.Command.Application.Dto.BulkActions.ExecuteBulkActionRequestDto class that represents Execute Bulk Action request. content: application/json: schema: allOf: - $ref: '#/components/schemas/ExecuteBulkActionRequestDtoServiceRequest' responses: '202': description: Success. Bulk Action executed content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '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: /advanceddashboardcommand /api/bulk-actions/{actionId}/dismiss: post: tags: - Bulk Actions summary: Dismiss Bulk Action description: 'Dismisses the specified Bulk Action. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: DismissBulkAction parameters: - name: actionId in: path description: Action ID 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: '202': description: Success. Bulk Action dismissed content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '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: /advanceddashboardcommand /api/bulk-actions/{actionId}: get: tags: - Bulk Actions summary: Returns Bulk Task Completion Action description: 'Returns Bulk Task Completion Action by provided ID. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: GetBulkAction parameters: - name: actionId in: path description: Action ID. 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. Bulk Task Completion Action returned content: application/json: schema: $ref: '#/components/schemas/BulkActionDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Bulk Task Completion Action with given id does not exist type: Error errorCode: Error Code '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: /advanceddashboardquery /api/bulk-actions/{actionId}/requirements: get: tags: - Bulk Actions summary: Returns Bulk Task Completion Action requirements description: 'Returns Bulk Task Completion Action requirements by provided action ID. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: GetBulkActionRequirements parameters: - name: actionId in: path description: Action ID. 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. Bulk Task Completion Action returned content: application/json: schema: $ref: '#/components/schemas/GetBulkActionRequirementsResponseDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Bulk Task Completion Action with given id does not exist, or it doesn't have associated requirements. type: Error errorCode: Error Code '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: /advanceddashboardquery /api/bulk-actions/active: get: tags: - Bulk Actions summary: Retrieves the status of an active bulk action request description: 'Returns the ID, status, and error count of an active bulk action request. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: GetActiveBulkAction 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. The active bulk action request details were returned. content: application/json: schema: $ref: '#/components/schemas/ActiveBulkActionDtoServiceResponse' '400': description: Bad Request. The request parameters are invalid. 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: /advanceddashboardquery /api/bulk-actions/{actionId}/results: get: tags: - Bulk Actions summary: Retrieves the results of a bulk action request by its ID description: 'Returns a collection of bulk action results, including status and error details. Required permissions: Following permissions are required: TaskBulkCompletion' operationId: GetBulkActionResultsByActionId parameters: - name: actionId in: path description: The unique identifier of the bulk action request. 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. The bulk action results were returned. content: application/json: schema: $ref: '#/components/schemas/BulkActionResultsDtoIEnumerableServiceResponse' '400': description: Bad Request. The request parameters are invalid. 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: /advanceddashboardquery components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code CreateBulkActionResponseDto: type: object properties: actionId: type: string format: uuid additionalProperties: false CreateBulkActionRequestDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/CreateBulkActionRequestDto' additionalProperties: false ExecuteBulkActionRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ExecuteBulkActionRequestDto' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false BulkActionType: enum: - Save - Complete - SaveAndComplete type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false CreateBulkActionRequestDto: type: object properties: taskIds: type: - array - 'null' items: type: string format: uuid additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExecuteBulkActionRequestDto: type: object properties: executionType: allOf: - $ref: '#/components/schemas/BulkActionType' propertyValues: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateBulkActionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateBulkActionResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GetBulkActionRequirementsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetBulkActionRequirementsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BulkActionStatus: enum: - Created - Initializing - Ready - Running - Completed - Failed type: string BulkActionResultsDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BulkActionResultsDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BulkActionItemResult: type: object properties: type: allOf: - $ref: '#/components/schemas/BulkActionItemResultType' reason: allOf: - $ref: '#/components/schemas/BulkActionItemResultReason' isSuccess: type: boolean readOnly: true additionalProperties: false BulkActionRequirementDto: type: object properties: name: type: - string - 'null' propertyName: type: - string - 'null' propertyType: type: - string - 'null' propertyTypeId: type: - string - 'null' description: type: - string - 'null' order: type: - number - 'null' format: double additionalProperties: false BulkActionItemResultType: enum: - Completed - Skipped - Error type: string BulkActionItemErrorDetail: type: object properties: errorCode: type: - string - 'null' description: type: - string - 'null' additionalInformation: type: - string - 'null' additionalProperties: false BulkActionResultsDto: type: object properties: taskId: type: string format: uuid taskName: type: - string - 'null' journeyId: type: string format: uuid entityName: type: - string - 'null' entityId: type: string format: uuid canBeCompleted: type: boolean result: allOf: - $ref: '#/components/schemas/BulkActionItemResult' errors: type: - array - 'null' items: $ref: '#/components/schemas/BulkActionItemErrorDetail' additionalProperties: false BulkActionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/BulkActionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BulkActionDto: type: object properties: id: type: string format: uuid userId: type: - string - 'null' createdAt: type: string format: date-time completedAt: type: - string - 'null' format: date-time status: allOf: - $ref: '#/components/schemas/BulkActionStatus' additionalProperties: false GetBulkActionRequirementsResponseDto: type: object properties: requirements: type: - array - 'null' items: $ref: '#/components/schemas/BulkActionRequirementDto' canCompleteTasks: type: boolean additionalProperties: false BulkActionItemResultReason: enum: - FailedToFetch - MissingBulkCompletionFlag - MissingPolicyCategory - NoCommonPolicyCategory - InvalidPolicyTarget - InvalidRequirementType - InvalidTaskStatus - ValidationError - UnknownError - UserNotAuthorized type: string ActiveBulkActionDto: type: object properties: id: type: string format: uuid status: allOf: - $ref: '#/components/schemas/BulkActionStatus' errorCount: type: integer format: int32 warningCount: type: integer format: int32 isDismissed: type: boolean additionalProperties: false ActiveBulkActionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ActiveBulkActionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-advanceddashboardcommand-v1-0-openapi.json - fenergo-advanceddashboardquery-v1-0-0-openapi.json