openapi: 3.2.0 info: title: Fenergo Review Manager Configuration API version: '1.0' description: 'Operations tagged ReviewManagerConfiguration across 2 of this provider''s published API definitions: fenergo-reviewcommand-v1-0-openapi.json, fenergo-reviewquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /reviewcommand - url: /reviewquery security: - Bearer: [] tags: - name: ReviewManagerConfiguration paths: /api/ReviewManagerConfiguration/{type}: post: tags: - ReviewManagerConfiguration summary: Creates a Review Manager Configuration description: 'This method creates a new Review Manager Configuration. The method returns the created Review Manager Configuration Required permissions: Following permissions are required: ReviewManagerConfigurationEdit' operationId: CreateReviewManagerConfiguration parameters: - name: type in: path description: The type of the Review Manager Configuration to create required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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: The create Review Manager Configuration request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateReviewManagerConfigurationDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReviewManagerConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal server error '202': description: An instance of the Fenergo.Nebula.Review.Common.Dto.ReviewManagerConfigurationDto class with some metadata that represent the Review Manager Configuration created '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 '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: /reviewcommand /api/ReviewManagerConfiguration/{type}/{id}/duplicate: post: tags: - ReviewManagerConfiguration summary: Creates an Review Manager Configuration based on other version description: 'This method creates a new Review Manager Configuration based on other version.. The method returns the created Review Manager Configuration Required permissions: Following permissions are required: ReviewManagerConfigurationEdit' operationId: DuplicateReviewManagerConfiguration parameters: - name: id in: path description: Review manager configuration id required: true schema: type: string format: uuid - name: type in: path description: The type of the Review Manager Configuration to duplicate required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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/ReviewManagerConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal Server Error '202': description: An instance of the Fenergo.Nebula.Review.Common.Dto.ReviewManagerConfigurationDto class with some metadata that represent the Review Manager Configuration created '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Review Manager Configuration 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 '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: /reviewcommand /api/ReviewManagerConfiguration/{type}/{id}: put: tags: - ReviewManagerConfiguration summary: Update Review Manager Configuration description: 'Updates an existing Review Manager Configuration. Required permissions: Following permissions are required: ReviewManagerConfigurationEdit' operationId: UpdateReviewManagerConfiguration parameters: - name: id in: path description: Review manager configuration id required: true schema: type: string format: uuid - name: type in: path description: The type of the Review Manager Configuration to create required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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 Review Manager Configuration request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateReviewManagerConfigurationDtoServiceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReviewManagerConfigurationDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Review with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '202': description: Success. Review Manager Configuration updated '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: - ReviewManagerConfiguration summary: Delete Review Manager Configuration description: 'Deletes a Review Manager Configuration. Required permissions: Following permissions are required: ReviewManagerConfigurationEdit' operationId: DeleteReviewManagerConfiguration parameters: - name: id in: path description: Review manager configuration id required: true schema: type: string format: uuid - name: type in: path required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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/BooleanServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '202': description: Success. Review Manager Configuration deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Review 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: /reviewcommand /api/ReviewManagerConfiguration/{type}/{id}/publish: put: tags: - ReviewManagerConfiguration summary: Publish Review Manager Configuration description: 'Publishes an existing Review Manager Configuration. Required permissions: Following permissions are required: ReviewManagerConfigurationEdit' operationId: PublishReviewManagerConfiguration parameters: - name: id in: path description: Review manager configuration id required: true schema: type: string format: uuid - name: type in: path description: The type of the Review Manager Configuration to create required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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/BooleanServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '202': description: Success. Review Manager Configuration updated '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Review 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: /reviewcommand /api/reviewmanagerconfiguration/{type}: get: tags: - ReviewManagerConfiguration summary: Get Review Manager Configurations description: 'Returns the review manager configurations for a given tenant. Required permissions: Following permissions are required: ReviewManagerConfigurationAccess' operationId: GetReviewManagerConfigurationsList parameters: - name: type in: path required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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. Review is returned content: application/json: schema: $ref: '#/components/schemas/ReviewManagerConfigurationLiteDtoIEnumerableServiceResponse' '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: /reviewquery /api/reviewmanagerconfiguration/{type}/{id}: get: tags: - ReviewManagerConfiguration summary: Get Review Manager Configuration by Id description: 'Return the review manager configuration for an id. Required permissions: Following permissions are required: ReviewManagerConfigurationAccess' operationId: GetReviewManagerConfigurationById parameters: - name: id in: path required: true schema: type: string format: uuid - name: type in: path required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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. Review is returned content: application/json: schema: $ref: '#/components/schemas/ReviewManagerConfigurationDtoServiceResponse' '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: /reviewquery /api/reviewmanagerconfiguration/{type}/active: get: tags: - ReviewManagerConfiguration summary: Get Active Review Manager Configuration description: 'Return the active review manager configuration. Required permissions: At least one of the following permissions is required: ReviewManagerConfigurationAccess, ReviewManagerAccess' operationId: GetActiveReviewManagerConfiguration parameters: - name: type in: path required: true schema: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' - 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. Review is returned content: application/json: schema: $ref: '#/components/schemas/ReviewManagerConfigurationDtoServiceResponse' '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: /reviewquery components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ReviewManagerConfigurationLiteDto: type: object properties: id: type: string format: uuid configurationType: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationType' created: type: string format: date-time effectiveFrom: type: - string - 'null' format: date-time status: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationStatus' versionNumber: type: integer format: int32 additionalProperties: false ReviewManagerConfigurationType: enum: - Scheduled - InProgress type: string UpdateReviewManagerConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateReviewManagerConfigurationDto' additionalProperties: false CreateReviewManagerConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateReviewManagerConfigurationDto' additionalProperties: false ReviewManagerConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateReviewManagerConfigurationDto: allOf: - $ref: '#/components/schemas/CreateReviewManagerConfigurationDto' - type: object additionalProperties: false ReviewManagerConfigurationFieldSource: enum: - Journey - Entity type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ReviewManagerConfigurationStatus: enum: - Draft - Published - Deleted type: string BooleanServiceResponse: type: object properties: data: type: boolean messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateReviewManagerConfigurationDto: type: object properties: views: type: - array - 'null' items: $ref: '#/components/schemas/ViewDto' additionalProperties: false ColumnItemDto: type: object properties: dataKey: type: - string - 'null' policyReferenceId: type: - string - 'null' format: uuid policyPropertyTypeId: type: - string - 'null' format: uuid propertyType: type: - string - 'null' source: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationFieldSource' label: type: - string - 'null' filterable: type: boolean order: type: - integer - 'null' format: int32 isHidden: type: boolean isRiskRating: type: boolean additionalProperties: false ReviewManagerConfigurationDto: allOf: - $ref: '#/components/schemas/ReviewManagerConfigurationLiteDto' - type: object properties: views: type: - array - 'null' items: $ref: '#/components/schemas/ViewDto' additionalProperties: false ViewDto: required: - tableColumns type: object properties: id: type: - string - 'null' name: type: - string - 'null' tableColumns: type: array items: $ref: '#/components/schemas/ColumnItemDto' 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 ReviewManagerConfigurationLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ReviewManagerConfigurationLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ViewDto_2: type: object properties: id: type: - string - 'null' name: type: - string - 'null' tableColumns: type: - array - 'null' items: $ref: '#/components/schemas/ColumnItemDto' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-reviewcommand-v1-0-openapi.json - fenergo-reviewquery-v1-0-openapi.json