openapi: 3.2.0 info: title: Fenergo Dashboard API version: '4.0' description: 'Operations tagged Dashboard across 2 of this provider''s published API definitions: fenergo-portaltenantcommand-v4-0-openapi.json, fenergo-portaltenantquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /portaltenantcommand - url: /portaltenantquery security: - Bearer: [] tags: - name: Dashboard paths: /api/dashboard/entitytypedashboardconfig: put: tags: - Dashboard summary: Upserts dashboard config with fields grouped by entity type description: 'Upserts dashboard config with fields grouped by entity type. Required permissions: Following permissions are required: DashboardEdit' operationId: UpsertEntityTypeDashboardConfig 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: EntityTypeDashboardConfigDto dto content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Command.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel__Fenergo.Nebula.Platform.Core.Models__Version_4.0.0.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' '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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantcommand /api/dashboard/dashboardconfig/{id}: get: tags: - Dashboard summary: Gets dashboard config with the corresponding Id description: 'This endpoint is obsolete and was terminated on 2024-08-27. Use /api/dashboard/entitytypedashboardconfig/{id} instead. Required permissions: Following permissions are required: DashboardAccess' operationId: GetDashboardConfigById parameters: - name: id in: path description: The Dashboard Config identifier. required: true schema: type: string - 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: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT deprecated: true servers: - url: /portaltenantquery /api/dashboard/entitytypedashboardconfig/{id}: get: tags: - Dashboard summary: Gets dashboard config with the corresponding Id returning fields grouped by… description: 'Required permissions: Following permissions are required: DashboardAccess' operationId: GetEntityTypeDashboardConfigById parameters: - name: id in: path description: The Dashboard Config identifier. required: true schema: type: string - 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: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/dashboard/dashboardconfigs: get: tags: - Dashboard summary: Gets dashboard configs description: 'Required permissions: At least one of the following permissions is required: UserRoleAccess, DashboardAccess' operationId: GetDashboardConfigs 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: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' 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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery components: schemas: ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Command.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : required: - data type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto' additionalProperties: false description: Service request data Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error T: type: object additionalProperties: false ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e : type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel__Fenergo.Nebula.Platform.Core.Models__Version_4.0.0.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e : type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto: type: object properties: fields: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto' entityType: type: - string - 'null' additionalProperties: false ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e : type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto: type: object properties: viewId: type: - string - 'null' isPrefilterEnabled: type: boolean prefilterFieldKey: type: - string - 'null' prefilterFieldType: type: - string - 'null' prefilterFieldSource: type: - string - 'null' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto: type: object properties: id: type: - string - 'null' description: Dashboard Config Id example: 3f3df0f2-2c54-4ebd-83e8-5ec8e2684138 name: type: - string - 'null' description: Dashboard Config Name example: 3f3df0f2-2c54-4ebd-83e8-5ec8e2684138 fields: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto' description: Dashboard Fields List dashboardType: type: - string - 'null' description: Dashboard Type entityTypes: type: - array - 'null' items: type: string description: "List of entity types for the Search Dashboard. \nValid values: \"Company\", \"Individual\".\nRequired when dashboard type is Search." example: - Company - Individual displayJourneyData: type: boolean description: A boolean property indicating whether journey data should be displayed on the dashboard. displayJourneyState: type: boolean description: A boolean property indicating whether journey data displayed on the dashboard should include a column with Journey State. dashboardFieldsConfig: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto' description: Dashboard Fields Config for given Entity Type searchDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto' journeysDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto' additionalProperties: false Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto: type: object properties: fieldKey: type: - string - 'null' label: type: - string - 'null' type: type: - string - 'null' typeLinkId: type: - string - 'null' additionalProperties: false Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1: type: object properties: data: $ref: '#/components/schemas/T' messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto: type: object properties: isSearchPrefilterEnabled: type: boolean searchPrefilterFieldKey: type: - string - 'null' searchPrefilterFieldType: type: - string - 'null' additionalProperties: false ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto: type: object properties: id: type: - string - 'null' name: type: - string - 'null' fields: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto' lastUpdatedDate: type: - string - 'null' format: date-time dashboardType: type: - string - 'null' entityTypes: type: - array - 'null' items: type: string displayJourneyData: type: boolean displayJourneyState: type: boolean searchDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto' journeysDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto' dashboardFieldsConfig: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto: type: object properties: id: type: - string - 'null' name: type: - string - 'null' fields: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto' lastUpdatedDate: type: - string - 'null' format: date-time dashboardType: type: - string - 'null' entityTypes: type: - array - 'null' items: type: string displayJourneyData: type: boolean displayJourneyState: type: boolean searchDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto' journeysDashboardConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto' additionalProperties: false ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e : type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-portaltenantcommand-v4-0-openapi.json - fenergo-portaltenantquery-v4-0-openapi.json