{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Product Policy Command",
"description": "Policy Command API is part of FenX eco-system to manage Requirement Sets, Requirements, Data Groups and Data Group Fields Instances. All the operations require valid access token obtained from Identity service.",
"version": "1.0"
},
"servers": [
{
"url": "/productpolicycommand"
}
],
"paths": {
"/api/product-requirement-set": {
"post": {
"tags": [
"ProductRequirementSet"
],
"summary": "Create product requirement set",
"description": "\n - Creates a new product requirement set with a first draft version.
\n - The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateProductRequirementSet",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement set created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductRequirementSetResponseServiceResponse"
}
}
}
},
"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-requirement-set/{setId}": {
"post": {
"tags": [
"ProductRequirementSet"
],
"summary": "Create product requirement set version",
"description": "\n - Creates a new version of an existing product requirement set.
\n - Assigns the next available version number.
\n - The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Create product requirement set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement set version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductRequirementSetDtoServiceResponse"
}
}
}
},
"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 requirement set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"ProductRequirementSet"
],
"summary": "Delete product requirement set and all its versions",
"description": "\nDeletes an existing product requirement set and all its versions.
Required permissions:
Following permissions are required: ProductConfigurationDelete",
"operationId": "DeleteProductRequirementSet",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Product requirement set deleted"
},
"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 requirement set 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-requirement-set/{setId}/version/{versionNumber}/draft": {
"post": {
"tags": [
"ProductRequirementSet"
],
"summary": "Create product requirement set version from provided set id",
"description": "\n - Creates a new version of an existing product requirement set.
\n - Assigns the next available version number.
\n - The new version initializes with the latest published product requirement set data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateProductRequirementSetVersionFromSetId",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to create new draft from",
"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": {
"202": {
"description": "Success. Product requirement set version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductRequirementSetVersionFromSetIdResponseServiceResponse"
}
}
}
},
"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 requirement set 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-requirement-set/{setId}/version/{versionNumber}": {
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Update product requirement set version",
"description": "\nUpdates an existing product requirement set version. Only draft and rejected versions are allowed to be updated.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "UpdateProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to update",
"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"
}
],
"requestBody": {
"description": "Update product requirement set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateProductRequirementSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement set version updated"
},
"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 requirement set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"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": [
"ProductRequirementSet"
],
"summary": "Delete product requirement set version",
"description": "\n - Deletes the selected version of an existing product requirement set.
\n - If the version is the last one, then the version number of it will become the next available one for the model.\n Otherwise, the version number will be flagged as deleted and become unavailable.
\n
Required permissions:
Following permissions are required: ProductConfigurationDelete",
"operationId": "DeleteProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to delete",
"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": {
"202": {
"description": "Success. Product requirement set version deleted"
},
"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 requirement set 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-requirement-set/{productRequirementSetId}/version/{versionNumber}/clone": {
"post": {
"tags": [
"ProductRequirementSet"
],
"summary": "Clone product requirement set version",
"description": "\n - Clones the selected version of an existing product requirement set and creates a new model with a single version.
\n - The new version contains all the data of the original selected one,\n will have the default status of draft and the author as the only required signee.
\n - Returns the id of the cloned product requirement set version.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CloneProductRequirementSetVersion",
"parameters": [
{
"name": "productRequirementSetId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to clone",
"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"
}
],
"requestBody": {
"description": "Clone Product requirement set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneProductRequirementSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement set version cloned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneProductRequirementSetVersionResponseServiceResponse"
}
}
}
},
"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 requirement set 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-requirement-set/{setId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Submit product requirement set version for approval",
"description": "\nSubmits the selected version of an existing product requirement set for approval.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "SubmitProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to submit",
"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": {
"202": {
"description": "Success. Product requirement set version submitted"
},
"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 requirement set 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-requirement-set/{setId}/version/{versionNumber}/sign": {
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Sign product requirement set version",
"description": "\nSigns the selected version of an existing product requirement set and changes the version status accordingly to the action (Approve/Reject).
Required permissions:
Following permissions are required: ProductConfigurationApprove",
"operationId": "SignProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to sign",
"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"
}
],
"requestBody": {
"description": "Sign product requirement set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement set version signed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductRequirementSetVersionSignResponseServiceResponse"
}
}
}
},
"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 requirement set 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-requirement-set/{setId}/version/{versionNumber}/archive": {
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Archive product requirement set version",
"description": "\nArchives the selected version of an existing product requirement set.
Required permissions:
Following permissions are required: ProductConfigurationArchive",
"operationId": "ArchiveProductRequirementSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to archive",
"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": {
"202": {
"description": "Success. Product requirement set version archived"
},
"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 requirement set 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-requirement-set/{id}/version/{versionNumber}/field": {
"post": {
"tags": [
"ProductRequirementSet"
],
"summary": "Add requirement",
"description": "\n - Adds a new product requirement to an existing product requirement set.
\n - Returns the id of the created product requirement.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "AddProductRequirement",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Product requirement set 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"
}
],
"requestBody": {
"description": "Add product requirement request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCreatedDtoServiceResponse"
}
}
}
},
"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 requirement set 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"
}
]
}
}
}
}
}
},
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Update requirement",
"description": "\nUpdates an existing product requirement in specific product requirement set.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "UpdateProductRequirement",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Product requirement set 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"
}
],
"requestBody": {
"description": "Update product requirement request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateProductRequirementDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product requirement updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductRequirementDtoServiceResponse"
}
}
}
},
"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 requirement set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"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-requirement-set/{id}/version/{versionNumber}/field/{fieldId}": {
"delete": {
"tags": [
"ProductRequirementSet"
],
"summary": "Delete requirement",
"description": "\nDeletes an existing product requirement in specific product requirement set.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "DeleteProductRequirement",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Product requirement set version number",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "fieldId",
"in": "path",
"description": "Product requirement id to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Product requirement deleted"
},
"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 requirement set/requirement 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-requirement-set/{setId}/version/{versionNumber}/update-product-requirements-dataprotection-jurisdiction": {
"put": {
"tags": [
"ProductRequirementSet"
],
"summary": "Update product pequirements DataProtectionJurisdiction",
"description": "\nUpdate DataProtectionJurisdiction for all Product requirements in specified Product Requirement Set using DefaultDataProtectionJurisdiction
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "UpdateProductRequirementsDataProtectionJurisdiction",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product requirement set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to update data protection jurisdiction",
"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": {
"202": {
"description": "Success. Requirement set attributes updated with default data protection jurisdiction"
},
"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. Requirement set 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/scoping-rule-set": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Create product scoping rule set",
"description": "\n - Creates a new product scoping rule set with a first draft version.
\n - The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateScopingRuleSet",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product scoping rule set created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseServiceResponse"
}
}
}
},
"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/scoping-rule-set/{setId}": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Create product scoping rule set version",
"description": "\n - Creates a new version of an existing product scoping rule set.
\n - Assigns the next available version number.
\n - The new version initializes with the provided data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Create product scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product scoping rule set version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
}
}
},
"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 scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"ScopingRuleSet"
],
"summary": "Delete product scoping rule set and all its versions",
"description": "\nDeletes an existing product scoping rule set and all its versions.
Required permissions:
Following permissions are required: ProductConfigurationDelete",
"operationId": "DeleteScopingRuleSet",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Product scoping rule set deleted"
},
"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 scoping rule set 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/scoping-rule-set/{setId}/version/{versionNumber}/draft": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Create product scoping rule set version from provided set id",
"description": "\n - Creates a new version of an existing product scoping rule set.
\n - Assigns the next available version number.
\n - The new version initializes with the latest published product scoping rule set data, has the default status of draft\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CreateScopingRuleSetVersionFromSetId",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to create new draft from",
"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": {
"202": {
"description": "Success. Product scoping rule set version created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetVersionFromSetIdResponseServiceResponse"
}
}
}
},
"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 scoping rule set 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/scoping-rule-set/{setId}/version/{versionNumber}": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Update product scoping rule set version",
"description": "\nUpdates an existing product scoping rule set version. Only draft and rejected versions are allowed to be updated.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "UpdateScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to update",
"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"
}
],
"requestBody": {
"description": "Update product scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product scoping rule set version updated"
},
"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 scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"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": [
"ScopingRuleSet"
],
"summary": "Delete product scoping rule set version",
"description": "\n - Deletes the selected version of an existing product scoping rule set.
\n - If the version is the last one, then the version number of it will become the next available one for the model.\n Otherwise, the version number will be flagged as deleted and become unavailable.
\n
Required permissions:
Following permissions are required: ProductConfigurationDelete",
"operationId": "DeleteScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to delete",
"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": {
"202": {
"description": "Success. Product scoping rule set version deleted"
},
"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 scoping rule set 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/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/clone": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Clone product scoping rule set version",
"description": "\n - Clones the selected version of an existing product scoping rule set and creates a new model with a single version.
\n - The new version contains all the data of the original selected one,\n will have the default status of draft and the author as the only required signee.
\n - Returns the id of the cloned product scoping rule set version.
\n
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "CloneScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to clone",
"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"
}
],
"requestBody": {
"description": "Clone Product scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product scoping rule set version cloned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseServiceResponse"
}
}
}
},
"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 scoping rule set 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/scoping-rule-set/{setId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Submit product scoping rule set version for approval",
"description": "\nSubmits the selected version of an existing product scoping rule set for approval.
Required permissions:
Following permissions are required: ProductConfigurationEdit",
"operationId": "SubmitScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to submit",
"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": {
"202": {
"description": "Success. Product scoping rule set version submitted"
},
"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 scoping rule set 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/scoping-rule-set/{setId}/version/{versionNumber}/sign": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Sign product scoping rule set version",
"description": "\nSigns the selected version of an existing product scoping rule set and changes the version status accordingly to the action (Approve/Reject).
Required permissions:
Following permissions are required: ProductConfigurationApprove",
"operationId": "SignScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to sign",
"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"
}
],
"requestBody": {
"description": "Sign product scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Product scoping rule set version signed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionSignResponseServiceResponse"
}
}
}
},
"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 scoping rule set 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/scoping-rule-set/{setId}/version/{versionNumber}/archive": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Archive product scoping rule set version",
"description": "\nArchives the selected version of an existing product scoping rule set.
Required permissions:
Following permissions are required: ProductConfigurationArchive",
"operationId": "ArchiveScopingRuleSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Product scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to archive",
"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": {
"202": {
"description": "Success. Product scoping rule set version archived"
},
"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 scoping rule set 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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccessLayerDto": {
"required": [
"businessRelated",
"geographic"
],
"type": "object",
"properties": {
"geographic": {
"type": "array",
"items": {
"minLength": 1,
"type": "string"
},
"description": "Collection of geographic access layers"
},
"businessRelated": {
"type": "array",
"items": {
"minLength": 1,
"type": "string"
},
"description": "Collection of business related access layers"
}
},
"additionalProperties": false,
"description": "DTO representing associated access layers"
},
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ApproveActionServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
}
},
"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
},
"BasicRuleDto": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BasicRuleDto2": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BasicRuleDtoConditionalValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicRuleDtoConditionalValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"BasicRuleDtoConditionalValueDto": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"BasicRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"CloneProductRequirementSetVersionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Product Requirement Set Name",
"nullable": true,
"example": "Fenergo Comprehensive Standard Policy Requirements"
},
"jurisdiction": {
"type": "string",
"description": "Product Requirement Set Jurisdiction",
"nullable": true,
"example": "Global"
}
},
"additionalProperties": false
},
"CloneProductRequirementSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneProductRequirementSetVersionDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"CloneProductRequirementSetVersionResponse": {
"type": "object",
"properties": {
"requirementSetId": {
"type": "string",
"description": "Id of the cloned product requirement set",
"format": "uuid"
},
"expectedRequirementCount": {
"type": "integer",
"description": "Expected number of requirements of the cloned product requirement set",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Request DTO representing clone product requirement set data"
},
"CloneProductRequirementSetVersionResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneProductRequirementSetVersionResponse"
}
],
"description": "Request DTO representing clone product requirement set data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"CloneScopingRuleSetVersionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Scoping Rule Set Name",
"nullable": true,
"example": "Loans in USA"
},
"uniqueIdentifier": {
"type": "string",
"description": "Scoping Rule Set UniqueIdentifier",
"nullable": true,
"example": "Global"
}
},
"additionalProperties": false
},
"CloneScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"CloneScopingRuleSetVersionResponse": {
"type": "object",
"properties": {
"scopingRuleSetId": {
"type": "string",
"description": "Id of the cloned scoping rule set",
"format": "uuid"
},
"expectedRuleCount": {
"type": "integer",
"description": "Expected number of rules of the cloned scoping rule set",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Request DTO representing clone scoping rule set data"
},
"CloneScopingRuleSetVersionResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponse"
}
],
"description": "Request DTO representing clone scoping rule set data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"CollectionMaximumCountRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"requiredTypesMaxCount": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"overallMaximumCount": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"CollectionMaximumCountRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"requiredTypesMaxCount": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"overallMaximumCount": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"CollectionMaximumCountRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMaximumCountRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"CollectionMinimumCountRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"requiredTypesMinCount": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"overallMinimumCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
]
},
"CollectionMinimumCountRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"requiredTypesMinCount": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"overallMinimumCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
]
},
"CollectionMinimumCountRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMinimumCountRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"CommonRequirementSetDto": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"description": "The UiD of the data requirement set",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "Requirement set name",
"nullable": true,
"example": "Fenergo Comprehensive Standard Policy Requirements"
},
"jurisdiction": {
"type": "string",
"description": "Requirement set jurisdiction",
"nullable": true,
"example": "Global"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the requirement set can be applied",
"nullable": true
},
"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"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing requirement set data"
},
"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": {
"required": [
"logicalOperation",
"name",
"operands"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"minLength": 1,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"minLength": 1,
"type": "string"
},
"operands": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
}
}
},
"additionalProperties": false,
"example": {
"id": "118313c6-91e6-4b05-a537-5a1ab906418f",
"name": "Company-type only",
"description": "Applicable only when EntityType=Company",
"logicalOperation": "AND",
"operands": [
{
"fieldName": "EntityType",
"value": [
"string"
],
"valueType": "text",
"operation": "equal",
"operands": [ ]
}
]
}
},
"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`1"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
]
},
"CreateProductRequirementSetResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetDto"
},
{
"type": "object",
"properties": {
"defaultDataProtectionJurisdiction": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"CreateProductRequirementSetResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateProductRequirementSetResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateProductRequirementSetVersionFromSetIdResponse": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"format": "uuid"
},
"versionNumber": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CreateProductRequirementSetVersionFromSetIdResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateProductRequirementSetVersionFromSetIdResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateScopingRuleSetResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetDto"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"CreateScopingRuleSetResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateScopingRuleSetVersionFromSetIdResponse": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"format": "uuid"
},
"versionNumber": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CreateScopingRuleSetVersionFromSetIdResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionFromSetIdResponse"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"DataFieldDto": {
"required": [
"propertyName",
"propertyType"
],
"type": "object",
"properties": {
"propertyName": {
"minLength": 1,
"type": "string",
"description": "Property name",
"example": "firstName"
},
"propertyType": {
"minLength": 1,
"type": "string",
"description": "Property type",
"example": "text"
},
"propertyTypeId": {
"type": "string",
"description": "Property type id",
"format": "uuid",
"nullable": true,
"example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c"
},
"linkChildFieldPropertyName": {
"type": "string",
"description": "Linked child field property name",
"nullable": true,
"example": "productCategory"
},
"linkedParentFieldPropertyName": {
"type": "string",
"description": "Linked Parent field property name",
"nullable": true,
"example": "productCategory"
},
"formulaSchema": {
"allOf": [
{
"$ref": "#/components/schemas/FormulaSchemaDto"
}
],
"description": "Number formula schema",
"nullable": true
},
"dateTimePeriodFormulaSchema": {
"allOf": [
{
"$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto"
}
],
"description": "Date formula schema",
"nullable": true
},
"customActionProperties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.",
"nullable": true
},
"externalSearchApiProviderId": {
"type": "string",
"description": "ExternalSearchApiProviderId",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing data field metadata"
},
"DataValidationRulesDto": {
"type": "object",
"properties": {
"mandatory": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto"
}
],
"nullable": true
},
"specialCharacters": {
"allOf": [
{
"$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"noNumbers": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"onlyInteger": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"noNegative": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"onlyDecimal": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"regex": {
"allOf": [
{
"$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto"
}
],
"nullable": true
},
"characterLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"numberLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"noFutureDates": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"noPastDates": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"dateLimit": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2"
}
],
"description": "Validation rule that allows to set date range",
"nullable": true
},
"multiSelectLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto"
}
],
"nullable": true
},
"collectionMinimumCount": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"collectionMaximumCount": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"externalProvider": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"externalDataGroupProvider": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto"
}
],
"nullable": true
},
"readOnly": {
"allOf": [
{
"$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto"
}
],
"nullable": true
},
"conditionalLimit": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto"
}
],
"nullable": true
},
"timeZoneId": {
"type": "string",
"nullable": true
},
"disallowTodaysDate": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto"
}
],
"description": "Validation rule that does not allow todays date",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing validation data metadata"
},
"DateLimitRangeDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"relativeTo": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"field": {
"type": "string",
"nullable": true
},
"offset": {
"type": "string",
"nullable": true
},
"periodType": {
"type": "string",
"nullable": true
},
"offsetPeriod": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DateLimitRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"minDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DateLimitRuleDto2": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"minDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeFrom": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRangeDto"
}
],
"nullable": true
},
"rangeTo": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRangeDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"DateLimitRuleDto3": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"minDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DateLimitRuleDto4": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"nullable": true
},
"minDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeFrom": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRangeDto"
}
],
"nullable": true
},
"rangeTo": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRangeDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"DateLimitRuleDtoConditionalValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDto3"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DateLimitRuleDtoConditionalValidationRuleDto2": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDto4"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto2"
},
"nullable": true
}
},
"additionalProperties": false
},
"DateLimitRuleDtoConditionalValueDto": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDto3"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DateLimitRuleDtoConditionalValueDto2": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDto4"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DateTimePeriodFormulaSchemaDto": {
"required": [
"formulaSetId",
"formulaString"
],
"type": "object",
"properties": {
"formulaSetId": {
"minLength": 1,
"type": "string",
"description": "Formula set id",
"format": "uuid",
"example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c"
},
"versionNumber": {
"type": "integer",
"description": "Formula version number",
"format": "int32",
"nullable": true,
"example": 1
},
"formulaString": {
"minLength": 1,
"type": "string",
"description": "Formula string"
},
"dateTimePeriodFormulaVariables": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DateTimePeriodFormulaVariableDto"
},
"description": "Details of the formula schema",
"nullable": true
}
},
"additionalProperties": false
},
"DateTimePeriodFormulaVariableDto": {
"required": [
"value"
],
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true
},
"timePeriodKind": {
"type": "string",
"nullable": true
},
"value": {
"minLength": 1,
"type": "string"
},
"type": {
"type": "string",
"nullable": true
},
"timeZoneId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"EmptyRuleDto": {
"type": "object",
"additionalProperties": false
},
"EmptyRuleDtoConditionalValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/EmptyRuleDto"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmptyRuleDtoConditionalValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"EmptyRuleDtoConditionalValueDto": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/EmptyRuleDto"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ExternalProviderRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"providerId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
]
},
"ExternalProviderRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/EmptyRuleDto"
},
{
"type": "object",
"properties": {
"providerId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
]
},
"ExternalProviderRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalProviderRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FilterConditionDto": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"FormulaSchemaDto": {
"required": [
"formulaSetId",
"formulaString"
],
"type": "object",
"properties": {
"formulaSetId": {
"minLength": 1,
"type": "string",
"description": "Formula set id",
"format": "uuid",
"example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c"
},
"versionNumber": {
"type": "integer",
"description": "Formula set version number",
"format": "int32",
"nullable": true,
"example": 1
},
"formulaString": {
"minLength": 1,
"type": "string",
"description": "Formula string will be used to perform calculation",
"example": "$1 + $2"
},
"formulaVariables": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/FormulaVariableDto"
},
"description": "Metadata argument in formula string",
"nullable": true
}
},
"additionalProperties": false
},
"FormulaVariableDto": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
},
"filterConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterConditionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ItemCreatedDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the created item",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
}
},
"additionalProperties": false,
"description": "Response DTO representing created Item Instance"
},
"ItemCreatedDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemCreatedDto"
}
],
"description": "Response DTO representing created Item Instance",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"OwnershipValidationDataDto": {
"type": "object",
"properties": {
"isMandatory": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"description": "Mandatory requirement",
"nullable": true
},
"partyCount": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto"
}
],
"description": "What is the minimum number of relationships that need to be added in order for this requirement to be fulfilled?",
"nullable": true
},
"addAllParties": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"description": "Is the unwrapping requirement non-calculable?",
"nullable": true
},
"idvIsMandatory": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"description": "Mandatory ID&V",
"nullable": true
},
"idvPartyCount": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto"
}
],
"description": "What is the minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled?",
"nullable": true
},
"idvAllParties": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"description": "Do all entities that meet the criteria of this requirement need to be ID&Vd?",
"nullable": true
}
},
"additionalProperties": false
},
"OwnershipValidationRuleDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the ownership validation rule",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"setId": {
"type": "string",
"description": "The UiD of the requirement set",
"format": "uuid",
"example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3"
},
"ownershipValidationData": {
"allOf": [
{
"$ref": "#/components/schemas/OwnershipValidationDataDto"
}
],
"description": "Ownership Validation Data - set of validation rules specific to ownership requirement",
"nullable": true
}
},
"additionalProperties": false
},
"ProductRequirementDto": {
"required": [
"category",
"entityType",
"jurisdiction",
"type"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The UiD of the requirement",
"format": "uuid",
"example": "84ec28e2-d786-417b-850f-96321dd849dd"
},
"requirementSetId": {
"type": "string",
"description": "The UiD of the requirement set",
"format": "uuid",
"example": "228313c6-91e6-4b05-a537-5a1ab906418f"
},
"category": {
"minLength": 1,
"type": "string",
"description": "Requirement business category",
"example": "Basic Details"
},
"description": {
"type": "string",
"description": "Requirement description",
"nullable": true,
"example": "This is the client first name"
},
"template": {
"type": "string",
"description": "Requirement template",
"nullable": true,
"example": "Product"
},
"entityType": {
"minLength": 1,
"type": "string",
"description": "Requirement entity type",
"example": "Individual"
},
"name": {
"type": "string",
"description": "Requirement name",
"nullable": true,
"example": "First Name"
},
"order": {
"type": "number",
"description": "Requirement the order which the field will appears",
"format": "double",
"nullable": true,
"example": 1
},
"isSensitiveData": {
"type": "boolean",
"description": "Requirement sensitive data flag",
"example": true
},
"isMaterialData": {
"type": "boolean",
"description": "Requirement material data flag",
"example": true
},
"isCoreDefinition": {
"type": "boolean",
"description": "Requirement is defined as core\nand cannot be deleted or altered",
"example": false
},
"isIndexable": {
"type": "boolean",
"description": "Requirement is data indexed for search flag",
"example": true
},
"isSecondaryIdentifier": {
"type": "boolean",
"description": "Is this requirement used to search and filter on products",
"example": true
},
"jurisdiction": {
"minLength": 1,
"type": "string",
"description": "Requirement jurisdiction",
"example": "Global"
},
"dataProtectionJurisdiction": {
"type": "string",
"description": "Jurisdiction for data protection",
"nullable": true,
"example": "Global"
},
"classification": {
"type": "string",
"description": "Requirement classification",
"nullable": true,
"example": "Customer Profiling"
},
"isReadOnly": {
"type": "boolean",
"description": "Read-only flag",
"example": true
},
"isMandatory": {
"type": "boolean",
"description": "Requirement mandatory flag",
"example": true
},
"targetEntity": {
"type": "string",
"description": "Requirement target entity",
"nullable": true,
"example": "Client"
},
"type": {
"minLength": 1,
"type": "string",
"description": "Requirement type",
"example": "Data"
},
"documentDescription": {
"type": "string",
"description": "Requirement document description",
"nullable": true,
"example": "Articles of Incorporation"
},
"documentDataKey": {
"type": "string",
"description": "Requirement document datakey",
"nullable": true,
"example": "Passport"
},
"acceptableDocumentTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Acceptable document types for the document requirement",
"nullable": true
},
"partyType": {
"type": "string",
"description": "Requirement party type",
"nullable": true,
"example": "Shareholder",
"deprecated": true
},
"partyTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Requirement party types",
"nullable": true
},
"partyCount": {
"type": "integer",
"description": "Requirement party count",
"format": "int32",
"nullable": true,
"example": 1,
"deprecated": true
},
"uboThreshold": {
"type": "number",
"description": "Requirement UBO threshold",
"format": "double",
"nullable": true,
"example": 10
},
"ownershipDataKey": {
"type": "string",
"description": "The datakey that is used to identify this requirement",
"nullable": true,
"example": "seniorManagersRequirement"
},
"sourceEntityType": {
"type": "string",
"description": "Any of the related party entity types selected can be counted toward this requirement",
"nullable": true,
"example": "Individual",
"deprecated": true
},
"relatedPartyEntityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Requirement related party entity types",
"nullable": true
},
"directAssociationsOnly": {
"type": "boolean",
"description": "When enabled, only related parties directly associated to the main client entity will be counted towards this requirement",
"example": true
},
"idvOn": {
"type": "boolean",
"description": "Is there an ID&V element applicable to this requirement?",
"example": true
},
"idvName": {
"type": "string",
"description": "Name of the ID&V requirement and label which will be applied to the ID&V chip",
"nullable": true,
"example": "ID&V 1 Senior Manager"
},
"idvTooltip": {
"type": "string",
"description": "Tooltip description of the ID&V requirement",
"nullable": true,
"example": "At Least one CEO, CFO, COO, CTO, Board Member or Executive Director must be ID&Vd"
},
"ownershipValidationRule": {
"allOf": [
{
"$ref": "#/components/schemas/OwnershipValidationRuleDto"
}
],
"description": "Ownership requirement validation data",
"nullable": true
},
"dataField": {
"allOf": [
{
"$ref": "#/components/schemas/DataFieldDto"
}
],
"description": "Requirement data field",
"nullable": true
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceDto"
},
"description": "Requirement references list",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Requirement conditions list",
"nullable": true
},
"validationRule": {
"allOf": [
{
"$ref": "#/components/schemas/ValidationRuleDto"
}
],
"description": "Requirement validation data",
"nullable": true
},
"validationRulesV2": {
"allOf": [
{
"$ref": "#/components/schemas/DataValidationRulesDto"
}
],
"description": "Data requirement validation rules V2",
"nullable": true
},
"defaultValue": {
"type": "string",
"nullable": true
},
"documentAccessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Access layers determining the access to the document",
"nullable": true
},
"conditionalValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionalValueDto"
},
"description": "List of conditional values",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags",
"nullable": true
},
"fieldAccessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Access layers determining the access to the field",
"nullable": true
},
"defaultDateType": {
"type": "string",
"description": "Default Date Type e.g. Standard Default Value",
"nullable": true,
"example": "true"
},
"isTotalProductColumn": {
"type": "boolean",
"description": "Specifies is field is going to be displayed with a total summation",
"example": true
},
"uiDecoration": {
"type": "string",
"description": "Determines how the requirement should be rendered\nnull",
"nullable": true
},
"clearValueIfTriggerConditionNotMet": {
"type": "boolean",
"description": "When enabled, the field value is cleared if its trigger condition is not met",
"example": true
}
},
"additionalProperties": false,
"description": "Request DTO representing product requirement metadata"
},
"ProductRequirementDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementDto"
}
],
"description": "Request DTO representing product requirement metadata",
"nullable": true
}
},
"additionalProperties": false
},
"ProductRequirementSetDto": {
"allOf": [
{
"$ref": "#/components/schemas/CommonRequirementSetDto"
},
{
"type": "object",
"properties": {
"created": {
"type": "string",
"description": "The creation date of the version (Read-only)",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"requirements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductRequirementDto"
},
"description": "List of requirements",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Request DTO representing product requirement set data"
},
"ProductRequirementSetDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetDto"
}
],
"description": "Request DTO representing product requirement set data",
"nullable": true
}
},
"additionalProperties": false
},
"ProductRequirementSetDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetDto"
}
],
"description": "Request DTO representing product requirement set data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProductRequirementSetVersionSignResponse": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"description": "The UiD of the product requirement set",
"format": "uuid"
},
"versionNumber": {
"type": "integer",
"description": "The number of the version that has been signed",
"format": "int32",
"example": 2
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The new version status",
"example": "Rejected"
}
},
"additionalProperties": false,
"description": "Sign product requirement set response contains the new version status"
},
"ProductRequirementSetVersionSignResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementSetVersionSignResponse"
}
],
"description": "Sign product requirement set response contains the new version status",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ReferenceDto": {
"type": "object",
"properties": {
"type": {
"maxLength": 256,
"type": "string",
"description": "Reference type",
"nullable": true,
"example": "FATCA"
},
"description": {
"maxLength": 2048,
"type": "string",
"description": "Reference description",
"nullable": true,
"example": "Foreign Account Tax Compliance Act"
},
"url": {
"maxLength": 2048,
"type": "string",
"description": "Reference URL",
"nullable": true,
"example": "www.irs.gov"
}
},
"additionalProperties": false,
"description": "Request DTO representing reference metadata"
},
"RegexRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"isCaseSensitive": {
"type": "boolean"
},
"regexValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"RegexRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"isCaseSensitive": {
"type": "boolean"
},
"regexValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"RegexRuleDtoConditionalValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/RegexRuleDto2"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegexRuleDtoConditionalValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RegexRuleDtoConditionalValueDto": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/RegexRuleDto2"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ScopingRuleSetDto": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
},
{
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleType"
}
],
"description": "Type of the scoping rule",
"nullable": true,
"example": "ProductJourney"
}
},
"additionalProperties": false
}
]
},
"ScopingRuleSetDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleSetVersionDto": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"description": "The UiD of the data scoping rule set",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"versionId": {
"type": "string",
"description": "The UiD of the data scoping rule set version",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "scoping rule set name",
"nullable": true,
"example": "Fenergo ScopingRuleSet"
},
"uniqueIdentifier": {
"type": "string",
"description": "scoping rule set uniqueIdentifier",
"nullable": true,
"example": "Global"
},
"separateJourneyPerProduct": {
"type": "boolean",
"description": "scoping rule set separateJourneyPerProduct",
"example": false
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the scoping rule set can be applied",
"nullable": true
},
"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"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"created": {
"type": "string",
"description": "The creation date of the version (Read-only)",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
}
},
"additionalProperties": false,
"description": "Request DTO representing product scoping rule set data"
},
"ScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
}
],
"description": "Request DTO representing product scoping rule set data",
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleSetVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
}
],
"description": "Request DTO representing product scoping rule set data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleSetVersionSignResponse": {
"type": "object",
"properties": {
"setId": {
"type": "string",
"description": "The UiD of the scoping rule set",
"format": "uuid"
},
"versionNumber": {
"type": "integer",
"description": "The number of the version that has been signed",
"format": "int32",
"example": 2
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The new version status",
"example": "Rejected"
}
},
"additionalProperties": false,
"description": "Sign scoping rule set response contains the new version status"
},
"ScopingRuleSetVersionSignResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionSignResponse"
}
],
"description": "Sign scoping rule set response contains the new version status",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleType": {
"enum": [
"TaskDisplay",
"ProductJourney"
],
"type": "string"
},
"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
},
"SpecialCharactersRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"excludedCharacters": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SpecialCharactersRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"excludedCharacters": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SpecialCharactersRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/SpecialCharactersRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"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`1": {
"type": "object",
"additionalProperties": false
},
"UpdateProductRequirementDto": {
"allOf": [
{
"$ref": "#/components/schemas/ProductRequirementDto"
},
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Current version of Data Group aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
}
},
"additionalProperties": false
}
],
"description": "Request DTO representing requirement metadata"
},
"UpdateProductRequirementDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateProductRequirementDto"
}
],
"description": "Request DTO representing requirement metadata",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProductRequirementDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateProductRequirementDto"
}
],
"description": "Request DTO representing requirement metadata",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProductRequirementSetVersionDto": {
"allOf": [
{
"$ref": "#/components/schemas/CommonRequirementSetDto"
},
{
"type": "object",
"properties": {
"requirements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductRequirementDto"
},
"description": "List of requirements",
"nullable": true
},
"defaultDataProtectionJurisdiction": {
"type": "string",
"description": "Default data protection jurisdiction for requirement set",
"nullable": true,
"example": "Global"
},
"version": {
"type": "integer",
"description": "Current version of Data Group aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
}
},
"additionalProperties": false
}
],
"description": "Request DTO representing set of properties which define a new version of product requirement set"
},
"UpdateProductRequirementSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateProductRequirementSetVersionDto"
}
],
"description": "Request DTO representing set of properties which define a new version of product requirement set",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateScopingRuleSetVersionDto": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
},
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Current version of Scoping Rule Set aggregate where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
}
},
"additionalProperties": false
}
],
"description": "Request DTO representing set of properties which define a new version of scoping rule set"
},
"UpdateScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDto"
}
],
"description": "Request DTO representing set of properties which define a new version of scoping rule set",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationDataDto": {
"type": "object",
"properties": {
"isMandatory": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"specialCharacters": {
"allOf": [
{
"$ref": "#/components/schemas/SpecialCharactersRuleDto"
}
],
"nullable": true
},
"noNumbers": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"onlyInteger": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"noNegative": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"onlyDecimal": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"regex": {
"allOf": [
{
"$ref": "#/components/schemas/RegexRuleDto"
}
],
"nullable": true
},
"characterLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto"
}
],
"nullable": true
},
"numberLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto"
}
],
"nullable": true
},
"noFutureDates": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"noPastDates": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"nullable": true
},
"dateLimit": {
"allOf": [
{
"$ref": "#/components/schemas/DateLimitRuleDto2"
}
],
"description": "Validation rule that allows to set date range",
"nullable": true
},
"multiSelectLimit": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto"
}
],
"nullable": true
},
"collectionMinimumCount": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMinimumCountRuleDto"
}
],
"nullable": true
},
"collectionMaximumCount": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionMaximumCountRuleDto"
}
],
"nullable": true
},
"externalProvider": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalProviderRuleDto"
}
],
"nullable": true
},
"externalDataGroupProvider": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalProviderRuleDto"
}
],
"nullable": true
},
"disallowTodaysDate": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
}
],
"description": "Validation rule that does not allow todays date",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing validation data metadata"
},
"ValidationRuleDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the validation rule",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"setId": {
"type": "string",
"description": "The UiD of the requirement set/data group",
"format": "uuid",
"example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3"
},
"propertyId": {
"type": "string",
"description": "The UiD of the requirement/data group field",
"format": "uuid",
"example": "450df9bf-b2d3-48cf-ab8d-481c69b74373"
},
"dataGroupId": {
"type": "string",
"description": "The UiD of the of data group - is set only when requirement/data group field propertyType is set to \"dataGroup\"",
"format": "uuid",
"nullable": true,
"example": "8eb83ec6-1539-46a9-b0ba-c5138a09580c"
},
"isDataGroup": {
"type": "boolean",
"description": "Flag indicating it is validation rules for data group field",
"example": true
},
"propertyName": {
"type": "string",
"description": "Requirement/data group field property name",
"nullable": true,
"example": "firstName"
},
"friendlyName": {
"type": "string",
"description": "Requirement/data group field friendly Name",
"nullable": true,
"example": "First Name"
},
"validationType": {
"type": "string",
"description": "Validation type",
"nullable": true,
"example": "text"
},
"validationData": {
"allOf": [
{
"$ref": "#/components/schemas/ValidationDataDto"
}
],
"description": "Validation Data - set of validation rules specific to requirement/data group field",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing validation rule metadata"
},
"ValueField": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true
},
"field": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValueLimitRuleDto": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto"
},
{
"type": "object",
"properties": {
"minValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ValueLimitRuleDto2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRuleDto2"
},
{
"type": "object",
"properties": {
"minValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ValueLimitRuleDtoConditionalValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto2"
}
],
"nullable": true
},
"dynamicRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ValueLimitRuleDtoConditionalValueDto": {
"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": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto2"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ValueLimitRuleDtoValidationRuleDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"staticRule": {
"allOf": [
{
"$ref": "#/components/schemas/ValueLimitRuleDto2"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}