openapi: 3.1.1 info: title: Intershop Sparque Center - Synonym Aggregates REST API description: | The _Intershop Sparque Center - Synonym Aggregates REST API_ contains resources for retrieving all synonyms within a specified workspace. **Note**: These resources support only UTF-8/16/32-encoded requests as specified in [RFC 4627](https://www.ietf.org/rfc/rfc4627.txt). ## Changelog ### Version 1.0.1 * Updated response example for the synonym aggregates endpoint with new example data ### Version 1.0.0 * Initial release of the Synonym Aggregates REST API version: "1.0.1" servers: - url: "{protocol}://{domain}:{port}/isc/rest" variables: protocol: default: https enum: - https domain: default: localhost port: default: "8080" security: - ApiKeyAuthQuery: [] - ApiKeyAuthHeader: [] tags: - name: Synonym Aggregates description: This section covers operations for retrieving synonym aggregates for SPARQUE. paths: /v1/workspaces/{workspaceName}/synonyms: get: tags: - Synonym Aggregates operationId: getWorkspaceSynonymsV1 summary: Returns synonym aggregates for a workspace description: | This operation returns a list of synonyms for a specific workspace, including one-way and two-way synonyms. Synonyms are structured as unidirectional one-to-one mappings. A one-way synonym creates an individual mapping from the source term to each target term. For a two-way synonym, the response contains individual mappings from each term to all other terms. parameters: - name: workspaceName in: path required: true description: The name of the workspace for which synonyms should be retrieved schema: type: string - name: key description: | The API key provided as query parameter. Not recommended, as the secret could be stored in web server, proxy or load balancer logs. Either this parameter or the preferred alternative HTTP header parameter `x-api-key` is required. in: query required: false schema: type: string - name: x-api-key in: header required: false description: | The API key provided as header (has higher precedence than the query parameter). Either this parameter or its alternative query parameter `key` is required. schema: type: string responses: "200": description: Ok - Synonym aggregates for the given workspace were successfully retrieved. content: application/json: schema: type: array items: $ref: "#/components/schemas/SynonymAggregate" example: - sourceTerm: notebook targetTerm: portable computer locale: en_US channel: inTRONICS - sourceTerm: notebook targetTerm: laptop locale: en_US channel: inTRONICS - sourceTerm: portable computer targetTerm: notebook locale: en_US channel: inTRONICS - sourceTerm: portable computer targetTerm: laptop locale: en_US channel: inTRONICS - sourceTerm: laptop targetTerm: notebook locale: en_US channel: inTRONICS - sourceTerm: laptop targetTerm: portable computer locale: en_US channel: inTRONICS - sourceTerm: 2-in-1 laptop targetTerm: surface book locale: en_US channel: inTRONICS_Business "401": description: Unauthorized - Authentication information is missing or invalid. "404": description: Not found - The requested workspace was not found. "500": description: Server Error - An unexpected error occurred. components: schemas: SynonymAggregate: type: object properties: sourceTerm: type: string description: The term that has an associated synonym example: computer targetTerm: type: string description: The synonym of the source term example: pc locale: type: string description: The locale of the synonym, formatted using IANA language definitions for languages and regions, separated by an underscore example: en_US channelId: type: string description: The ID of the channel associated with the synonym example: inTRONICS securitySchemes: ApiKeyAuthQuery: type: apiKey in: query name: key description: | The API key provided as query parameter (unsecure, not recommended). Either this parameter or its alternative header parameter `x-api-key` is required. ApiKeyAuthHeader: type: apiKey in: header name: x-api-key description: | The API key provided as header (has higher precedence than the query parameter). Either this parameter or its alternative query parameter `key` is required.