openapi: 3.2.0 info: title: Fenergo Journey Dashboard Configuration Version API version: '1.0' description: 'Operations tagged JourneyDashboardConfigurationVersion 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: JourneyDashboardConfigurationVersion paths: /api/dashboard-configuration/journey/versions: post: tags: - JourneyDashboardConfigurationVersion summary: Create Journey Dashboard Configuration Version description: 'Create Journey Dashboard Configuration Version for a given tenant. Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: CreateJourneyDashboardConfigurationVersion 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: Create Journey Dashboard Configuration Version request content: application/json: schema: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionCreateDtoServiceRequest' responses: '202': description: Success. Journey Dashboard Configuration Version created content: application/json: schema: $ref: '#/components/schemas/DashboardConfigurationVersionDtoServiceResponse' '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 get: tags: - JourneyDashboardConfigurationVersion summary: Get journey dashboard configuration versions description: 'Returns the journey configuration versions for dashboards for given tenant. Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetJourneyConfigurationVersionsList 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. Journey dashboard configuration versions list is returned content: application/json: schema: $ref: '#/components/schemas/DashboardConfigurationVersionLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/{id}/draft: post: tags: - JourneyDashboardConfigurationVersion summary: Create new Journey Dashboard Configuration Version draft based on other version description: 'Create new Journey Dashboard Configuration Version draft for a given tenant. Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: CreateJourneyDashboardConfigurationVersionDraft parameters: - name: id in: path description: Base configuration version 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. Journey Dashboard Configuration Version created content: application/json: schema: $ref: '#/components/schemas/DashboardConfigurationVersionDtoServiceResponse' '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. Journey Dashboard Configuration Version 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: /advanceddashboardcommand /api/dashboard-configuration/journey/versions/{id}: put: tags: - JourneyDashboardConfigurationVersion summary: Update Journey Dashboard Configuration Version description: 'Update Journey Dashboard Configuration Version for a given tenant. Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: UpdateJourneyDashboardConfigurationVersion parameters: - name: id in: path description: Journey Dashboard Configuration Version 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: Update Journey Dashboard Configuration Version request content: application/json: schema: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionUpdateDtoServiceRequest' responses: '202': description: Success. Journey Dashboard Configuration Version updated '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. Journey Dashboard Configuration Version 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 delete: tags: - JourneyDashboardConfigurationVersion summary: Delete Journey Dashboard Configuration Version draft description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: DeleteJourneyDashboardConfigurationVersion parameters: - name: id in: path description: Journey Dashboard Configuration Version 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. Journey Dashboard Configuration Version deleted '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. Journey Dashboard Configuration Version 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 get: tags: - JourneyDashboardConfigurationVersion summary: Get journey dashboard configuration version by id description: 'Returns the journey configuration version for a given id. Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetJourneyConfigurationVersionById parameters: - name: id in: path 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. Journey dashboard configuration version is returned content: application/json: schema: $ref: '#/components/schemas/DashboardConfigurationVersionLiteDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/{id}/submit: put: tags: - JourneyDashboardConfigurationVersion summary: Submit Journey Dashboard Configuration Version so it can be automatically… description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: SubmitJourneyDashboardConfigurationVersion parameters: - name: id in: path description: Journey Dashboard Configuration Version 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. Journey Dashboard Configuration Version submitted '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. Journey Dashboard Configuration Version 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: /advanceddashboardcommand /api/dashboard-configuration/journey/versions/{id}/views: post: tags: - JourneyDashboardConfigurationVersion summary: Add new Journey Dashboard Configuration Version view description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: AddJourneyDashboardConfigurationVersionView parameters: - name: id in: path description: Journey Dashboard Configuration Version 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: Add Journey Dashboard Configuration Version view request content: application/json: schema: allOf: - $ref: '#/components/schemas/DashboardViewDtoServiceRequest' responses: '202': description: Success. Journey Dashboard Configuration Version view added content: application/json: schema: $ref: '#/components/schemas/DashboardViewDtoServiceResponse' '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. Journey Dashboard Configuration Version or view 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 get: tags: - JourneyDashboardConfigurationVersion summary: Get all journey dashboard views by id description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetAllJourneyDashboardViewLite parameters: - name: id in: path description: Journey Configuration versionId 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. All dashboard views associated to the Journey Configuration is returned content: application/json: schema: $ref: '#/components/schemas/DashboardViewLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/{id}/views/{viewId}: put: tags: - JourneyDashboardConfigurationVersion summary: Update Journey Dashboard Configuration Version view description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: UpdateJourneyDashboardConfigurationVersionView parameters: - name: id in: path description: Journey Dashboard Configuration Version Id required: true schema: type: string format: uuid - name: viewId in: path description: Journey Dashboard Configuration Version View Id 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 requestBody: description: Update Journey Dashboard Configuration Version view request content: application/json: schema: allOf: - $ref: '#/components/schemas/DashboardViewDtoServiceRequest' responses: '202': description: Success. Journey Dashboard Configuration Version view updated '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. Journey Dashboard Configuration Version or view 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 delete: tags: - JourneyDashboardConfigurationVersion summary: Delete Journey Dashboard Configuration Version view description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: DeleteJourneyDashboardConfigurationVersionView parameters: - name: id in: path description: Journey Dashboard Configuration Version Id required: true schema: type: string format: uuid - name: viewId in: path description: Journey Dashboard Configuration Version View Id 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: '202': description: Success. Journey Dashboard Configuration Version view deleted '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. Journey Dashboard Configuration Version 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 get: tags: - JourneyDashboardConfigurationVersion summary: Get dashboard view details by id description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetJourneyDashboardViewById parameters: - name: id in: path description: Journey Configuration versionId required: true schema: type: string format: uuid - name: viewId in: path description: Journey Dashboard View Id 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: Success. Details of journey dashboard view associated to the Journey Configuration is returned content: application/json: schema: $ref: '#/components/schemas/DashboardViewDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Journey Dashboard Configuration Version or view 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: /advanceddashboardcommand /api/dashboard-configuration/journey/versions/{id}/policy-fields: put: tags: - JourneyDashboardConfigurationVersion summary: Update Journey Dashboard Configuration Version policy fields description: 'Required permissions: Following permissions are required: AdvancedDashboardConfigurationEdit' operationId: UpdateJourneyDashboardConfigurationVersionPolicyFields parameters: - name: id in: path description: Journey Dashboard Configuration Version 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: Update Journey Dashboard Configuration Version policy fields request content: application/json: schema: allOf: - $ref: '#/components/schemas/PolicyFieldDtoIEnumerableServiceRequest' responses: '202': description: Success. Journey Dashboard Configuration Version policy fields updated '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. Journey Dashboard Configuration Version 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 get: tags: - JourneyDashboardConfigurationVersion summary: Get policy fields by version id description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetJourneyDashboardConfigurationPolicyFields parameters: - name: id in: path description: Journey Configuration versionId 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. Policy fields associated to the Journey Configuration is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/latest/policy-fields: get: tags: - JourneyDashboardConfigurationVersion summary: Get policy fields for latest published version description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetLatestJourneyDashboardConfigurationPolicyFields 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. Policy fields associated to the Journey Configuration is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/{id}/available-fields: get: tags: - JourneyDashboardConfigurationVersion summary: Get all available fields by versionId to be used on Views configuration description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetAllJourneyDashboardFields parameters: - name: id 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: '200': description: Success. All Dashboard Fields related to this Journey Configuration Id are returned content: application/json: schema: $ref: '#/components/schemas/DashboardFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/dashboard-configuration/journey/versions/{id}/available-field: get: tags: - JourneyDashboardConfigurationVersion summary: '[OBSOLETE] Get all available field (singular) – use the pluralized route instead' parameters: - name: id in: path 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: OK '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 deprecated: true operationId: getApiDashboardConfigurationJourneyVersionsByIdAvailableField x-operation-id-source: derived servers: - url: /advanceddashboardquery /api/dashboard-configuration/journey/versions/latest/available-fields: get: tags: - JourneyDashboardConfigurationVersion summary: Get available fields for latest published version description: 'Required permissions: Following permissions are required: AdvancedDashboardAccess' operationId: GetLatestJourneyDashboardFields 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. All Dashboard Fields related to the latest Journey Configuration version are returned content: application/json: schema: $ref: '#/components/schemas/DashboardFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: PolicyFieldDto: required: - dataKey - name - policyPropertyType - policyReferenceId type: object properties: name: maxLength: 100 minLength: 1 type: string dataKey: maxLength: 100 minLength: 1 type: string policyReferenceId: minLength: 1 type: string format: uuid policyPropertyType: maxLength: 100 minLength: 1 type: string policyPropertyTypeId: type: - string - 'null' additionalProperties: false DashboardFieldType: enum: - Id - Text - Number - Date - Lookup - Object - Collection - Boolean type: string DashboardViewDto: required: - name type: object properties: id: type: - string - 'null' name: maxLength: 50 minLength: 1 type: string columns: type: - array - 'null' items: $ref: '#/components/schemas/DashboardColumnDto' additionalProperties: false DashboardConfigurationVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardConfigurationVersionUpdateDto: type: object properties: notes: maxLength: 400 type: - string - 'null' additionalProperties: false DashboardConfigurationVersionCreateDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionCreateDto' additionalProperties: false DashboardFieldSource: enum: - Journey - Task - Entity - EntityProperty type: string DashboardColumnDto: required: - field - label type: object properties: field: allOf: - $ref: '#/components/schemas/DashboardField' label: maxLength: 50 minLength: 1 type: string filterable: type: boolean order: type: - integer - 'null' format: int32 isHidden: type: boolean customProperties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false DashboardConfigurationVersionDto: type: object properties: id: type: string format: uuid created: type: string format: date-time effectiveFrom: type: - string - 'null' format: date-time notes: type: - string - 'null' status: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionStatus' versionNumber: type: integer format: int32 policyFields: type: - array - 'null' items: $ref: '#/components/schemas/PolicyFieldDto' views: type: - array - 'null' items: $ref: '#/components/schemas/DashboardViewDto' additionalProperties: false DashboardConfigurationVersionStatus: enum: - Draft - Pending - Published - Failed - Deleted type: string PolicyFieldDtoIEnumerableServiceRequest: required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/PolicyFieldDto' additionalProperties: false DashboardConfigurationVersionCreateDto: type: object properties: notes: maxLength: 400 type: - string - 'null' policyFields: type: - array - 'null' items: $ref: '#/components/schemas/PolicyFieldDto' views: type: - array - 'null' items: $ref: '#/components/schemas/DashboardViewDto' additionalProperties: false DashboardViewDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardViewDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardConfigurationVersionUpdateDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionUpdateDto' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: 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 ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false DashboardField: required: - name type: object properties: name: maxLength: 100 minLength: 1 type: string source: allOf: - $ref: '#/components/schemas/DashboardFieldSource' type: allOf: - $ref: '#/components/schemas/DashboardFieldType' additionalProperties: false DashboardViewDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardViewDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false PolicyFieldDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PolicyFieldDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PolicyFieldDto_2: type: object properties: name: type: - string - 'null' dataKey: type: - string - 'null' policyReferenceId: type: string format: uuid policyPropertyType: type: - string - 'null' policyPropertyTypeId: type: - string - 'null' additionalProperties: false DashboardViewDto_2: type: object properties: id: type: - string - 'null' name: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/DashboardColumn' additionalProperties: false DashboardFieldDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DashboardFieldDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardConfigurationVersionLiteDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardViewLiteDto: type: object properties: id: type: - string - 'null' name: type: - string - 'null' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardColumn: type: object properties: field: allOf: - $ref: '#/components/schemas/DashboardField_2' label: type: - string - 'null' filterable: type: boolean order: type: - integer - 'null' format: int32 isHidden: type: boolean customProperties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false DashboardFieldDto: type: object properties: name: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/DashboardFieldSource' type: allOf: - $ref: '#/components/schemas/DashboardFieldType' additionalProperties: false DashboardViewLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DashboardViewLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardConfigurationVersionLiteDto: type: object properties: id: type: string format: uuid created: type: string format: date-time effectiveFrom: type: - string - 'null' format: date-time notes: type: - string - 'null' status: allOf: - $ref: '#/components/schemas/DashboardConfigurationVersionStatus' versionNumber: type: integer format: int32 additionalProperties: false DashboardConfigurationVersionLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DashboardConfigurationVersionLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false DashboardField_2: type: object properties: name: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/DashboardFieldSource' type: allOf: - $ref: '#/components/schemas/DashboardFieldType' 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