{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Review Query", "description": "Review Query API is part of FenX eco-system to manage EntityRule and Review Instances. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/reviewquery" } ], "paths": { "/api/data-in-scope/{journeyInstanceId}/products": { "get": { "tags": [ "DataInScope" ], "summary": "Get products in scope", "description": "\nReturns ids of the products that are in scope for a review journey.

Required permissions:
At least one of the following permissions is required: JourneyAccess, ProductAccessAndSearch", "operationId": "GetProductsInScope", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Review id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Product ids are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidListServiceResponse" } } } }, "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. JourneyInstanceId 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" } ] } } } } } } }, "/api/entity-rule": { "get": { "tags": [ "EntityRule" ], "summary": "Get entityRule", "description": "

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetAllEntityRules", "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. List of entity rule data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/entity-rule/{entityRuleId}": { "get": { "tags": [ "EntityRule" ], "summary": "Get entity rule by id", "description": "\nReturns the active, currently in effect, published entity rule version for a given id.

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetEntityRuleById", "parameters": [ { "name": "entityRuleId", "in": "path", "description": "Entity rule id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. entity rule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleVersionDtoServiceResponse" } } } }, "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. Entity rule 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" } ] } } } } } } }, "/api/entity-rule/{entityRuleId}/version/{versionNumber}": { "get": { "tags": [ "EntityRule" ], "summary": "Get entity rule by id and version", "description": "\nReturns entity rule for a given id and version number.

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetEntityRuleVersionById", "parameters": [ { "name": "entityRuleId", "in": "path", "description": "entity rule id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "entity rule version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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. entity rule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityRuleVersionDtoServiceResponse" } } } }, "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. entity rule with given id/version 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" } ] } } } } } } }, "/api/evaluate-review-dates-task-state/{entityId}/{journeyId}/{taskId}": { "get": { "tags": [ "EvaluateReviewDatesTaskState" ], "summary": "Get task state", "description": "\nReturns the state of a EvaluateReviewDates task.", "operationId": "GetTaskState", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Journey id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. EvaluateReviewDatesTaskStateDto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateReviewDatesTaskStateDtoServiceResponse" } } } }, "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. 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" } ] } } } } } } }, "/api/product-rule": { "get": { "tags": [ "ProductRule" ], "summary": "Get ProductRule", "description": "

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetAllProductRules", "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. List of Product rule data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRuleDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } } } }, "/api/product-rule/{productRuleId}": { "get": { "tags": [ "ProductRule" ], "summary": "Get Product rule by id", "description": "\nReturns the active, currently in effect, published Product rule version for a given id.

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetProductRuleById", "parameters": [ { "name": "productRuleId", "in": "path", "description": "Product rule id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Product rule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRuleVersionDtoServiceResponse" } } } }, "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. Product rule 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" } ] } } } } } } }, "/api/product-rule/{productRuleId}/version/{versionNumber}": { "get": { "tags": [ "ProductRule" ], "summary": "Get Product rule by id and version", "description": "\nReturns Product rule for a given id and version number.

Required permissions:
Following permissions are required: ReviewJourneySchedulingAccess", "operationId": "GetProductRuleVersionById", "parameters": [ { "name": "productRuleId", "in": "path", "description": "Product rule id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Product rule version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "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. Product rule is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRuleVersionDtoServiceResponse" } } } }, "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. Product rule with given id/version 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" } ] } } } } } } }, "/api/review/{reviewId}": { "get": { "tags": [ "Review" ], "summary": "Get review by id", "description": "\nReturns review for a given id.

Required permissions:
Following permissions are required: ScheduledReviewAccess", "operationId": "GetReviewById", "parameters": [ { "name": "reviewId", "in": "path", "description": "Review id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Review is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDtoServiceResponse" } } } }, "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. 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" } ] } } } } } } }, "/api/review/{entityId}/pending-reviews": { "get": { "tags": [ "Review" ], "summary": "Get pending reviews for entity", "description": "

Required permissions:
At least one of the following permissions is required: ScheduledReviewAccess, JourneyAccess", "operationId": "GetPendingReviewsForEntity", "parameters": [ { "name": "entityId", "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. Pending entity reviews is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDtoIEnumerableServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values" }, "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" } ] } } } } } } }, "/api/review/{journeyInstanceId}/reviews": { "get": { "tags": [ "Review" ], "summary": "Gets the review models for a given journey id", "description": "\nReturns the review models associated with the specified review journey.

Required permissions:
At least one of the following permissions is required: JourneyAccess, ScheduledReviewAccess", "operationId": "GetReviewsByJourneyId", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "The unique identifier of the review journey", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The review model is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request contains missing or 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. A review journey with the specified 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" } ] } } } } } } }, "/api/review-config/deferred-doc-requirements": { "get": { "tags": [ "ReviewConfig" ], "summary": "Get Deferred Document Requirements Review Config for your tenant", "description": "

Required permissions:
Following permissions are required: DeferredDocRequirementsReviewConfigAccess", "operationId": "GetDeferredDocRequirementsReviewConfig", "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. Deferred Doc Requirements Review Config retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeferredDocRequirementsReviewConfigDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reviewmanagerconfiguration/{type}": { "get": { "tags": [ "ReviewManagerConfiguration" ], "summary": "Get Review Manager Configurations", "description": "\nReturns 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" } ] } } } } } } }, "/api/reviewmanagerconfiguration/{type}/{id}": { "get": { "tags": [ "ReviewManagerConfiguration" ], "summary": "Get Review Manager Configuration by Id", "description": "\nReturn 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" } ] } } } } } } }, "/api/reviewmanagerconfiguration/{type}/active": { "get": { "tags": [ "ReviewManagerConfiguration" ], "summary": "Get Active Review Manager Configuration", "description": "\nReturn 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" } ] } } } } } } } }, "components": { "schemas": { "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BaseVersionDto": { "type": "object", "properties": { "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "readOnly": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing data group version data" }, "ColumnItemDto": { "type": "object", "properties": { "dataKey": { "type": "string", "nullable": true }, "policyReferenceId": { "type": "string", "format": "uuid", "nullable": true }, "policyPropertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "source": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerConfigurationFieldSource" } ] }, "label": { "type": "string", "nullable": true }, "filterable": { "type": "boolean" }, "order": { "type": "integer", "format": "int32", "nullable": true }, "isHidden": { "type": "boolean" }, "isRiskRating": { "type": "boolean" } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ConditionalValueDto": { "allOf": [ { "$ref": "#/components/schemas/StringConditionalValueDto" }, { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ConditionalValueDto`1": { "allOf": [ { "$ref": "#/components/schemas/ConditionDto" }, { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/T" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DeferredDocRequirementsReviewConfigDto": { "required": [ "isEnabled", "journeyType" ], "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Is deferred document requirements mechanism enabled.", "example": true }, "journeyType": { "type": "string", "description": "Type of the journey to launch as a review.", "nullable": true, "example": "DeferredDocumentRequirementsReview" } }, "additionalProperties": false, "description": "Configuration for Deferred Document Requirements Review." }, "DeferredDocRequirementsReviewConfigDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DeferredDocRequirementsReviewConfigDto" } ], "description": "Configuration for Deferred Document Requirements Review.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DeferredDocumentRequirements": { "type": "object", "properties": { "client": { "allOf": [ { "$ref": "#/components/schemas/DeferredDocumentRequirementsReviewProperties" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/DeferredDocumentRequirementsReviewProperties" } ], "nullable": true } }, "additionalProperties": false }, "DeferredDocumentRequirementsReviewProperties": { "required": [ "documentRequirements", "jurisdictions", "policyCategories" ], "type": "object", "properties": { "documentRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/DeferredDocumentRequirementsReviewPropertiesDocRequirement" }, "nullable": true }, "policyCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DeferredDocumentRequirementsReviewPropertiesDocRequirement": { "type": "object", "properties": { "documentDataKey": { "type": "string", "nullable": true }, "requirementName": { "type": "string", "nullable": true }, "deferUntil": { "type": "string", "format": "date-time" }, "documentDeferralComment": { "type": "string", "nullable": true }, "journeys": { "type": "array", "items": { "$ref": "#/components/schemas/DeferredDocumentRequirementsReviewPropertiesJourney" }, "nullable": true } }, "additionalProperties": false }, "DeferredDocumentRequirementsReviewPropertiesJourney": { "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "journeyName": { "type": "string", "nullable": true }, "journeyType": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "entityName": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "EntityRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the entity rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityRuleVersionDto" }, "description": "Versions associated to this entity rule", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing entity rule" }, "EntityRuleDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityRuleDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntityRuleVersionDto": { "allOf": [ { "$ref": "#/components/schemas/BaseVersionDto" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the entityRule set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "entityRuleId": { "type": "string", "description": "The UiD of the entityRule that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "EntityRule name", "nullable": true, "example": "Standard Entity Rule" }, "description": { "type": "string", "description": "Description of the Entity Rule", "nullable": true, "example": "Rule to trigger a one year review" }, "journeyType": { "type": "string", "description": "Configured journey type used at launch", "nullable": true, "example": "Maintenance" }, "launchJourneyIn": { "type": "integer", "description": "Launch journey in months", "format": "int32" }, "advanceLaunchBy": { "type": "integer", "description": "Launch journey in advance in days", "format": "int32" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the entity rule can be applied", "nullable": true }, "entityReviewRequired": { "type": "boolean", "description": "Whether or not an Entity Review is required", "example": true }, "additionalReviewTypes": { "type": "array", "items": { "type": "string" }, "description": "List of review types when an entity review is required", "nullable": true }, "conflictingJourneyTypes": { "type": "array", "items": { "type": "string" }, "description": "List of journey types treated as conflicting when JourneyConflictAtScheduling is used", "nullable": true }, "journeyTypesScope": { "type": "array", "items": { "type": "string" }, "description": "List of journey types on completion of which a review should be launched", "nullable": true }, "usePolicyDateField": { "type": "boolean", "description": "Whether to use a date field from policy instead of calculated months", "example": false }, "policyDateField": { "type": "string", "description": "The policy date field identifier when using policy date field", "nullable": true, "example": "d0871fbf-9c5f-45f5-9a9c-7563b07e9387" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "isMigrated": { "type": "boolean", "description": "To show if the rule was migrated from Journey Scheduler", "example": true } }, "additionalProperties": false } ], "description": "Response DTO representing entity rule version data" }, "EntityRuleVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityRuleVersionDto" } ], "description": "Response DTO representing entity rule version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EvaluateReviewDatesReviewDto": { "type": "object", "properties": { "reviewId": { "type": "string", "format": "uuid" }, "ruleId": { "type": "string", "format": "uuid" }, "typeId": { "type": "string", "format": "uuid" }, "reviewType": { "type": "string", "nullable": true }, "journeyType": { "type": "string", "nullable": true }, "launchDate": { "type": "string", "format": "date-time" }, "calculatedDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "EvaluateReviewDatesTaskStateDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "entityDraftId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "reviewsToUpdate": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluateReviewDatesReviewDto" }, "nullable": true } }, "additionalProperties": false }, "EvaluateReviewDatesTaskStateDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateReviewDatesTaskStateDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetPendingReviewsCountRequestDto": { "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/PendingReviewCountFilterDto" } ], "description": "Filters details", "nullable": true } }, "additionalProperties": false, "description": "Contains the properties needed to retrieve the pending reviews count." }, "GetPendingReviewsCountRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPendingReviewsCountRequestDto" } ], "description": "Contains the properties needed to retrieve the pending reviews count.", "nullable": true } }, "additionalProperties": false }, "GetPendingReviewsCountResponseDto": { "type": "object", "properties": { "timeSpan": { "type": "string", "description": "Time span option (Day/Week/Month). This will be used to group the review count by date.", "nullable": true }, "reviewCountByDate": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewCountByDateDto" }, "description": "Review count by date", "nullable": true } }, "additionalProperties": false, "description": "Contains the number of reviews grouped by date for a given time span option." }, "GetPendingReviewsCountResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPendingReviewsCountResponseDto" } ], "description": "Contains the number of reviews grouped by date for a given time span option.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetReviewsRiskCountRequestDto": { "type": "object", "properties": { "riskRatingKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetReviewsRiskCountRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReviewsRiskCountRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetReviewsRiskCountResponseDto": { "type": "object", "properties": { "riskCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "GetReviewsRiskCountResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetReviewsRiskCountResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GuidListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "JourneyDto": { "required": [ "name", "status", "type" ], "type": "object", "properties": { "journeyId": { "type": "string", "format": "uuid" }, "currentTaskName": { "type": "string", "nullable": true }, "currentTaskId": { "type": "string", "format": "uuid", "nullable": true }, "type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "progress": { "type": "number", "format": "float" }, "customStatus": { "type": "string", "nullable": true }, "teamId": { "type": "string", "format": "uuid", "nullable": true }, "ownerId": { "type": "string", "format": "uuid", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "accessLayers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "LaunchedReviewDataDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Review Object Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "reviewType": { "type": "string", "description": "Type of the review", "nullable": true, "example": "Product" }, "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "entityDraftId": { "type": "string", "description": "The Id of the Entity draft", "format": "uuid", "nullable": true, "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "The Id of the Journey", "format": "uuid", "nullable": true, "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "calculatedDate": { "type": "string", "description": "DateTime the journey associated to the review should be completed by", "format": "date-time" }, "offset": { "type": "integer", "description": "Number of Days to offset calculated date", "format": "int32", "example": 30 }, "launchDate": { "type": "string", "description": "DateTime of when a journey will be launched as part of the review", "format": "date-time" }, "status": { "type": "string", "description": "The Review Object Status", "nullable": true, "example": "Completed" }, "created": { "type": "string", "description": "The date the review was created", "format": "date-time" }, "journeyType": { "type": "string", "description": "Type of a journey", "nullable": true }, "journey": { "allOf": [ { "$ref": "#/components/schemas/JourneyDto" } ], "description": "Additional Journey data", "nullable": true }, "entityDraftProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Entity draft properties", "nullable": true }, "origin": { "allOf": [ { "$ref": "#/components/schemas/ReviewOrigin" } ], "description": "The Origin of the Review", "example": "System" } }, "additionalProperties": false, "description": "The Review object returned for the search endpoint." }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PagerDto": { "type": "object", "properties": { "size": { "type": "integer", "format": "int32" }, "from": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string", "nullable": true }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/SortOrder" } ] } }, "additionalProperties": false }, "PendingReviewCountFilterDto": { "type": "object", "properties": { "launchDate": { "allOf": [ { "$ref": "#/components/schemas/ReviewsCountDateRangeDto" } ], "description": "Retrieve the information for the DateTime of when a journey will be launched as part of the review", "nullable": true } }, "additionalProperties": false, "description": "Filter information to retrieve the count of reviews" }, "PendingReviewDataDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Review Object Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "reviewType": { "type": "string", "description": "Type of the review", "nullable": true, "example": "Product" }, "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "calculatedDate": { "type": "string", "description": "DateTime the journey associated to the review should be completed by", "format": "date-time" }, "offset": { "type": "integer", "description": "Number of Days to offset calculated date", "format": "int32", "example": 30 }, "launchDate": { "type": "string", "description": "DateTime of when a journey will be launched as part of the review", "format": "date-time" }, "status": { "type": "string", "description": "The Review Object Status", "nullable": true, "example": "Completed" }, "created": { "type": "string", "description": "The date the review was created", "format": "date-time" }, "journeyType": { "type": "string", "description": "Type of a journey", "nullable": true }, "journey": { "allOf": [ { "$ref": "#/components/schemas/JourneyDto" } ], "description": "Additional Journey data", "nullable": true }, "entityProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Entity properties", "nullable": true }, "entityDraftProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Entity draft properties", "nullable": true }, "origin": { "allOf": [ { "$ref": "#/components/schemas/ReviewOrigin" } ], "description": "The Origin of the Review", "example": "System" } }, "additionalProperties": false, "description": "The Review object returned for the search endpoint." }, "ProductRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the product rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRuleVersionDto" }, "description": "Versions associated to this product rule", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing product rule" }, "ProductRuleDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRuleDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductRuleVersionDto": { "allOf": [ { "$ref": "#/components/schemas/BaseVersionDto" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the productRule set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "productRuleId": { "type": "string", "description": "The UiD of the productRule that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Product Rule name", "nullable": true, "example": "Standard Product Rule" }, "description": { "type": "string", "description": "Description of the Product Rule", "nullable": true, "example": "Rule to trigger a one year review" }, "journeyType": { "type": "string", "description": "Configured journey type used at launch", "nullable": true, "example": "Maintenance" }, "launchJourneyIn": { "type": "integer", "description": "Launch journey in months", "format": "int32" }, "advanceLaunchBy": { "type": "integer", "description": "Launch journey in advance in days", "format": "int32" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the entity rule can be applied", "nullable": true }, "journeyTypesScope": { "type": "array", "items": { "type": "string" }, "description": "List of journey types on completion of which a review should be launched", "nullable": true }, "usePolicyDateField": { "type": "boolean", "description": "Whether to use a date field from policy instead of calculated months", "example": false }, "policyDateField": { "type": "string", "description": "The policy date field identifier when using policy date field", "nullable": true, "example": "d0871fbf-9c5f-45f5-9a9c-7563b07e9387" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" } }, "additionalProperties": false } ], "description": "Response DTO representing product rule version data" }, "ProductRuleVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProductRuleVersionDto" } ], "description": "Response DTO representing product rule version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewCountByDateDto": { "type": "object", "properties": { "startDate": { "type": "string", "description": "StartDate of the period for which review count is returned", "format": "date-time" }, "reviewCount": { "type": "integer", "description": "Number of reviews for the time period starting from StartDate", "format": "int32" } }, "additionalProperties": false }, "ReviewDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Review Object Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "ruleId": { "type": "string", "description": "The Metadata Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "reviewType": { "type": "string", "description": "Type of the review", "nullable": true, "example": "Product" }, "typeId": { "type": "string", "description": "The id of the object in scope for the review", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "entityId": { "type": "string", "description": "The Id of the Entity", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "deferredDocumentRequirements": { "allOf": [ { "$ref": "#/components/schemas/DeferredDocumentRequirements" } ], "description": "The Deferred Document Requirements of the review object", "nullable": true }, "calculatedDate": { "type": "string", "description": "DateTime the Review was calculated", "format": "date-time" }, "offset": { "type": "integer", "description": "Number of Days to offset calculated date", "format": "int32", "example": 30 }, "launchDate": { "type": "string", "description": "DateTime of the launched review", "format": "date-time" }, "status": { "type": "string", "description": "The Review Object Status", "nullable": true, "example": "Completed" }, "created": { "type": "string", "description": "The date the review was created", "format": "date-time" }, "journeyType": { "type": "string", "description": "Type of a journey", "nullable": true }, "origin": { "allOf": [ { "$ref": "#/components/schemas/ReviewOrigin" } ], "description": "The Origin of the Review", "example": "System" } }, "additionalProperties": false, "description": "A Review object. \nContains all properties needed to fill the metadata of the review object." }, "ReviewDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewDto" } ], "description": "A Review object. \nContains all properties needed to fill the metadata of the review object.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewManagerConfigurationDto": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerConfigurationLiteDto" }, { "type": "object", "properties": { "views": { "type": "array", "items": { "$ref": "#/components/schemas/ViewDto" }, "nullable": true } }, "additionalProperties": false } ] }, "ReviewManagerConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerConfigurationDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewManagerConfigurationFieldSource": { "enum": [ "Journey", "Entity" ], "type": "string" }, "ReviewManagerConfigurationLiteDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "configurationType": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerConfigurationType" } ] }, "created": { "type": "string", "format": "date-time" }, "effectiveFrom": { "type": "string", "format": "date-time", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReviewManagerConfigurationStatus" } ] }, "versionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReviewManagerConfigurationLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewManagerConfigurationLiteDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewManagerConfigurationStatus": { "enum": [ "Draft", "Published", "Deleted" ], "type": "string" }, "ReviewManagerConfigurationType": { "enum": [ "Scheduled", "InProgress" ], "type": "string" }, "ReviewOrigin": { "enum": [ "System", "JourneyScheduler", "ETL" ], "type": "string" }, "ReviewSearchAllDateRangeDto": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReviewSearchAllFilterDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "dateRange": { "allOf": [ { "$ref": "#/components/schemas/ReviewSearchAllDateRangeDto" } ], "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ReviewSearchFilterType" } ] }, "source": { "allOf": [ { "$ref": "#/components/schemas/ReviewSearchFilterSource" } ] } }, "additionalProperties": false }, "ReviewSearchFilterSource": { "enum": [ "Review", "Entity", "EntityDraft", "Journey" ], "type": "string" }, "ReviewSearchFilterType": { "enum": [ "String", "Select", "DateRange" ], "type": "string" }, "ReviewsCountDateRangeDto": { "type": "object", "properties": { "from": { "type": "string", "description": "Only dates greater or equal to this one will be returned. Note that the time part of the date is ignored.", "format": "date-time" }, "to": { "type": "string", "description": "Only dates smaller or equal to this one will be returned. Note that the time part of the date is ignored.", "format": "date-time" } }, "additionalProperties": false, "description": "Object that represents the date range for the review date count request" }, "SearchLaunchedReviewDataRequest": { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSearchAllFilterDto" }, "nullable": true }, "search": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SearchLaunchedReviewDataRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchLaunchedReviewDataRequest" } ], "nullable": true } }, "additionalProperties": false }, "SearchLaunchedReviewsResponseDto": { "type": "object", "properties": { "totalResults": { "type": "integer", "description": "Total results", "format": "int32" }, "size": { "type": "integer", "description": "Page size", "format": "int32" }, "from": { "type": "integer", "description": "From page", "format": "int32" }, "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/LaunchedReviewDataDto" }, "description": "List of launched reviews", "nullable": true } }, "additionalProperties": false, "description": "Contains the lauched reviews and the pagination information." }, "SearchLaunchedReviewsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchLaunchedReviewsResponseDto" } ], "description": "Contains the lauched reviews and the pagination information.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SearchPendingReviewDataRequest": { "type": "object", "properties": { "pager": { "allOf": [ { "$ref": "#/components/schemas/PagerDto" } ], "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSearchAllFilterDto" }, "nullable": true }, "search": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SearchPendingReviewDataRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchPendingReviewDataRequest" } ], "nullable": true } }, "additionalProperties": false }, "SearchPendingReviewsResponseDto": { "type": "object", "properties": { "totalResults": { "type": "integer", "description": "Total results", "format": "int32" }, "size": { "type": "integer", "description": "Page size", "format": "int32" }, "from": { "type": "integer", "description": "From page", "format": "int32" }, "reviews": { "type": "array", "items": { "$ref": "#/components/schemas/PendingReviewDataDto" }, "description": "List of pending reviews", "nullable": true } }, "additionalProperties": false, "description": "Contains the pending reviews and the pagination information." }, "SearchPendingReviewsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchPendingReviewsResponseDto" } ], "description": "Contains the pending reviews and the pagination information.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SortOrder": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "StringConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "T": { "type": "object", "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" }, "ViewDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "tableColumns": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnItemDto" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }