{"openapi":"3.0.1","info":{"title":"Completeness score","description":"To interact with completeness score service.\n

Deprecated endpoints:

Uri

Method

Since

End of life

","version":"1-core"},"servers":[{"url":"api.test.bluestonepim.com/completeness-score","description":"Generated server url"}],"tags":[{"name":"Requirements","description":"To interact with requirements."},{"name":"Scores","description":"To interact with scores."},{"name":"Validation","description":"To interact with validations."}],"paths":{"/requirements/{requirementId}":{"put":{"tags":["Requirements"],"summary":"Update requirement.","operationId":"update","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]},"delete":{"tags":["Requirements"],"summary":"Delete requirement.","operationId":"delete","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/requirements/{requirementId}/productType/{productType}/included":{"put":{"tags":["Requirements"],"summary":"Add included product type to requirement.","operationId":"addIncludedProductType","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productType","in":"path","required":true,"schema":{"type":"string","enum":["SINGLE","BUNDLE","GROUP","VARIANT","FAMILY"]}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]},"delete":{"tags":["Requirements"],"summary":"Remove included product type to requirement.","operationId":"removeIncludedProductType","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productType","in":"path","required":true,"schema":{"type":"string","enum":["SINGLE","BUNDLE","GROUP","VARIANT","FAMILY"]}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/requirements/{requirementId}/categories/{categoryId}/included":{"put":{"tags":["Requirements"],"summary":"Add included category to requirement.","operationId":"addIncludedCategory","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]},"delete":{"tags":["Requirements"],"summary":"Remove included category to requirement.","operationId":"removeIncludedCategory","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/requirements/{requirementId}/categories/{categoryId}/excluded":{"put":{"tags":["Requirements"],"summary":"Add excluded category to requirement.","operationId":"addExcludedCategory","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]},"delete":{"tags":["Requirements"],"summary":"Remove excluded category to requirement.","operationId":"removeExcludedCategory","parameters":[{"name":"requirementId","in":"path","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/validations/product/attribute":{"post":{"tags":["Validation"],"summary":"Validate product attribute.","operationId":"validateProductAttribute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAttributeValidationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValueValidationIssuesListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/validations/definition/value":{"post":{"tags":["Validation"],"summary":"Validate definition value.","operationId":"validateDefinitionValue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionValueValidationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefinitionValueValidationIssuesListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/validations/by-ids":{"post":{"tags":["Validation"],"summary":"Get validation issues for products by ids.","description":"Returns validation results only for entities that exist.","operationId":"getBulkValidationIssues","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkValidationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkValidationListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/scores/list":{"post":{"tags":["Scores"],"summary":"Get scores.","description":"Returns a paged list of computed completeness scores (score value, validation status, last update dates), optionally filtered by context and/or entity id. Use for bulk retrieval across entities; for a single entity's per-requirement pass/fail breakdown use GET /scores/{entityId}/{context} instead. Entities with no computed score yet for the given filters are simply omitted from the results, not reported as an error.","operationId":"getScores","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/scores/category/list":{"post":{"tags":["Scores"],"summary":"Get category scores.","operationId":"getCategoryScores","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryScoreRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryScoreListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/scores/calculation/stop":{"post":{"tags":["Scores"],"summary":"Stop ongoing calculation.","operationId":"stopCalculation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculateScoreStandardRequest"}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/scores/calculation/start":{"post":{"tags":["Scores"],"summary":"Start new calculation.","operationId":"startCalculation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculateScoreStandardRequest"}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculationResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/scores/calculation/recalculate/entity":{"post":{"tags":["Scores"],"summary":"Recalculate score for entities.","operationId":"recalculateForEntity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecalculateScoreForEntityRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/scores/calculation/admin/invalidate":{"post":{"tags":["Scores"],"summary":"Invalidate scores.","operationId":"scoresInvalidation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidateScoresRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"ADMIN"}],"security":[{"oauth2":[]}]}},"/requirements":{"post":{"tags":["Requirements"],"summary":"Create requirement.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementCreateRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict\n\nThis response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"WRITE"}],"security":[{"oauth2":[]}]}},"/requirements/list":{"post":{"tags":["Requirements"],"summary":"List requirements.","description":"Returns a paged list of requirement definitions configured for the organization, optionally filtered by id and/or requirement type. Each result includes the requirement's weight, its type-specific evaluation params, and its included/excluded category and product-type scoping. Use requirements/count instead if only the total count is needed.","operationId":"list","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/requirements/count":{"post":{"tags":["Requirements"],"summary":"Count requirements.","operationId":"count","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementCountRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequirementCountResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/validations/{entityId}/{context}":{"get":{"tags":["Validation"],"summary":"Get validation issues for product.","operationId":"getValidationIssues","parameters":[{"name":"entityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductValidationIssuesListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/scores/{entityId}/{context}":{"get":{"tags":["Scores"],"summary":"Get detailed scores for single entity.","description":"Returns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated. Use for a single entity; for many entities at once use get_scores (POST /scores/list), which returns summary scores without the per-requirement breakdown. Returns the same payload as GET /requirements/entity/{entityId}/{context} — either can be used. Fails if no score has been computed yet for this entityId/context combination, which can also occur if the entity itself doesn't exist.","operationId":"getDetailedScoresForSingleEntity","parameters":[{"name":"entityId","in":"path","description":"Id of the entity (product) to get the score for.","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","description":"Context the score was computed for, e.g. 'en'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreDetailedResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/scores/status/{context}":{"get":{"tags":["Scores"],"summary":"Get calculation status.","operationId":"getCalculationStatus","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreCompletenessStateResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}},"/requirements/entity/{entityId}/{context}":{"get":{"tags":["Requirements"],"summary":"Get requirements for single entity.","description":"Returns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated — the same payload as GET /scores/{entityId}/{context}, not the requirement definitions returned by POST /requirements/list. Fails if no score has been computed yet for this entityId/context combination, which can also occur if the entity itself doesn't exist.","operationId":"getRequirementsForSingleEntity","parameters":[{"name":"entityId","in":"path","description":"Id of the entity (product) to get requirement results for.","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","description":"Context the score was computed for, e.g. 'en'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreDetailedResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"module":"COMPLETENESS_SCORE","accessType":"READ"}],"security":[{"oauth2":[]}]}}},"components":{"schemas":{"AttributeHasValueRequirementParams":{"required":["definitionId"],"type":"object","properties":{"definitionId":{"title":"Attribute definition id.","minLength":1,"type":"string"}}},"AttributePercentageRequirementParams":{"type":"object","properties":{"percentage":{"title":"Minimum percentage of attributes with values.","type":"integer","format":"int32"}}},"AttributesInGroupHaveValuesRequirementParams":{"required":["groupId"],"type":"object","properties":{"groupId":{"title":"Attribute group id.","minLength":1,"type":"string"},"percentage":{"title":"Percentage of required values.","type":"integer","format":"int32"}}},"ImageDeepEtchRequirementParams":{"required":["mediaLabelId"],"type":"object","properties":{"mediaLabelId":{"title":"Media label id.","minLength":1,"type":"string"}}},"ImageDensityRequirementParams":{"required":["mediaLabelId"],"type":"object","properties":{"mediaLabelId":{"title":"Media label id.","minLength":1,"type":"string"},"dpi":{"title":"Minimum DPI.","minimum":1,"type":"integer","format":"int32"}}},"ImageResolutionRequirementParams":{"required":["mediaLabelId"],"type":"object","properties":{"mediaLabelId":{"title":"Media label id.","minLength":1,"type":"string"},"width":{"title":"Minimum image width.","minimum":1,"type":"integer","format":"int32"},"height":{"title":"Minimum image height.","minimum":1,"type":"integer","format":"int32"}}},"MinimumRelationConnectionsRequirementParams":{"required":["relationId"],"type":"object","properties":{"connectionCount":{"title":"Minimum number of connection.","minimum":1,"type":"integer","format":"int32"},"relationId":{"title":"Relation identifier.","minLength":1,"type":"string"},"direction":{"title":"Relation direction. Applicable only for TWO_WAY relations. DIRECT means the original direction, REVERSE means the opposite direction.","type":"string","nullable":true,"enum":["DIRECT","REVERSE"]}}},"NumberOfMediaWithLabelRequirementParams":{"required":["mediaLabelId"],"type":"object","properties":{"mediaCount":{"title":"Number of media.","minimum":1,"type":"integer","format":"int32"},"mediaLabelId":{"title":"Id of media label.","minLength":1,"type":"string"}}},"ProductAddedToCategoryRequirementParams":{"required":["categoryId"],"type":"object","properties":{"categoryId":{"title":"Category id.","minLength":1,"type":"string"},"includeSubcategories":{"title":"Product is added to required category or any of its sub-categories.","type":"boolean","nullable":true}}},"RequirementParams":{"title":"Requirement params.","type":"object","description":"

Subtypes mapping

Requirement typeParams model
ATTRIBUTE_HAS_VALUEAttributeHasValueRequirementParams
MINIMUM_MEDIA_WITH_LABELNumberOfMediaWithLabelRequirementParams
PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUEAttributesInGroupHaveValuesRequirementParams
IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTIONImageResolutionRequirementParams
PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUEAttributePercentageRequirementParams
MINIMUM_RELATION_CONNECTIONSMinimumRelationConnectionsRequirementParams
IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITYImageDensityRequirementParams
IMAGE_WITH_LABEL_HAS_DEEP_ETCHImageDeepEtchRequirementParams
PRODUCT_ADDED_TO_CATEGORYProductAddedToCategoryRequirementParams
"},"RequirementUpdateRequest":{"type":"object","properties":{"requirementType":{"title":"Requirement type.","type":"string","nullable":true,"enum":["ATTRIBUTE_HAS_VALUE","MINIMUM_MEDIA_WITH_LABEL","PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE","IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION","PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE","MINIMUM_RELATION_CONNECTIONS","IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY","IMAGE_WITH_LABEL_HAS_DEEP_ETCH","PRODUCT_ADDED_TO_CATEGORY"]},"params":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/RequirementParams"}]},"weight":{"title":"Requirement weight. Max 6 digits, no fractional digits. Defaults to 1.","minimum":1,"type":"number","nullable":true}}},"AttributeDto":{"title":"Attribute information.","type":"object","properties":{"definitionId":{"title":"Attribute definition id.","type":"string"},"value":{"title":"Attribute value.","type":"string","nullable":true},"selectValuesIds":{"title":"List of select value ids.","type":"array","nullable":true,"items":{"title":"List of select value ids.","type":"string"}},"dictionaryValuesIds":{"title":"List of dictionary values ids.","type":"array","nullable":true,"items":{"title":"List of dictionary values ids.","type":"string"}}}},"ProductAttributeValidationRequest":{"type":"object","properties":{"productId":{"title":"Product id.","type":"string"},"context":{"title":"Context.","type":"string"},"attribute":{"$ref":"#/components/schemas/AttributeDto"}}},"AttributeDefinitionRequirementIssue":{"type":"object","properties":{"restrictionType":{"type":"string","enum":["MIN_VALUE_OUT_OF_RANGE","MAX_VALUE_OUT_OF_RANGE","EXCEEDED_CHARACTER_LIMIT","WHITE_SPACES_NOT_ALLOWED","INVALID_FORMAT","PATTERN_NOT_MATCHED","INVALID_STEP"]}}},"AttributeDefinitionValidationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ValidationDetails"},{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDefinitionRequirementIssue"}}}}]},"AttributeValueValidationIssuesListResponse":{"type":"object","properties":{"data":{"title":"Attribute value validation issues.","type":"array","items":{"$ref":"#/components/schemas/AttributeValueValidationIssuesResponse"}}}},"AttributeValueValidationIssuesResponse":{"title":"Attribute value validation issues.","type":"object","properties":{"validationType":{"title":"Type of validation.","type":"string","enum":["INVALID_ATTRIBUTE_VALUE","INVALID_CATEGORY_VALUE","INVALID_VARIANT_VALUE","MISSING_VARIANT_VALUE","MISSING_CATEGORY_VALUE","DICTIONARY_VALUE_NOT_EXIST_IN_FILTER"]},"validationDetails":{"oneOf":[{"$ref":"#/components/schemas/AttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/CategoryAttributesValidationDetails"},{"$ref":"#/components/schemas/CompoundAttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/DictionaryValueFilterValidationDetails"},{"$ref":"#/components/schemas/VariantAttributesValidationDetails"}]}}},"CategoryAttributesValidationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ValidationDetails"},{"type":"object","properties":{"categoryId":{"type":"string"}}}]},"CompoundAttributeDefinitionValidationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ValidationDetails"},{"type":"object","properties":{"parentId":{"type":"string"}}}]},"DictionaryValueFilterValidationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ValidationDetails"},{"type":"object","properties":{"invalidIds":{"type":"array","items":{"type":"string"}}}}]},"ValidationDetails":{"title":"Status of validation.","type":"object","properties":{"definitionId":{"type":"string"}},"description":"\nSubtypes mapping\n| Requirement details | Requirement types |\n|---|---|\n| CompoundAttributeDefinitionValidationDetails | MISSING_COMPOUND_ATTRIBUTE |\n| AttributeDefinitionValidationDetails | INVALID_ATTRIBUTE_VALUE |\n| DictionaryValueFilterValidationDetails | DICTIONARY_VALUE_NOT_EXIST_IN_FILTER |\n| VariantAttributesValidationDetails | MISSING_VARIANT_ATTRIBUTE, MISSING_VARIANT_VALUE, INVALID_VARIANT_VALUE|\n| CategoryAttributesValidationDetails | MISSING_CATEGORY_ATTRIBUTE, MISSING_CATEGORY_VALUE, INVALID_CATEGORY_VALUE|\n"},"VariantAttributesValidationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ValidationDetails"},{"type":"object","properties":{"variantParentId":{"type":"string"}}}]},"DefinitionValueValidationRequest":{"type":"object","properties":{"context":{"title":"Context.","type":"string"},"attribute":{"$ref":"#/components/schemas/SimpleAttributeDto"}}},"SimpleAttributeDto":{"title":"Attribute information.","type":"object","properties":{"definitionId":{"title":"Attribute definition id.","type":"string"},"value":{"title":"Attribute value.","type":"string","nullable":true}}},"DefinitionValueValidationIssuesListResponse":{"type":"object","properties":{"data":{"title":"Definition value validation issues.","type":"array","items":{"$ref":"#/components/schemas/DefinitionValueValidationIssuesResponse"}}}},"DefinitionValueValidationIssuesResponse":{"title":"Definition value validation issues.","type":"object","properties":{"validationDetails":{"oneOf":[{"$ref":"#/components/schemas/AttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/CategoryAttributesValidationDetails"},{"$ref":"#/components/schemas/CompoundAttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/DictionaryValueFilterValidationDetails"},{"$ref":"#/components/schemas/VariantAttributesValidationDetails"}]}}},"BulkValidationRequest":{"required":["context","entityIds"],"type":"object","properties":{"entityIds":{"title":"Array of entity IDs to validate.","maxItems":100,"minItems":1,"type":"array","items":{"title":"Array of entity IDs to validate.","type":"string"}},"context":{"title":"Context in which the validation is performed.","minLength":1,"type":"string"}}},"BulkValidationListResponse":{"type":"object","properties":{"data":{"title":"List of validation results for entities.","type":"array","items":{"$ref":"#/components/schemas/BulkValidationResponse"}}}},"BulkValidationResponse":{"title":"List of validation results for entities.","type":"object","properties":{"entityId":{"title":"Entity ID.","type":"string"},"validations":{"title":"Validation issues for the entity.","type":"array","items":{"$ref":"#/components/schemas/ProductValidationIssuesResponse"}}}},"ProductValidationIssuesResponse":{"title":"Validation issues for the entity.","type":"object","properties":{"validationType":{"title":"Type of validation.","type":"string","enum":["INVALID_ATTRIBUTE_VALUE","MISSING_CATEGORY_ATTRIBUTE","MISSING_CATEGORY_VALUE","INVALID_CATEGORY_VALUE","MISSING_COMPOUND_ATTRIBUTE","MISSING_VARIANT_ATTRIBUTE","MISSING_VARIANT_VALUE","INVALID_VARIANT_VALUE","DICTIONARY_VALUE_NOT_EXIST_IN_FILTER"]},"validationDetails":{"oneOf":[{"$ref":"#/components/schemas/AttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/CategoryAttributesValidationDetails"},{"$ref":"#/components/schemas/CompoundAttributeDefinitionValidationDetails"},{"$ref":"#/components/schemas/DictionaryValueFilterValidationDetails"},{"$ref":"#/components/schemas/VariantAttributesValidationDetails"}]}}},"ScoreRequest":{"type":"object","properties":{"contexts":{"title":"List of contexts to filter by, e.g. ['en']. When omitted, scores for all contexts are returned.","type":"array","nullable":true,"items":{"title":"List of contexts to filter by, e.g. ['en']. When omitted, scores for all contexts are returned.","type":"string"}},"entityIds":{"title":"List of entity ids to filter by. When omitted, scores for all entities are returned.","type":"array","nullable":true,"items":{"title":"List of entity ids to filter by. When omitted, scores for all entities are returned.","type":"string"}},"pageSize":{"title":"Size of a block of items to return. It corresponds with the page parameter. Defaults to 10 if omitted.","maximum":100,"minimum":1,"type":"integer","format":"int32","example":10},"page":{"title":"A number sequence representing a block of items to return as a result set. Defaults to 0 (first page) if omitted.","minimum":0,"type":"integer","format":"int64","example":0}}},"ScoreListResponse":{"type":"object","properties":{"data":{"title":"Score information.","type":"array","items":{"$ref":"#/components/schemas/ScoreResponse"}}}},"ScoreResponse":{"title":"Score information.","type":"object","properties":{"entityId":{"title":"Scored entity id.","type":"string"},"score":{"title":"Score value.","type":"number","nullable":true},"context":{"title":"Context.","type":"string"},"date":{"title":"Score computation date.","type":"integer","format":"int64"},"sourceEventId":{"title":"Source event id that triggered score computation.","type":"string","nullable":true},"validationStatus":{"title":"Status of validation.","type":"string","nullable":true,"enum":["VALID","INVALID"]},"entityLastUpdate":{"title":"Date of the last product update in pim.","type":"integer","format":"int64","nullable":true}}},"CategoryScoreRequest":{"type":"object","properties":{"contexts":{"title":"List of contexts to return score for. Returns score for all contexts by default.","type":"array","nullable":true,"items":{"title":"List of contexts to return score for. Returns score for all contexts by default.","type":"string"}},"categoryIds":{"title":"List of categoryIds to return score for. Returns score for all categories by default.","type":"array","nullable":true,"items":{"title":"List of categoryIds to return score for. Returns score for all categories by default.","type":"string"}},"includeUnassigned":{"title":"Indicates whether the response should include a score for unassigned products. Default: true.","type":"boolean"},"pageSize":{"title":"Size of a block of items to return. It corresponds with the page parameter.","maximum":100,"minimum":1,"type":"integer","format":"int32","example":10},"page":{"title":"A number sequence representing a block of items to return as a result set.","minimum":0,"type":"integer","format":"int64","example":0}}},"CategoryScoreListResponse":{"type":"object","properties":{"data":{"title":"Category score list.","type":"array","items":{"$ref":"#/components/schemas/CategoryScoreResponse"}}}},"CategoryScoreResponse":{"title":"Category score list.","type":"object","properties":{"score":{"title":"Category score.","type":"number","nullable":true},"categoryId":{"title":"Category id.","type":"string","nullable":true},"context":{"title":"Score context.","type":"string"}}},"RecalculateScoreStandardRequest":{"type":"object","properties":{"context":{"title":"Context.","maxLength":2147483647,"minLength":1,"type":"string"}}},"CalculationResponse":{"type":"object","properties":{"message":{"type":"string"}}},"RecalculateScoreForEntityRequest":{"type":"object","properties":{"context":{"title":"Context.","maxLength":2147483647,"minLength":1,"type":"string"},"entityId":{"title":"Entity id.","type":"string","description":"EntityId is deprecated. Please use entityIds field.","nullable":true,"deprecated":true},"entityIds":{"title":"List of entity ids.","maxItems":100,"minItems":1,"type":"array","nullable":true,"items":{"title":"List of entity ids.","type":"string"}}}},"InvalidateScoresRequest":{"type":"object","properties":{"context":{"title":"Context.","maxLength":2147483647,"minLength":1,"type":"string"}}},"RequirementCreateRequest":{"type":"object","properties":{"requirementType":{"title":"Requirement type.","type":"string","enum":["ATTRIBUTE_HAS_VALUE","MINIMUM_MEDIA_WITH_LABEL","PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE","IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION","PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE","MINIMUM_RELATION_CONNECTIONS","IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY","IMAGE_WITH_LABEL_HAS_DEEP_ETCH","PRODUCT_ADDED_TO_CATEGORY"]},"params":{"$ref":"#/components/schemas/RequirementParams"},"weight":{"title":"Requirement weight.","minimum":1,"type":"number"},"includedProductTypes":{"title":"Requirement included product type.","uniqueItems":true,"type":"array","items":{"title":"Requirement included product type.","type":"string","enum":["SINGLE","BUNDLE","GROUP","VARIANT","FAMILY"]}}}},"RequirementListRequest":{"type":"object","properties":{"sort":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/RequirementSortingProperties"}]},"ids":{"title":"Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id.","maxItems":2147483647,"minItems":1,"type":"array","nullable":true,"items":{"title":"Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id.","type":"string"}},"types":{"title":"Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type.","maxItems":2147483647,"minItems":1,"type":"array","nullable":true,"items":{"title":"Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type.","type":"string","enum":["ATTRIBUTE_HAS_VALUE","MINIMUM_MEDIA_WITH_LABEL","PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE","IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION","PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE","MINIMUM_RELATION_CONNECTIONS","IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY","IMAGE_WITH_LABEL_HAS_DEEP_ETCH","PRODUCT_ADDED_TO_CATEGORY"]}},"pageSize":{"title":"Size of a block of items to return. It corresponds with the page parameter. Defaults to 10 if omitted.","maximum":100,"minimum":1,"type":"integer","format":"int32","example":10},"page":{"title":"A number sequence representing a block of items to return as a result set. Defaults to 0 (first page) if omitted.","minimum":0,"type":"integer","format":"int64","example":0}}},"RequirementSortingProperties":{"title":"Sort order for the results. When omitted, results are returned unsorted.","type":"object","properties":{"sortDirection":{"title":"Sort direction.","type":"string","enum":["ASC","DESC"]},"sortField":{"title":"Sort field.","type":"string","enum":["REQUIREMENT_TYPE","WEIGHT"]}}},"RequirementListResponse":{"type":"object","properties":{"data":{"title":"Requirements list.","type":"array","items":{"$ref":"#/components/schemas/RequirementResponse"}}}},"RequirementResponse":{"title":"Requirements list.","type":"object","properties":{"id":{"type":"string"},"requirementType":{"type":"string","enum":["ATTRIBUTE_HAS_VALUE","MINIMUM_MEDIA_WITH_LABEL","PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE","IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION","PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE","MINIMUM_RELATION_CONNECTIONS","IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY","IMAGE_WITH_LABEL_HAS_DEEP_ETCH","PRODUCT_ADDED_TO_CATEGORY"]},"params":{"$ref":"#/components/schemas/RequirementParams"},"weight":{"type":"number"},"includedCategoryIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"excludedCategoryIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"includedProductTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["SINGLE","BUNDLE","GROUP","VARIANT","FAMILY"]}}}},"RequirementCountRequest":{"type":"object","properties":{"ids":{"title":"Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id.","maxItems":2147483647,"minItems":1,"type":"array","nullable":true,"items":{"title":"Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id.","type":"string"}},"types":{"title":"Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type.","maxItems":2147483647,"minItems":1,"type":"array","nullable":true,"items":{"title":"Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type.","type":"string","enum":["ATTRIBUTE_HAS_VALUE","MINIMUM_MEDIA_WITH_LABEL","PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE","IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION","PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE","MINIMUM_RELATION_CONNECTIONS","IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY","IMAGE_WITH_LABEL_HAS_DEEP_ETCH","PRODUCT_ADDED_TO_CATEGORY"]}}}},"RequirementCountResponse":{"type":"object","properties":{"count":{"title":"Number of requirements.","type":"integer","format":"int64"}}},"ProductValidationIssuesListResponse":{"type":"object","properties":{"data":{"title":"Product validation issues.","type":"array","items":{"$ref":"#/components/schemas/ProductValidationIssuesResponse"}}}},"RequirementResult":{"title":"List of score computation reports.","type":"object","properties":{"requirementId":{"type":"string"},"weight":{"type":"number"},"requirementStatus":{"type":"string","enum":["PASSED","FAILED","INVALID"]}}},"ScoreDetailedResponse":{"type":"object","properties":{"entityId":{"title":"Scored entity id.","type":"string"},"score":{"title":"Score value.","type":"number","nullable":true},"context":{"title":"Context.","type":"string"},"date":{"title":"Score computation date.","type":"integer","format":"int64"},"sourceEventId":{"title":"Source event id that triggered score computation.","type":"string","nullable":true},"requirementsResults":{"title":"List of score computation reports.","type":"array","items":{"$ref":"#/components/schemas/RequirementResult"}},"pimLastUpdate":{"title":"Date of last update product in pim.","type":"integer","format":"int64","nullable":true}}},"ScoreCompletenessStateResponse":{"type":"object","properties":{"calculationStatus":{"title":"Status of score calculation.","type":"string","enum":["RUNNING","STOPPING","IDLE","TO_BE_STARTED"]},"recalculationRequired":{"title":"Flag indicate if recalculation is required.","type":"boolean"}}},"ErrorResponse":{"type":"object","properties":{"status":{"title":"Error status code.","type":"integer","format":"int32"},"error":{"title":"General error description.","type":"string"},"errorDetails":{"title":"List of errors details.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"requestId":{"title":"Request ID used for logging.","type":"string"},"timestamp":{"title":"Error timestamp.","type":"integer","format":"int64"},"conflictingEntities":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/ConflictingEntity"}},"quotaLimitExceededDetails":{"title":"Additional details related to quota limit exceeded errors","type":"array","items":{"$ref":"#/components/schemas/LimitExceededDetails"}}}},"ErrorDetails":{"type":"object","properties":{"message":{"title":"Error message.","type":"string"},"field":{"title":"Error related field.","type":"string"},"rejectedValue":{"title":"Invalid value causing error.","type":"string"},"entityId":{"title":"Identifier of the entity related to the error.","type":"string"},"entityType":{"title":"Type of the entity related to the error.","type":"string"}}},"ConflictingEntity":{"type":"object","properties":{"entityId":{"title":"Identifier of the related entity causing the conflict","type":"string"},"entityType":{"title":"Type of the related entity causing the conflict","type":"string"}}},"LimitExceededDetails":{"type":"object","properties":{"message":{"title":"Detailed quota error message","type":"string"},"quota":{"title":"Unique quota identifier","type":"string"},"limit":{"title":"Allowed limit","type":"integer","format":"int32"},"entityId":{"title":"ID of the entity that violated the quota","type":"string","nullable":true},"entityType":{"title":"Type of the entity that violated the quota","type":"string","nullable":true}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}