openapi: 3.2.0 info: title: Fenergo Scoping Rule Set API version: '1.0' description: 'Operations tagged ScopingRuleSet across 15 of this provider''s published API definitions: fenergo-digitalidvcommand-v1-0-openapi.json, fenergo-digitalidvcommand-v2-0-openapi.json, fenergo-digitalidvquery-v1-0-openapi.json, fenergo-digitalidvquery-v2-0-openapi.json, fenergo-productpolicycommand-v1-0-openapi.json, fenergo-productpolicyquery-v1-0-openapi.json, fenergo-riskcommand-v1-0-openapi.json, fenergo-riskquery-v1-0-openapi.json, fenergo-screeningcommand-v1-0-openapi.json…' servers: - url: /digitalidvcommand - url: /digitalidvquery - url: /productpolicycommand - url: /productpolicyquery - url: /riskcommand - url: /riskquery - url: /screeningcommand - url: /screeningquery security: - Bearer: [] tags: - name: ScopingRuleSet paths: /api/scoping-rule-set: post: tags: - ScopingRuleSet summary: Create scoping rule set description: 'Creates a new scoping rule set with a first draft version. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: IdvConfigurationEdit' 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/CreateScopingRuleSetDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set created content: text/plain: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - ScopingRuleSet summary: Get all scoping rule sets description: 'Returns the list of all scoping rule sets. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: GetAllScopingRuleSetsLite parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of lite scoping rule sets is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}: post: tags: - ScopingRuleSet summary: Create scoping rule set version description: 'Creates a new version of an existing scoping rule set. Assigns the next available version number. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: CreateScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version created content: text/plain: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - ScopingRuleSet summary: Delete scoping rule set and all its versions description: 'Deletes an existing scoping rule set and all its versions. Required permissions: Following permissions are required: IdvConfigurationDelete' operationId: DeleteScopingRuleSet parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - ScopingRuleSet summary: Get the current scoping rule set version by scopingRuleSetId description: 'Returns the active, currently in effect, published version of scoping rule set for a given rule set id. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: GetCurrentScopingRuleSetVersionByRuleSetId parameters: - name: scopingRuleSetId in: path description: 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: '200': description: Success. An instance of scoping rule set is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}: put: tags: - ScopingRuleSet summary: Update scoping rule set version description: 'Updates an existing scoping rule set version. Only draft versions are allowed to be updated. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: UpdateScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version updated content: text/plain: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. 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 '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - ScopingRuleSet summary: Delete scoping rule set version description: 'Deletes the selected version of an existing scoping rule set. If the version is the last one, then the version number of it will become the next available one for the model. Required permissions: Following permissions are required: IdvConfigurationDelete' operationId: DeleteScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - ScopingRuleSet summary: Get scoping rule set version by scopingRuleSetId and versionNumber description: 'Returns scoping rule set version for a given id and version number. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: GetScopingRuleSetVersionByRuleSetIdAndVersionNumber parameters: - name: scopingRuleSetId in: path description: Scoping rule set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Scoping rule 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 responses: '200': description: Success. Scoping rule set is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/clone: post: tags: - ScopingRuleSet summary: Clone scoping rule set version description: 'Clones the selected version of an existing scoping rule set and creates a new model with a single version. The new version contains all the data of the original selected one, will have the default status of draft and the author as the only required signee. Returns the id of the cloned data group version. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: CloneScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version cloned content: text/plain: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/submit-for-approval: put: tags: - ScopingRuleSet summary: Submit scoping rule set version for approval description: 'Submits the selected version of an existing scoping rule set for approval. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: SubmitScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/sign: put: tags: - ScopingRuleSet summary: Sign scoping rule set version description: 'Signs the selected version of an existing scoping rule set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: IdvConfigurationApprove' operationId: SignScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version signed content: text/plain: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/archive: put: tags: - ScopingRuleSet summary: Archive scoping rule set version description: 'Archives the selected version of an existing scoping rule set. Required permissions: Following permissions are required: IdvConfigurationArchive' operationId: ArchiveScopingRuleSetVersion parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version archived '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. 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 servers: - url: /digitalidvcommand /api/v2/scoping-rule-set: post: tags: - ScopingRuleSet summary: Create scoping rule set description: 'Creates a new scoping rule set with a first draft version. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: postApiV2ScopingRuleSet 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/CreateScopingRuleSetDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set created content: text/plain: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateScopingRuleSet get: tags: - ScopingRuleSet summary: Get all scoping rule sets description: 'Returns the list of all scoping rule sets. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: getApiV2ScopingRuleSet parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of lite scoping rule sets is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAllScopingRuleSetsLite servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}: post: tags: - ScopingRuleSet summary: Create scoping rule set version description: 'Creates a new version of an existing scoping rule set. Assigns the next available version number. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: postApiV2ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version created content: text/plain: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete scoping rule set and all its versions description: 'Deletes an existing scoping rule set and all its versions. Required permissions: Following permissions are required: IdvConfigurationDelete' operationId: deleteApiV2ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSet get: tags: - ScopingRuleSet summary: Get the current scoping rule set version by scopingRuleSetId description: 'Returns the active, currently in effect, published version of scoping rule set for a given rule set id. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: getApiV2ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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: '200': description: Success. An instance of scoping rule set is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetCurrentScopingRuleSetVersionByRuleSetId servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}: put: tags: - ScopingRuleSet summary: Update scoping rule set version description: 'Updates an existing scoping rule set version. Only draft versions are allowed to be updated. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: putApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version updated content: text/plain: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. 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 '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete scoping rule set version description: 'Deletes the selected version of an existing scoping rule set. If the version is the last one, then the version number of it will become the next available one for the model. Required permissions: Following permissions are required: IdvConfigurationDelete' operationId: deleteApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSetVersion get: tags: - ScopingRuleSet summary: Get scoping rule set version by scopingRuleSetId and versionNumber description: 'Returns scoping rule set version for a given id and version number. Required permissions: Following permissions are required: IdvConfigurationAccess' operationId: getApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: Scoping rule set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Scoping rule 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 responses: '200': description: Success. Scoping rule set is returned content: text/plain: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScopingRuleSetVersionByRuleSetIdAndVersionNumber servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/clone: post: tags: - ScopingRuleSet summary: Clone scoping rule set version description: 'Clones the selected version of an existing scoping rule set and creates a new model with a single version. The new version contains all the data of the original selected one, will have the default status of draft and the author as the only required signee. Returns the id of the cloned data group version. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: postApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberClone parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version cloned content: text/plain: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CloneScopingRuleSetVersion servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/submit-for-approval: put: tags: - ScopingRuleSet summary: Submit scoping rule set version for approval description: 'Submits the selected version of an existing scoping rule set for approval. Required permissions: Following permissions are required: IdvConfigurationEdit' operationId: putApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberSubmitForApproval parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SubmitScopingRuleSetVersion servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/sign: put: tags: - ScopingRuleSet summary: Sign scoping rule set version description: 'Signs the selected version of an existing scoping rule set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: IdvConfigurationApprove' operationId: putApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberSign parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' description: Service request data responses: '202': description: Success. Scoping rule set version signed content: text/plain: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SignScopingRuleSetVersion servers: - url: /digitalidvcommand /api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/archive: put: tags: - ScopingRuleSet summary: Archive scoping rule set version description: 'Archives the selected version of an existing scoping rule set. Required permissions: Following permissions are required: IdvConfigurationArchive' operationId: putApiV2ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberArchive parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version archived '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' text/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. 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 x-operation-id-source: normalized x-operation-id-original: ArchiveScopingRuleSetVersion servers: - url: /digitalidvcommand /api/scoping-rule-set/{setId}: post: tags: - ScopingRuleSet summary: Create product scoping rule set version description: 'Creates a new version of an existing product scoping rule set. Assigns the next available version number. The new version initializes with the provided data, has the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: ProductConfigurationEdit' operationId: postApiScopingRuleSetBySetId 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_2' '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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete product scoping rule set and all its versions description: 'Deletes an existing product scoping rule set and all its versions. Required permissions: Following permissions are required: ProductConfigurationDelete' operationId: deleteApiScopingRuleSetBySetId 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSet get: tags: - ScopingRuleSet summary: Get scoping rule set by id description: 'Returns the active, currently in effect, published scoping rule set version for a given id. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetScopingRuleSetById parameters: - name: setId in: path description: Scoping rule set id required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicycommand /api/scoping-rule-set/{setId}/version/{versionNumber}/draft: post: tags: - ScopingRuleSet summary: Create product scoping rule set version from provided set id description: 'Creates a new version of an existing product scoping rule set. Assigns the next available version number. The new version initializes with the latest published product scoping rule set data, has the default status of draft and the author as the only required signee. 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicycommand /api/scoping-rule-set/{setId}/version/{versionNumber}: put: tags: - ScopingRuleSet summary: Update product scoping rule set version description: 'Updates 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: putApiScopingRuleSetBySetIdVersionByVersionNumber 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_2' 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_2' 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete product scoping rule set version description: 'Deletes the selected version of an existing product scoping rule set. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as deleted and become unavailable. Required permissions: Following permissions are required: ProductConfigurationDelete' operationId: deleteApiScopingRuleSetBySetIdVersionByVersionNumber 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSetVersion get: tags: - ScopingRuleSet summary: Get scoping rule set by id and version description: 'Returns scoping rule set for a given id and version number. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetScopingRuleSetVersionById parameters: - name: setId in: path description: scoping rule set id required: true schema: type: string - name: versionNumber in: path description: scoping rule 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 responses: '200': description: Success. scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_3' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found. scoping rule set with given id/version does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicycommand /api/scoping-rule-set/{setId}/version/{versionNumber}/submit-for-approval: put: tags: - ScopingRuleSet summary: Submit product scoping rule set version for approval description: 'Submits the selected version of an existing product scoping rule set for approval. Required permissions: Following permissions are required: ProductConfigurationEdit' operationId: putApiScopingRuleSetBySetIdVersionByVersionNumberSubmitForApproval 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SubmitScopingRuleSetVersion servers: - url: /productpolicycommand /api/scoping-rule-set/{setId}/version/{versionNumber}/sign: put: tags: - ScopingRuleSet summary: Sign product scoping rule set version description: 'Signs 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: putApiScopingRuleSetBySetIdVersionByVersionNumberSign 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_2' 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SignScopingRuleSetVersion servers: - url: /productpolicycommand /api/scoping-rule-set/{setId}/version/{versionNumber}/archive: put: tags: - ScopingRuleSet summary: Archive product scoping rule set version description: 'Archives the selected version of an existing product scoping rule set. Required permissions: Following permissions are required: ProductConfigurationArchive' operationId: putApiScopingRuleSetBySetIdVersionByVersionNumberArchive 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_2' 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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: ArchiveScopingRuleSetVersion servers: - url: /productpolicycommand /api/scoping-rule-set/activeVersions: get: tags: - ScopingRuleSet summary: Get active scoping rule sets description: 'Returns active scoping rule sets. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetActiveScopingRuleSetVersions parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicyquery /api/scoping-rule-set/activeVersions/{type}: get: tags: - ScopingRuleSet summary: Get active scoping rule sets by type description: 'Returns active scoping rule sets by type. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetActiveScopingRuleSetVersionsByType parameters: - name: type in: path required: true schema: allOf: - $ref: '#/components/schemas/ScopingRuleType' - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_3' 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_3' 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_3' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicyquery /api/v3/scoping-rule-set: post: tags: - ScopingRuleSet summary: Create scoping rule set description: 'Creates a new scoping rule set with a first draft version. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: ScreeningConfigurationCreate' operationId: postApiV3ScopingRuleSet 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/CreateScopingRuleSetDtoServiceRequest_5' responses: '202': description: Success. Scoping rule set created content: application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse_5' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateScopingRuleSet get: tags: - ScopingRuleSet summary: Get all scoping rule sets description: 'Returns the list of all scoping rule sets. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV3ScopingRuleSet parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of lite scoping rule sets is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse_5' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_9' '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_11' 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_11' 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_11' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAllScopingRuleSetsLite servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}: post: tags: - ScopingRuleSet summary: Create scoping rule set version description: 'Creates a new version of an existing scoping rule set. Assigns the next available version number. The new version is initialized with the provided data, a default "Draft" status and the author as the only required signee. Required permissions: Following permissions are required: ScreeningConfigurationEdit' operationId: postApiV3ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest_5' responses: '202': description: Success. Scoping rule set version created content: application/json: schema: $ref: '#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete scoping rule set and all its versions description: 'Deletes an existing scoping rule set and all its versions. Required permissions: Following permissions are required: ScreeningConfigurationDelete' operationId: deleteApiV3ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSet get: tags: - ScopingRuleSet summary: Get the current scoping rule set version by scopingRuleSetId description: 'Returns the active, currently in effect, published version of scoping rule set for a given rule set id. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV3ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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: '200': description: Success. An instance of scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_7' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_11' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_9' '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_11' 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_11' 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_11' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetCurrentScopingRuleSetVersionByRuleSetId servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}: put: tags: - ScopingRuleSet summary: Update scoping rule set version description: 'Updates an existing scoping rule set version. Only draft versions are allowed to be updated. Required permissions: Following permissions are required: ScreeningConfigurationEdit' operationId: putApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest_6' responses: '202': description: Success. Scoping rule set version updated content: application/json: schema: $ref: '#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. 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_8' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateScopingRuleSetVersion delete: tags: - ScopingRuleSet summary: Delete scoping rule set version description: 'Deletes the selected version of an existing scoping rule set. If the version is the last one, then the version number of it will become the next available one for the model. Required permissions: Following permissions are required: ScreeningConfigurationDelete' operationId: deleteApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version deleted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteScopingRuleSetVersion get: tags: - ScopingRuleSet summary: Get scoping rule set version by scopingRuleSetId and versionNumber description: 'Returns scoping rule set version for a given id and version number. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: Scoping rule set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Scoping rule 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 responses: '200': description: Success. Scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_7' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_11' example: data: {} messages: - message: Not Found. Scoping rule set with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_9' '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_11' 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_11' 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_11' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScopingRuleSetVersionByRuleSetIdAndVersionNumber servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/clone: post: tags: - ScopingRuleSet summary: Clone scoping rule set version description: 'Clones the selected version of an existing scoping rule set and creates a new model with a single version. The new version contains all the data of the original selected one, will have the default status of draft and the author as the only required signee. Returns the id of the cloned data group version. Required permissions: Following permissions are required: ScreeningConfigurationCreate' operationId: postApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberClone parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest_6' responses: '202': description: Success. Scoping rule set version cloned content: application/json: schema: $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CloneScopingRuleSetVersion servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/submit-for-approval: put: tags: - ScopingRuleSet summary: Submit scoping rule set version for approval description: 'Submits the selected version of an existing scoping rule set for approval. Required permissions: Following permissions are required: ScreeningConfigurationEdit' operationId: putApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberSubmitForApproval parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version submitted '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SubmitScopingRuleSetVersion servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/sign: put: tags: - ScopingRuleSet summary: Sign scoping rule set version description: 'Signs the selected version of an existing scoping rule set and changes the version status accordingly to the action (Approve/Reject). Required permissions: Following permissions are required: ScreeningConfigurationApprove' operationId: putApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberSign parameters: - name: scopingRuleSetId in: path description: 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 scoping rule set version request content: application/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest_6' responses: '202': description: Success. Scoping rule set version signed content: application/json: schema: $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse_5' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: SignScopingRuleSetVersion servers: - url: /screeningcommand /api/v3/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/archive: put: tags: - ScopingRuleSet summary: Archive scoping rule set version description: 'Archives the selected version of an existing scoping rule set. Required permissions: Following permissions are required: ScreeningConfigurationArchive' operationId: putApiV3ScopingRuleSetByScopingRuleSetIdVersionByVersionNumberArchive parameters: - name: scopingRuleSetId in: path description: 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. Scoping rule set version archived '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_6' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_8' example: data: {} messages: - message: Not Found. 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_8' 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_8' 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_8' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: ArchiveScopingRuleSetVersion servers: - url: /screeningcommand /api/v4/scoping-rule-set: get: tags: - ScopingRuleSet summary: Get all scoping rule sets description: 'Returns the list of all scoping rule sets. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV4ScopingRuleSet parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of lite scoping rule sets is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse_6' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_10' '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_12' 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_12' 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_12' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAllScopingRuleSetsLite servers: - url: /screeningquery /api/v4/scoping-rule-set/{scopingRuleSetId}: get: tags: - ScopingRuleSet summary: Get the current scoping rule set version by scopingRuleSetId description: 'Returns the active, currently in effect, published version of scoping rule set for a given rule set id. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV4ScopingRuleSetByScopingRuleSetId parameters: - name: scopingRuleSetId in: path description: 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: '200': description: Success. An instance of scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_8' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_12' example: data: {} messages: - message: Not Found. Scoping rule set with given id does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_10' '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_12' 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_12' 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_12' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetCurrentScopingRuleSetVersionByRuleSetId servers: - url: /screeningquery /api/v4/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}: get: tags: - ScopingRuleSet summary: Get scoping rule set version by scopingRuleSetId and versionNumber description: 'Returns scoping rule set version for a given id and version number. Required permissions: Following permissions are required: ScreeningConfigurationAccess' operationId: getApiV4ScopingRuleSetByScopingRuleSetIdVersionByVersionNumber parameters: - name: scopingRuleSetId in: path description: Scoping rule set id required: true schema: type: string format: uuid - name: versionNumber in: path description: Scoping rule 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 responses: '200': description: Success. Scoping rule set is returned content: application/json: schema: $ref: '#/components/schemas/ScopingRuleSetVersionDtoServiceResponse_8' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse_12' example: data: {} messages: - message: Not Found. Scoping rule set with given id/version does not exist type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_10' '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_12' 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_12' 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_12' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetScopingRuleSetVersionByRuleSetIdAndVersionNumber servers: - url: /screeningquery components: schemas: 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 additionalProperties: false description: Service request data CloneScopingRuleSetVersionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDto' description: Cloned scoping rule set response data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CloneScopingRuleSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto' description: Request DTO representing clone scoping rule set data additionalProperties: false description: Service request data SigneeDto: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false description: Defines a version Signee CreateScopingRuleSetDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto' description: DTO representing scoping rule set data needed for creation additionalProperties: false description: Service request data UpdateScopingRuleSetVersionDto: type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' notes: type: - string - 'null' description: Notes related to the Related Party Scoping Rules Version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the schema can be used version: type: integer description: 'Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on 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 ConditionDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root CreateScopingRuleSetVersionDto: type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' notes: type: - string - 'null' description: Notes related to the Related Party Scoping Rules Version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the schema can be used additionalProperties: false description: DTO representing scoping rule set data needed for version creation ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false CloneScopingRuleSetVersionResponseDto: type: object properties: scopingRuleSetId: type: string description: Id of the cloned scoping rule set format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 additionalProperties: false description: Cloned scoping rule set response data CloneScopingRuleSetVersionDto: required: - name type: object properties: name: minLength: 1 type: string description: Name of new scoping rule set example: Shareholder Scoping Rules additionalProperties: false description: Request DTO representing clone scoping rule set data Decision: enum: - Approve - Reject type: string SignScopingRuleSetVersionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDto' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateScopingRuleSetResponseDto: type: object properties: version: type: integer description: Scoping rule set aggregate version after update format: int32 example: 4 additionalProperties: false description: Response DTO representing updated scoping rule set ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' description: The service request DTO additionalProperties: false description: Service request data ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false CreateScopingRuleSetDto: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto' - required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global additionalProperties: false description: DTO representing scoping rule set data needed for creation ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition CreateScopingRuleSetResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponseDto' description: DTO representing scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CreateScopingRuleSetResponseDto: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto' - required: - signees type: object properties: scopingRuleSetId: type: string description: The UiD of scoping rule set format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 versionNumber: type: integer description: The version number format: int32 example: 1 created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-01-05T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft signees: type: array items: $ref: '#/components/schemas/SigneeDto' description: The defined list of signees for the version additionalProperties: false description: DTO representing scoping rule set data ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string SignScopingRuleSetVersionResponseDto: type: object properties: scopingRuleSetId: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f 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 ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response UpdateScopingRuleSetResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetResponseDto' description: Response DTO representing updated scoping rule set messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false CreateScopingRuleSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto' description: DTO representing scoping rule set data needed for version creation additionalProperties: false description: Service request data ScopingRuleSetLiteDto: required: - name type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Scoping rule set name example: Global versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto' description: Versions associated to the scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoping Rule Set ScopingRuleSetLiteVersionDto: required: - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 notes: type: - string - 'null' description: Notes related to the Related Party Scoping Rules Version example: Version Notes additionalProperties: false description: Represents a lite version of a Scoping Rule Set version ScopingRuleSetLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ScopingRuleSetVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ScopingRuleSetVersionDto: allOf: - $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto' - required: - signees type: object properties: signees: type: array items: $ref: '#/components/schemas/SigneeDto' description: The defined list of signees for the version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions under which the schema can be used additionalProperties: false description: Response DTO representing scoping rule set version data UpdateScopingRuleSetVersionDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDto_2' description: Request DTO representing set of properties which define a new version of scoping rule set 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 CreateScopingRuleSetResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false CloneScopingRuleSetVersionDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto_2' additionalProperties: false Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false CloneScopingRuleSetVersionResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponse' description: Request DTO representing clone scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false UpdateScopingRuleSetVersionDto_2: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_2' - 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 ScopingRuleType: enum: - TaskDisplay - ProductJourney type: string CreateScopingRuleSetVersionFromSetIdResponse: type: object properties: setId: type: string format: uuid versionNumber: type: integer format: int32 additionalProperties: false ConditionDto_2: required: - logicalOperation - name - operands type: object properties: id: type: string format: uuid name: minLength: 1 type: string description: type: - string - 'null' logicalOperation: minLength: 1 type: string operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto_2' 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: [] ScopingRuleSetVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_2' description: Request DTO representing product scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false ValueField_2: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ScopingRuleSetVersionDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_2' description: Request DTO representing product scoping rule set data additionalProperties: false ScopingRuleSetVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionSignResponse' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false CloneScopingRuleSetVersionDto_2: type: object properties: name: type: - string - 'null' description: Scoping Rule Set Name example: Loans in USA uniqueIdentifier: type: - string - 'null' description: Scoping Rule Set UniqueIdentifier example: Global additionalProperties: false ApproveActionServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse_2: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false ScopingRuleSetVersionDto_2: 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 - 'null' description: scoping rule set name example: Fenergo ScopingRuleSet uniqueIdentifier: type: - string - 'null' description: scoping rule set uniqueIdentifier example: Global separateJourneyPerProduct: type: boolean description: scoping rule set separateJourneyPerProduct example: false conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Conditions under which the scoping rule set can be applied 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 - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version 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 StringServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' 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 ScopingRuleSetDto: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_2' - type: object properties: type: allOf: - $ref: '#/components/schemas/ScopingRuleType' description: Type of the scoping rule example: ProductJourney additionalProperties: false CreateScopingRuleSetVersionFromSetIdResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionFromSetIdResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false ScopingRuleSetDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetDto' additionalProperties: false ConditionDefinitionDto_2: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_2' valueField: allOf: - $ref: '#/components/schemas/ValueField_2' additionalProperties: false CreateScopingRuleSetResponse: allOf: - $ref: '#/components/schemas/ScopingRuleSetDto' - type: object additionalProperties: false ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ActiveScopingRuleSetVersionResponseDto: type: object properties: id: type: string description: The UiD of the scoping ruleset version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The Name of the Scoping Rule Set example: 118313c6-91e6-4b05-a537-5a1ab906418f setStatus: type: - string - 'null' description: Product requirement set status example: Active uniqueIdentifier: type: - string - 'null' description: Product requirement set jurisdiction example: Global separateJourneyPerProduct: type: boolean description: Product requirement set separateJourneyPerProduct example: false versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 type: allOf: - $ref: '#/components/schemas/ScopingRuleType' description: Type of the scoping rule example: ProductJourney additionalProperties: false description: Response DTO representing light scoping rule set version data ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ActiveScopingRuleSetVersionResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ConditionDto_3: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_3' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ScopingRuleSetDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ValueField_3: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ObjectServiceResponse_3: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false StringServiceResponse_3: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_3' additionalProperties: false ScopingRuleSetVersionDto_3: type: object properties: versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time readOnly: true example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 id: type: string description: The UiD of the scopingRule set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the scopingRule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetStatus: type: - string - 'null' description: ScopingRule set status example: Active name: type: - string - 'null' description: ScopingRule set name example: Fenergo Comprehensive Standard Policy ScopingRules uniqueIdentifier: type: - string - 'null' description: ScopingRule set UniqueIdentifier example: Global separateJourneyPerProduct: type: boolean description: ScopingRule set SeparateJourneyPerProduct example: false conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_3' description: Conditions under which the scopingRule set can be applied type: allOf: - $ref: '#/components/schemas/ScopingRuleType' description: Type of the scoping rule example: ProductJourney additionalProperties: false description: Response DTO representing scoping rule set version data ScopingRuleSetDto_2: type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetVersionDto_3' description: Versions associated to this scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 status: type: - string - 'null' description: Product Requirement Set status example: Active uniqueIdentifier: type: - string - 'null' description: UniqueIdentifier of the scoping rule set example: Global type: allOf: - $ref: '#/components/schemas/ScopingRuleType' description: Type of the scoping rule example: ProductJourney additionalProperties: false description: Response DTO representing scoping rule set data ConditionDefinitionDto_3: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_3' valueField: allOf: - $ref: '#/components/schemas/ValueField_3' additionalProperties: false ServiceResponseMessage_3: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateScopingRuleSetVersionDtoServiceRequest_3: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDto_3' description: Request DTO representing set of properties which define a new version of scoping rule set additionalProperties: false CloneScopingRuleSetVersionResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDto' description: Cloned scoping rule set response data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false CloneScopingRuleSetVersionDtoServiceRequest_3: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto' description: Request DTO representing clone scoping rule set data additionalProperties: false CreateScopingRuleSetDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto_2' description: DTO representing scoping rule set data needed for creation additionalProperties: false UpdateScopingRuleSetVersionDto_3: required: - effectiveFrom type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions under which the schema can be used version: maximum: 2147483647 minimum: 0 type: integer description: 'Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on 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 ConditionDto_4: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' 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: - Company valueType: text operation: equal operands: [] CreateScopingRuleSetVersionDto_2: required: - effectiveFrom type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions under which the schema can be used additionalProperties: false description: DTO representing scoping rule set data needed for version creation ValueField_4: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false SignScopingRuleSetVersionResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDto' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false ApproveActionServiceRequest_3: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse_4: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false StringServiceResponse_4: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false CreateScopingRuleSetDto_2: required: - effectiveFrom - name type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions under which the schema can be used name: minLength: 1 type: string description: Scoping rule set name example: Global additionalProperties: false description: DTO representing scoping rule set data needed for creation ValidationErrorModelListServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto_4: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_4' valueField: allOf: - $ref: '#/components/schemas/ValueField_4' additionalProperties: false CreateScopingRuleSetResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponseDto_2' description: DTO representing scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false CreateScopingRuleSetResponseDto_2: required: - effectiveFrom - name - signees type: object properties: effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_4' description: Conditions under which the schema can be used name: minLength: 1 type: string description: Scoping rule set name example: Global scopingRuleSetId: type: string description: The UiD of scoping rule set format: uuid example: 7084669b-0813-4faa-b1d5-b7bf6d749717 versionNumber: type: integer description: The version number format: int32 example: 1 created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-01-05T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft signees: type: array items: $ref: '#/components/schemas/SigneeDto' description: The defined list of signees for the version additionalProperties: false description: DTO representing scoping rule set data ValidationErrorModel_2: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_4: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateScopingRuleSetResponseDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetResponseDto' description: Response DTO representing updated scoping rule set messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_4' additionalProperties: false CreateScopingRuleSetVersionDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_2' description: DTO representing scoping rule set data needed for version creation additionalProperties: false ValidationErrorModelListServiceResponse_3: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_3' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ValueField_5: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ConditionDefinitionDto_5: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_5' valueField: allOf: - $ref: '#/components/schemas/ValueField_5' additionalProperties: false ValidationErrorModel_3: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false ScopingRuleSetLiteVersionDto_2: required: - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoping Rule Set version ServiceResponseMessage_5: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConditionDto_5: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_5' additionalProperties: false StringServiceResponse_5: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_4: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto_4' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false ObjectServiceResponse_5: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_5' additionalProperties: false ScopingRuleSetVersionDto_4: required: - name - signees type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 signees: type: array items: $ref: '#/components/schemas/SigneeDto' description: The defined list of signees for the version conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_5' description: Conditions under which the schema can be used additionalProperties: false description: Response DTO representing scoping rule set version data UpdateScopingRuleSetVersionDtoServiceRequest_4: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDto_4' description: Request DTO representing set of properties which define a new version of scoping rule set additionalProperties: false CloneScopingRuleSetVersionResponseDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDto' description: Cloned scoping rule set response data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false CloneScopingRuleSetVersionDtoServiceRequest_4: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto_3' description: Request DTO representing clone scoping rule set data additionalProperties: false CreateScopingRuleSetDtoServiceRequest_3: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto_3' description: DTO representing scoping rule set data needed for creation additionalProperties: false UpdateScopingRuleSetVersionDto_4: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_6' description: Conditions under which the schema can be used version: type: integer description: 'Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on 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 ConditionDto_6: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_6' additionalProperties: false CreateScopingRuleSetVersionDto_3: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_6' description: Conditions under which the schema can be used additionalProperties: false description: DTO representing scoping rule set data needed for version creation ValueField_6: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false CloneScopingRuleSetVersionDto_3: required: - jurisdiction - name type: object properties: name: minLength: 1 type: string description: Name of new scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Jurisdiction for the new scoping rule set example: Global additionalProperties: false description: Request DTO representing clone scoping rule set data SignScopingRuleSetVersionResponseDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDto' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false ApproveActionServiceRequest_4: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse_6: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false StringServiceResponse_6: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false CreateScopingRuleSetDto_3: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_3' - required: - jurisdiction type: object properties: jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global additionalProperties: false description: DTO representing scoping rule set data needed for creation ValidationErrorModelListServiceResponse_4: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_4' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto_6: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_6' valueField: allOf: - $ref: '#/components/schemas/ValueField_6' additionalProperties: false CreateScopingRuleSetResponseDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponseDto' description: DTO representing scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false ValidationErrorModel_4: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_6: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateScopingRuleSetResponseDtoServiceResponse_3: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetResponseDto' description: Response DTO representing updated scoping rule set messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_6' additionalProperties: false CreateScopingRuleSetVersionDtoServiceRequest_3: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_3' description: DTO representing scoping rule set data needed for version creation additionalProperties: false UpdateScopingRuleSetVersionDtoServiceRequest_5: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDto_5' description: Request DTO representing set of properties which define a new version of scoping rule set additionalProperties: false CloneScopingRuleSetVersionResponseDtoServiceResponse_4: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDto' description: Cloned scoping rule set response data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false CloneScopingRuleSetVersionDtoServiceRequest_5: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto_4' description: Request DTO representing clone scoping rule set data additionalProperties: false CreateScopingRuleSetDtoServiceRequest_4: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto_4' description: DTO representing scoping rule set data needed for creation additionalProperties: false UpdateScopingRuleSetVersionDto_5: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_7' description: Conditions under which the schema can be used version: type: integer description: 'Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on 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 ConditionDto_7: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_7' additionalProperties: false CreateScopingRuleSetVersionDto_4: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_7' description: Conditions under which the schema can be used additionalProperties: false description: DTO representing scoping rule set data needed for version creation ValueField_7: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false CloneScopingRuleSetVersionDto_4: required: - jurisdiction - name type: object properties: name: minLength: 1 type: string description: Name of new scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Jurisdiction for the new scoping rule set example: Global additionalProperties: false description: Request DTO representing clone scoping rule set data SignScopingRuleSetVersionResponseDtoServiceResponse_4: type: object properties: data: allOf: - $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDto' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ApproveActionServiceRequest_5: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse_7: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false StringServiceResponse_7: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false CreateScopingRuleSetDto_4: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_4' - required: - jurisdiction type: object properties: jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global additionalProperties: false description: DTO representing scoping rule set data needed for creation ValidationErrorModelListServiceResponse_5: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_5' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto_7: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_7' valueField: allOf: - $ref: '#/components/schemas/ValueField_7' additionalProperties: false CreateScopingRuleSetResponseDtoServiceResponse_4: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponseDto' description: DTO representing scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false ValidationErrorModel_5: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_7: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateScopingRuleSetResponseDtoServiceResponse_4: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetResponseDto' description: Response DTO representing updated scoping rule set messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_7' additionalProperties: false CreateScopingRuleSetVersionDtoServiceRequest_4: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_4' description: DTO representing scoping rule set data needed for version creation additionalProperties: false UpdateScopingRuleSetVersionDtoServiceRequest_6: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetVersionDto_6' description: Request DTO representing set of properties which define a new version of scoping rule set additionalProperties: false CloneScopingRuleSetVersionResponseDtoServiceResponse_5: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionResponseDto' description: Cloned scoping rule set response data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false CloneScopingRuleSetVersionDtoServiceRequest_6: type: object properties: data: allOf: - $ref: '#/components/schemas/CloneScopingRuleSetVersionDto_5' description: Request DTO representing clone scoping rule set data additionalProperties: false CreateScopingRuleSetDtoServiceRequest_5: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetDto_5' description: DTO representing scoping rule set data needed for creation additionalProperties: false UpdateScopingRuleSetVersionDto_6: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_8' description: Conditions under which the schema can be used version: type: integer description: 'Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required to guarantee consistency and conflicts detection. If it is not provided, it will save new changes on 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 ConditionDto_8: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_8' additionalProperties: false CreateScopingRuleSetVersionDto_5: required: - name type: object properties: name: minLength: 1 type: string description: Scoping rule set name example: Global Scoping Rules effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-05T14:48:00.000Z' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_8' description: Conditions under which the schema can be used additionalProperties: false description: DTO representing scoping rule set data needed for version creation ValueField_8: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false CloneScopingRuleSetVersionDto_5: required: - jurisdiction - name type: object properties: name: minLength: 1 type: string description: Name of new scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Jurisdiction for the new scoping rule set example: Global additionalProperties: false description: Request DTO representing clone scoping rule set data SignScopingRuleSetVersionResponseDtoServiceResponse_5: type: object properties: data: allOf: - $ref: '#/components/schemas/SignScopingRuleSetVersionResponseDto' description: Sign scoping rule set response contains the new version status messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ApproveActionServiceRequest_6: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse_8: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false StringServiceResponse_8: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false CreateScopingRuleSetDto_5: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_5' - required: - jurisdiction type: object properties: jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global additionalProperties: false description: DTO representing scoping rule set data needed for creation ValidationErrorModelListServiceResponse_6: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_6' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionDefinitionDto_8: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_8' valueField: allOf: - $ref: '#/components/schemas/ValueField_8' additionalProperties: false CreateScopingRuleSetResponseDtoServiceResponse_5: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetResponseDto' description: DTO representing scoping rule set data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false ValidationErrorModel_6: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ServiceResponseMessage_8: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateScopingRuleSetResponseDtoServiceResponse_5: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateScopingRuleSetResponseDto' description: Response DTO representing updated scoping rule set messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_8' additionalProperties: false CreateScopingRuleSetVersionDtoServiceRequest_5: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateScopingRuleSetVersionDto_5' description: DTO representing scoping rule set data needed for version creation additionalProperties: false ValidationErrorModelListServiceResponse_7: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_7' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_9' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ValueField_9: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteDto_2: required: - jurisdiction type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto_3' description: Versions associated to the scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity ConditionDefinitionDto_9: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_9' valueField: allOf: - $ref: '#/components/schemas/ValueField_9' additionalProperties: false ValidationErrorModel_7: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteVersionDto_3: required: - jurisdiction - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity Version ScopingRuleSetLiteDtoIEnumerableServiceResponse_3: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_9' additionalProperties: false ServiceResponseMessage_9: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConditionDto_9: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_9' additionalProperties: false StringServiceResponse_9: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_9' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_5: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_9' additionalProperties: false ObjectServiceResponse_9: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_9' additionalProperties: false ValidationErrorModelListServiceResponse_8: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_8' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_10' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ValueField_10: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteDto_3: required: - jurisdiction type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto_4' description: Versions associated to the scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity ConditionDefinitionDto_10: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_10' valueField: allOf: - $ref: '#/components/schemas/ValueField_10' additionalProperties: false ValidationErrorModel_8: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteVersionDto_4: required: - jurisdiction - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity Version ScopingRuleSetLiteDtoIEnumerableServiceResponse_4: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto_3' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_10' additionalProperties: false ServiceResponseMessage_10: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConditionDto_10: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_10' additionalProperties: false StringServiceResponse_10: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_10' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_6: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_10' additionalProperties: false ObjectServiceResponse_10: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_10' additionalProperties: false ValidationErrorModelListServiceResponse_9: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_9' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_11' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ValueField_11: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteDto_4: required: - jurisdiction type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto_5' description: Versions associated to the scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity ConditionDefinitionDto_11: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_11' valueField: allOf: - $ref: '#/components/schemas/ValueField_11' additionalProperties: false ValidationErrorModel_9: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteVersionDto_5: required: - jurisdiction - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity Version ScopingRuleSetLiteDtoIEnumerableServiceResponse_5: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto_4' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_11' additionalProperties: false ServiceResponseMessage_11: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConditionDto_11: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_11' additionalProperties: false StringServiceResponse_11: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_11' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_7: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_11' additionalProperties: false ObjectServiceResponse_11: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_11' additionalProperties: false ValidationErrorModelListServiceResponse_10: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel_10' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_12' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ValueField_12: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteDto_5: required: - jurisdiction type: object properties: id: type: string description: The UiD of the scoping rule set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versions: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteVersionDto_6' description: Versions associated to the scoping rule set version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity ConditionDefinitionDto_12: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_12' valueField: allOf: - $ref: '#/components/schemas/ValueField_12' additionalProperties: false ValidationErrorModel_10: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false ScopingRuleSetLiteVersionDto_6: required: - jurisdiction - name type: object properties: id: type: string description: The UiD of the scoping rule set version format: uuid example: 228313c6-91e6-4b05-a537-5a1ab906418f scopingRuleSetId: type: string description: The UiD of the scoping rule set that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: Display name of scoping rule set example: Global Scoping Rules jurisdiction: minLength: 1 type: string description: Scoping rule set jurisdiction example: Global versionNumber: type: integer description: The versions number format: int32 example: 1 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-01-01T14:48:00.000Z' effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-01-01T14:48:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-01-01T14:48:00.000Z' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Published created: type: string description: The creation date of the version format: date-time example: '2021-01-01T14:48:00.000Z' isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s latest version at the time of the query (not necessarily published)' example: true version: type: - integer - 'null' description: Version number for given Aggregate (concurrency check) format: int32 example: 1 additionalProperties: false description: Represents a lite version of a Scoped Entity Version ScopingRuleSetLiteDtoIEnumerableServiceResponse_6: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScopingRuleSetLiteDto_5' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_12' additionalProperties: false ServiceResponseMessage_12: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ConditionDto_12: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto_12' additionalProperties: false StringServiceResponse_12: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_12' additionalProperties: false ScopingRuleSetVersionDtoServiceResponse_8: type: object properties: data: allOf: - $ref: '#/components/schemas/ScopingRuleSetVersionDto' description: Response DTO representing scoping rule set version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_12' additionalProperties: false ObjectServiceResponse_12: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_12' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-digitalidvcommand-v1-0-openapi.json - fenergo-digitalidvcommand-v2-0-openapi.json - fenergo-digitalidvquery-v1-0-openapi.json - fenergo-digitalidvquery-v2-0-openapi.json - fenergo-productpolicycommand-v1-0-openapi.json - fenergo-productpolicyquery-v1-0-openapi.json - fenergo-riskcommand-v1-0-openapi.json - fenergo-riskquery-v1-0-openapi.json - fenergo-screeningcommand-v1-0-openapi.json - fenergo-screeningcommand-v2-0-openapi.json - fenergo-screeningcommand-v3-0-openapi.json - fenergo-screeningquery-v1-0-openapi.json - fenergo-screeningquery-v2-0-openapi.json - fenergo-screeningquery-v3-0-openapi.json - fenergo-screeningquery-v4-0-openapi.json