{ "openapi": "3.0.1", "info": { "title": "Search", "description": "Create and administer Scheduler, Seach Index, and Price mode settings.", "version": "9.1.20.0", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/rest/admin/v2", "variables": { "port": { "default": "443", "enum": [ "443", "8000" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "tags": [ { "name": "health" }, { "name": "Websphere Commerce search health check services" }, { "name": "scheduler" }, { "name": "crawler" }, { "name": "Websphere Commerce search index lifecycle services - version 9" }, { "name": "priceMode" } ], "paths": { "/health/ping": { "get": { "tags": [ "health" ], "summary": "Ping the search server.", "operationId": "ping", "responses": { "200": { "description": "The request is completed successfully.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} }, "503": { "description": "Service unavailable.", "content": {} } } } }, "/health/status": { "get": { "tags": [ "Websphere Commerce search health check services" ], "summary": "checks the health status of all indexes", "description": "This service performs an enviornment health check and a ping service check. Once the operation is completed, it returns a summary of this health check status. This service can be performed on the Search Master, Repeater, or Slave server. However, the logic performed would be slightly different depending on which type of server it is run on.", "operationId": "checkHealthStatus", "parameters": [ { "name": "type", "in": "query", "description": "The type to perform health check against, supported values are: environment or container", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexReplicateStatus" } } } }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/crawler": { "get": { "tags": [ "crawler" ], "summary": "crawls an external website content", "description": "This service crawls website content to search server, and then build those conents into index according to configuration", "operationId": "crawler", "parameters": [ { "name": "action", "in": "query", "description": "The action to perform, supported values are: start, status or stop", "required": true, "schema": { "type": "string", "enum": [ "start", "status", "stop" ] } }, { "name": "langId", "in": "query", "description": "the language id to build index into with the crawled content, required when action is start", "schema": { "type": "string", "default": -1 } }, { "name": "catalogId", "in": "query", "description": "the catalog id to build index into with the crawled content, required when action is start", "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "the store id to build index into with the crawled content, required when action is start", "schema": { "type": "string" } } ], "responses": { "200": { "description": "When action is start, crawler is started, but do not mean it's executed successfully. For other query parameter, the request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Crawler" } } } }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/index/cache/invalidate": { "post": { "tags": [ "Websphere Commerce search index lifecycle services - version 9" ], "summary": "generates cache invalidation events", "description": "This service generates cache invalidation events based on recent index changes on the search Repeater server. This service should only be performed on the Search Repeater server.", "operationId": "invalidateCache", "parameters": [ { "name": "sinceWhen", "in": "query", "description": "Last execution date and time of cache invalidation. ", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON Input body for indexProfileOverride", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IndexProfileOverridePropertiesBodyDescription" } } }, "required": false }, "responses": { "202": { "description": "The requested resource has been accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexJobStatusResponseModel" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } }, "x-codegen-request-body-name": "indexProfileOverridePostInputBody" } }, "/index/replicate": { "post": { "tags": [ "Websphere Commerce search index lifecycle services - version 9" ], "summary": "replicates the index for a given profile type and an index identifier", "description": "Replicating Digital Commerce search index maintains your search index data in more than one location, and involves copying designated changes for one location to another and synchronizing the data in both locations. This service performs the requested replication using the given profile type and an index identifier. This service should only be performed on the Search Repeater or Slave server. Do not perform this operation on the Search Master server.", "operationId": "replicate", "parameters": [ { "name": "indexId", "in": "query", "description": "the indexing scope Identifier", "schema": { "type": "string", "default": "all" } }, { "name": "indexName", "in": "query", "description": "the name of the index (e.g catalog, inventory, price)", "schema": { "type": "string", "default": "catalog", "enum": [ "catalog", "inventory", "price" ] } }, { "name": "langId", "in": "query", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" isn't specified, then the store default language shall be used.", "schema": { "type": "string", "default": "all" } } ], "requestBody": { "description": "JSON Input body for indexProfileOverride", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IndexProfileOverridePropertiesBodyDescription" } } }, "required": false }, "responses": { "202": { "description": "The requested resource has been accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexJobStatusResponseModel" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } }, "x-codegen-request-body-name": "indexProfileOverridePostInputBody" } }, "/index/replicate/status": { "get": { "tags": [ "Websphere Commerce search index lifecycle services - version 9" ], "summary": "retrieves the replication status of the index for a given profile type and an index identifier", "description": "This service retrieves the replication status of the index using the submitted job number status identifier. This service should only be performed on the Search Repeater or Slave server. Do not perform this operation on the Search Master server.", "operationId": "replicateStatus", "parameters": [ { "name": "jobStatusId", "in": "query", "description": "the submitted job status identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/indexReplicateStatusResponseModel" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/index/replicate/summary": { "get": { "tags": [ "Websphere Commerce search index lifecycle services - version 9" ], "summary": "retrieves the replication summary of the index for a given profile type and an index identifier", "description": "This service retrieves the replication summary of the index using the submitted job number status identifier. This service should only be performed on the Search Repeater or Slave server. Do not perform this operation on the Search Master server.", "operationId": "replicateSummary", "parameters": [ { "name": "jobStatusId", "in": "query", "description": "the submitted job status identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/indexReplicateSummaryResponseModel" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/pricesetting/compatiblePriceIndex": { "get": { "tags": [ "priceMode" ], "summary": "Get compatiblePriceIndex configuration", "operationId": "getPriceIndex", "parameters": [ { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": {} }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/pricesetting/mode": { "get": { "tags": [ "priceMode" ], "summary": "Get price mode configuration", "operationId": "getPriceMode", "parameters": [ { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": {} }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/pricesetting/mode/{priceMode}": { "post": { "tags": [ "priceMode" ], "summary": "Update price mode related setting", "operationId": "updatePriceMode", "parameters": [ { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "string" } }, { "name": "priceMode", "in": "path", "description": "The price mode.", "required": true, "schema": { "type": "string" } }, { "name": "compatiblePriceIndex", "in": "query", "description": "The compatible price index", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The request is completed successfully.", "content": {} }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/stores/{storeId}/job_statuses": { "get": { "tags": [ "scheduler" ], "summary": "Gets job statuses by the criteria specified.", "operationId": "getJobStatuses", "parameters": [ { "name": "tenantId", "in": "query", "description": "The tenantId ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "jobId", "in": "query", "description": "The job IDs.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "environmentId", "in": "query", "description": "The environment ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "query", "description": "The user ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "command", "in": "query", "description": "The commands.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "recurring", "in": "query", "description": "Recurring.", "schema": { "type": "boolean" } }, { "name": "jobInstanceId", "in": "query", "description": "The job instance IDs.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "state", "in": "query", "description": "The states.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "preferredStartTimeGte", "in": "query", "description": "Preferred start time greater than or equal to.", "schema": { "type": "string" } }, { "name": "preferredStartTimeLt", "in": "query", "description": "Preferred start time less than.", "schema": { "type": "string" } }, { "name": "actualStartTimeGte", "in": "query", "description": "Actual start time greater than or equal to.", "schema": { "type": "string" } }, { "name": "actualStartTimeLt", "in": "query", "description": "Actual start time less than.", "schema": { "type": "string" } }, { "name": "_sort", "in": "query", "description": "The sorting rules.", "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "The first item to return.", "schema": {} }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "schema": {} }, { "name": "_fields", "in": "query", "description": "The fields to return.", "schema": { "type": "string" } }, { "name": "_meta", "in": "query", "description": "Whether to return metadata.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusResponseContainer" } } } } } } }, "/stores/{storeId}/jobs": { "get": { "tags": [ "scheduler" ], "summary": "Gets jobs by the criteria specified.", "operationId": "getJobs", "parameters": [ { "name": "tenantId", "in": "query", "description": "The tenantId ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "jobId", "in": "query", "description": "The job IDs.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "environmentId", "in": "query", "description": "The environment ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "query", "description": "The user ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "command", "in": "query", "description": "The commands.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "recurring", "in": "query", "description": "Recurring.", "schema": { "type": "boolean" } }, { "name": "startTimeGte", "in": "query", "description": "Start time greater than or equal to.", "schema": { "type": "string" } }, { "name": "startTimeLt", "in": "query", "description": "Start time less than.", "schema": { "type": "string" } }, { "name": "_sort", "in": "query", "description": "The sorting rules.", "schema": { "type": "string" } }, { "name": "_offset", "in": "query", "description": "The first item to return.", "schema": {} }, { "name": "_limit", "in": "query", "description": "The maximum number of items to return.", "schema": {} }, { "name": "_fields", "in": "query", "description": "The fields to return.", "schema": { "type": "string" } }, { "name": "_meta", "in": "query", "description": "Whether to return metadata.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseContainer" } } } } } }, "post": { "tags": [ "scheduler" ], "summary": "Creates a job.", "operationId": "createJob", "parameters": [ { "name": "tenantId", "in": "query", "description": "The tenantId ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRequest" } } }, "required": false }, "responses": { "201": { "description": "The requested resource has been created.", "headers": { "Location": { "description": "Link to the newly created resource.", "schema": { "type": "string" } } }, "content": {}, "links": { "GetJobByJobId": { "operationRef": "#/paths/~1jobs~1{jobId}/get", "parameters": { "jobId": "$request.path.id" }, "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /jobs/{jobId}`.\n" }, "DeleteJobByJobId": { "operationRef": "#/paths/~1jobs~1{jobId}/delete", "parameters": { "jobId": "$request.path.id" }, "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /jobs/{jobId}`.\n" } } } }, "x-codegen-request-body-name": "body" } }, "/stores/{storeId}/jobs/{jobId}": { "get": { "tags": [ "scheduler" ], "summary": "Finds a job by its ID.", "operationId": "getJobById", "parameters": [ { "name": "tenantId", "in": "query", "description": "The tenantId ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "jobId", "in": "path", "description": "The job ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "_fields", "in": "query", "description": "The fields to return.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } } } }, "delete": { "tags": [ "scheduler" ], "summary": "Deletes a job.", "operationId": "deleteJob", "parameters": [ { "name": "tenantId", "in": "query", "description": "The tenantId ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "path", "description": "The store ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "jobId", "in": "path", "description": "The job ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "The operation was successful.", "content": {} } } } } }, "components": { "schemas": { "indexReplicateSummaryResponseModel": { "required": [ "indexReplicateSummary" ], "type": "object", "properties": { "indexReplicateSummary": { "$ref": "#/components/schemas/IndexReplicateSummary" } } }, "indexBuildSummaryResponseModel": { "required": [ "indexBuildSummary" ], "type": "object", "properties": { "indexBuildSummary": { "$ref": "#/components/schemas/IndexBuildSummary" } } }, "JobStatusResponseContainer": { "type": "object", "properties": { "href": { "type": "string", "description": "The URL of the link." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatus" } }, "count": { "type": "integer", "format": "int64" } } }, "indexBuildStatusResponseModel": { "required": [ "indexBuildStatus" ], "type": "object", "properties": { "indexBuildStatus": { "$ref": "#/components/schemas/IndexBuildStatus" } } }, "IndexBuildSummary": { "type": "object", "properties": { "finishTime": { "type": "string" }, "startTime": { "type": "string" }, "message": { "type": "string" }, "jobType": { "type": "string" }, "jobStatusId": { "type": "string" }, "status": { "type": "string" } } }, "JobStatus": { "type": "object", "properties": { "id": { "type": "string" }, "actualEndDateTime": { "type": "string" }, "actualStartDateTime": { "type": "string" }, "attemptsLeft": { "type": "integer", "format": "int32" }, "preferredStartDateTime": { "type": "string", "format": "date-time" }, "progress": { "type": "string" }, "progressMessage": { "type": "string" }, "queue": { "type": "string" }, "reasonCode": { "type": "string" }, "recoveryInstance": { "type": "string" }, "result": { "type": "string" }, "jobId": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "state": { "type": "string" }, "updatedDateTime": { "type": "string", "format": "date-time" }, "links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "errors": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } } } } }, "JobStatusContainer": { "type": "object", "properties": { "state": { "type": "string" }, "result": { "type": "string" }, "queue": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "tenantId": { "type": "string" }, "optCounter": { "type": "integer", "format": "int32" }, "jobInstanceId": { "type": "string" }, "jobId": { "type": "string" }, "preferredStartTime": { "type": "string", "format": "date-time" }, "actualStartTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "attemptsLeft": { "type": "integer", "format": "int32" }, "failedJobInstanceId": { "type": "string" } } }, "PropertyOverideListBodyDescription": { "required": [ "propertyName", "propertyValue" ], "type": "object", "properties": { "propertyName": { "type": "string", "description": "propertyName" }, "propertyValue": { "type": "string", "description": "propertyValue" } } }, "IndexProfileOverridePropertiesBodyDescription": { "type": "object", "properties": { "indexProfileOverrideProperties": { "type": "array", "description": "indexProfileOverrideProperties", "items": { "$ref": "#/components/schemas/PropertyOverideListBodyDescription" } } } }, "indexReplicateStatusResponseModel": { "required": [ "indexReplicateStatus" ], "type": "object", "properties": { "indexReplicateStatus": { "$ref": "#/components/schemas/IndexReplicateStatus" } } }, "IndexReplicateStatus": { "type": "object", "properties": { "status": { "type": "string" } } }, "Crawler": { "type": "object", "properties": { "status": { "type": "string" }, "info": { "type": "string" } } }, "IndexReplicateSummary": { "type": "object", "properties": { "message": { "type": "string" } } }, "IndexJobStatusResponseModel": { "required": [ "jobStatusId" ], "type": "object", "properties": { "jobStatusId": { "type": "string", "description": "jobStatusId" } } }, "IndexBuildStatus": { "type": "object", "properties": { "finishTime": { "type": "string" }, "lastUpdate": { "type": "string" }, "progress": { "type": "string" }, "startTime": { "type": "string" }, "message": { "type": "string" }, "jobType": { "type": "string" }, "jobStatusId": { "type": "string" }, "status": { "type": "string" } } }, "Job": { "type": "object", "properties": { "id": { "type": "string" }, "activeState": { "type": "string" }, "command": { "type": "string" }, "host": { "type": "string" }, "interval": { "type": "integer", "format": "int32" }, "jobType": { "type": "string" }, "preferredStartDateTime": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "query": { "type": "string" }, "retryAttempts": { "type": "integer", "format": "int32" }, "retryDelay": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "storeId": { "type": "integer", "format": "int32" }, "userId": { "type": "string" }, "description": { "type": "string" }, "interfaceName": { "type": "string" }, "fixedTime": { "type": "integer", "format": "int32" }, "links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "job-statuses": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "broadcast-job-statuses": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "active-jobs": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } } } } }, "JobRequest": { "type": "object", "properties": { "checkCmdId": { "type": "string" }, "checkCommandInterface": { "type": "string" }, "checkCommandName": { "type": "string" }, "command": { "type": "string" }, "jobType": { "type": "string" }, "preferredStartDateTime": { "type": "string" }, "priority": { "type": "integer" }, "query": { "type": "string" }, "retryAttempts": { "type": "integer" }, "retryDelay": { "type": "integer" }, "sequence": { "type": "integer" }, "storeId": { "type": "integer" } } }, "JobResponseContainer": { "type": "object", "properties": { "href": { "type": "string", "description": "The URL of the link." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "count": { "type": "integer", "format": "int64" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "x-components": {} }