{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Dashboards Query (PENDING DEPRECATION)", "description": "!!! IMPORTANT NOTICE: \nThis API is pending deprecation and will be removed on 28.02.2026. For more information visit: https://docs.fenergox.com/notice-of-change/2025/07/22/legacy-dashboards-deprecation \n\nDashboards Query API is part of FenX eco-system to manage Dashboards. All the operations require valid access token obtained from Identity service.", "version": "1.0.0" }, "servers": [ { "url": "/dashboardsquery" } ], "paths": { "/api/journey-dashboard": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get in progress journeys assigned to the specified team.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetTeamJourneyDashboard", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } }, "deprecated": true } }, "/api/journey-dashboard/lite": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get in progress journeys assigned to the specified team without tasks.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetTeamJourneyDashboardLite", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } }, "deprecated": true } }, "/api/journey-dashboard/preview": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get in progress journeys assigned to the specified team without tasks.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetTeamJourneyDashboardPreview", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/journey-dashboard/journeys": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get in progress journeys assigned to the specified team without tasks.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetTeamJourneys", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/journey-dashboard/journeys/entity/{entityId}": { "get": { "tags": [ "JourneyDashboard" ], "summary": "Get all journeys for a given entity", "description": "

Required permissions:
Following permissions are required: JourneyAccess", "operationId": "GetEntityJourneys", "parameters": [ { "name": "entityId", "in": "path", "description": "The UiD of the entity", "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": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } } } } }, "/api/journey-dashboard/tasks/{journeyId}": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get tasks for given journey", "description": "

Required permissions:
At least one of the following permissions is required: TeamDashboardAccess, JourneyAccess", "operationId": "GetJourneyTasks", "parameters": [ { "name": "journeyId", "in": "path", "description": "", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Tasks for specified journey are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyTaskDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/journey-dashboard/journeyMilestonesTasks/{journeyId}": { "post": { "tags": [ "JourneyDashboard" ], "summary": "Get journey milestones with tasks for given journey", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "getJourneyMilestonesTasks", "parameters": [ { "name": "journeyId", "in": "path", "description": "", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Tasks for specified journey are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyMilestonesTasksDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/journey-stats": { "post": { "tags": [ "JourneyStats" ], "summary": "Get journey stats like number of journeys completed or average journey time.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetJourneyStatsDashboard", "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": "Request object that contains a list of teams and date range for which the data is requested. Available range values: Daily, RollingSeven, RollingThirty", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyStatsDashboardRequestDtoServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Stats dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyStatsDashboardResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/task-queue/{userId}": { "get": { "tags": [ "TaskQueueDashboard" ], "summary": "Get tasks assigned to the specified user.", "description": "

Required permissions:
At least one of the following permissions is required: TeamDashboardAccess, TaskDashboardAccess", "operationId": "GetUserTasksDashboard", "parameters": [ { "name": "userId", "in": "path", "description": "", "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": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskQueueDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/task-queue/favourites/{userId}": { "get": { "tags": [ "TaskQueueDashboard" ], "summary": "Get favourite tasks assigned to the specified user.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetFavouriteTasksDashboard", "parameters": [ { "name": "userId", "in": "path", "description": "", "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": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskQueueDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/team-tasks": { "post": { "tags": [ "TeamTasks" ], "summary": "Get team tasks dashboard", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetTeamTasksDashboard", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Team tasks dashboard is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamTasksCountSummaryItemDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/unassigned-task": { "post": { "tags": [ "UnassignedTasks" ], "summary": "Get unassigned tasks assigned to the specified team.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetUnassignedTasksDashboard", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Unassigned task dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignedTasksDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } }, "deprecated": true } }, "/api/unassigned-task/preview": { "post": { "tags": [ "UnassignedTasks" ], "summary": "Get unassigned tasks assigned to the specified team.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetUnassignedTasksDashboardPreview", "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } } }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Unassigned task dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignedTasksDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/unassigned-task/tasks": { "post": { "tags": [ "UnassignedTasks" ], "summary": "Get unassigned tasks assigned to the specified team.", "description": "

Required permissions:
Following permissions are required: TeamDashboardAccess", "operationId": "GetUserUnassignedTasks", "parameters": [ { "name": "status", "in": "query", "description": "Task status", "schema": { "$ref": "#/components/schemas/UnassignedTaskStatus" }, "example": "InProgress" }, { "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": "List of team IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceRequest" } } }, "required": true }, "responses": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Unassigned task dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignedTasksDtoListServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } }, "/api/user-journey-dashboard/{userId}": { "get": { "tags": [ "UserJourneyDashboard" ], "summary": "Get journeys with tasks assigned to the specified user.", "description": "

Required permissions:
Following permissions are required: TaskDashboardAccess", "operationId": "GetUserJourneyDashboard", "parameters": [ { "name": "userId", "in": "path", "description": "", "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": { "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "The amount of data requested is too large. Please request smaller data set.", "type": "Error", "errorCode": "PAYLOAD_TOO_LARGE" } ] } } } }, "200": { "description": "Success. Journey dashboard for specified criteria is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserJourneyDashboardDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } } } } } }, "components": { "schemas": { "ChartPoint": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardRange": { "enum": [ "Daily", "RollingSeven", "RollingThirty" ], "type": "string" }, "JourneyDashboardDto": { "type": "object", "properties": { "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/JourneySummaryDto" }, "nullable": true } }, "additionalProperties": false }, "JourneyDashboardDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JourneyDashboardDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "JourneyMilestoneDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/MilestoneStageDto" }, "nullable": true } }, "additionalProperties": false }, "JourneyMilestonesTasksDto": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "nullable": true }, "milestones": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyMilestoneDto" }, "nullable": true } }, "additionalProperties": false }, "JourneyMilestonesTasksDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JourneyMilestonesTasksDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "JourneyOwnerDto": { "type": "object", "properties": { "teamId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid", "nullable": true }, "ownerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JourneyStatsDashboardRequestDto": { "type": "object", "properties": { "teamIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dashboardRange": { "$ref": "#/components/schemas/DashboardRange" } }, "additionalProperties": false }, "JourneyStatsDashboardRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JourneyStatsDashboardRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "JourneyStatsDashboardResponseDto": { "type": "object", "properties": { "journeysStartedCountPoints": { "type": "array", "items": { "$ref": "#/components/schemas/ChartPoint" }, "nullable": true }, "journeysCompletedPoints": { "type": "array", "items": { "$ref": "#/components/schemas/ChartPoint" }, "nullable": true }, "journeyAverageTimePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ChartPoint" }, "nullable": true }, "journeysStartedDiff": { "type": "number", "format": "double" }, "journeysCompletedDiff": { "type": "number", "format": "double" }, "journeysStartedToday": { "type": "integer", "format": "int32" }, "journeysCompletedToday": { "type": "integer", "format": "int32" }, "journeyAverageTimeToday": { "type": "number", "format": "double" }, "journeyAverageTimeDiff": { "type": "number", "format": "double" } }, "additionalProperties": false }, "JourneyStatsDashboardResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JourneyStatsDashboardResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "JourneyStatsDto": { "type": "object", "properties": { "completed": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "progress": { "type": "number", "format": "float" } }, "additionalProperties": false }, "JourneySummaryDto": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "journeyName": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "progress": { "type": "number", "format": "double" }, "status": { "type": "string", "nullable": true }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "nullable": true }, "daysOpen": { "type": "string", "nullable": true }, "slaPeriod": { "type": "string", "nullable": true }, "teams": { "type": "array", "items": { "type": "string" }, "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "paused": { "type": "string", "format": "date-time", "nullable": true }, "priority": { "type": "array", "items": { "type": "string" }, "nullable": true }, "entityGeographicAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "entityBusinessAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "journeyGeographicAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "journeyBusinessAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "milestones": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyMilestoneDto" }, "nullable": true }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" }, "journeyOwner": { "$ref": "#/components/schemas/JourneyOwnerDto" }, "customStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JourneyTaskDto": { "type": "object", "properties": { "taskId": { "type": "string", "format": "uuid" }, "taskName": { "type": "string", "nullable": true }, "assignedTeamId": { "type": "string", "nullable": true }, "assignedTeam": { "type": "string", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "journeyId": { "type": "string", "nullable": true }, "daysOpen": { "type": "string", "nullable": true }, "slaPeriod": { "type": "string", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "paused": { "type": "string", "format": "date-time", "nullable": true }, "unpaused": { "type": "string", "format": "date-time", "nullable": true }, "taskType": { "type": "string", "nullable": true }, "assignedTo": { "type": "string", "nullable": true }, "assignedToId": { "type": "string", "nullable": true }, "isFavourite": { "type": "boolean" }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" } }, "additionalProperties": false }, "JourneyTaskDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "MilestoneStageDto": { "type": "object", "properties": { "stageId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "paused": { "type": "string", "format": "date-time", "nullable": true }, "statistics": { "$ref": "#/components/schemas/JourneyStatsDto" }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceLevelAgreementDto": { "type": "object", "properties": { "committedHours": { "type": "integer", "format": "int32", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "approachingDueHours": { "type": "integer", "format": "int32", "nullable": true }, "approachingDueDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "duePeriod": { "type": "string", "nullable": true }, "pausedPeriodSec": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\r\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "StringListServiceRequest": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "TaskQueueDto": { "type": "object", "properties": { "clientName": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskName": { "type": "string", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "journeyId": { "type": "string", "nullable": true }, "assignedTeamId": { "type": "string", "nullable": true }, "daysOpen": { "type": "string", "nullable": true }, "slaPeriod": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "isFavourite": { "type": "boolean" }, "startedDate": { "type": "string", "format": "date-time", "nullable": true }, "pausedDate": { "type": "string", "format": "date-time", "nullable": true }, "unpausedDate": { "type": "string", "format": "date-time", "nullable": true }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" }, "isConditional": { "type": "boolean" } }, "additionalProperties": false }, "TaskQueueDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskQueueDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "TeamTasksCountSummaryItemDto": { "type": "object", "properties": { "teamName": { "type": "string", "nullable": true }, "notStartedCount": { "type": "integer", "format": "int32" }, "startedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TeamTasksCountSummaryItemDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamTasksCountSummaryItemDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UnassignedTaskStatus": { "enum": [ "InProgress", "NotStarted", "Paused" ], "type": "string" }, "UnassignedTasksDto": { "type": "object", "properties": { "taskId": { "type": "string", "nullable": true }, "taskName": { "type": "string", "nullable": true }, "taskType": { "type": "string", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "journeyId": { "type": "string", "nullable": true }, "journeyName": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "assignedTeamId": { "type": "string", "nullable": true }, "assignedTeamName": { "type": "string", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "paused": { "type": "string", "format": "date-time", "nullable": true }, "unpaused": { "type": "string", "format": "date-time", "nullable": true }, "entityGeographicAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "entityBusinessAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "journeyGeographicAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "journeyBusinessAccessLayers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "daysOpen": { "type": "string", "nullable": true }, "slaPeriod": { "type": "string", "nullable": true }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" } }, "additionalProperties": false }, "UnassignedTasksDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UnassignedTasksDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserJourneyDashboardDto": { "type": "object", "properties": { "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/UserJourneySummaryDto" }, "nullable": true } }, "additionalProperties": false }, "UserJourneyDashboardDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserJourneyDashboardDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserJourneySummaryDto": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "journeyName": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "progress": { "type": "number", "format": "double" }, "status": { "type": "string", "nullable": true }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTaskDto" }, "nullable": true }, "daysOpen": { "type": "string", "nullable": true }, "slaPeriod": { "type": "string", "nullable": true }, "started": { "type": "string", "format": "date-time" }, "paused": { "type": "string", "format": "date-time", "nullable": true }, "yourNextTask": { "$ref": "#/components/schemas/JourneyTaskDto" }, "milestones": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyMilestoneDto" }, "nullable": true }, "serviceLevelAgreement": { "$ref": "#/components/schemas/ServiceLevelAgreementDto" }, "journeyOwner": { "$ref": "#/components/schemas/JourneyOwnerDto" }, "customStatus": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }