getSearchIndexingStatus
get
/ccadmin/v1/search/index
Get Search Indexing Status. Get the search indexing status. Includes information about the current indexing job, queued indexing job, and search history.
Request
Supported Media Types
- application/json
Query Parameters
-
historyEndingIndex(optional): boolean
The ending index of history items to include.
-
historyStartingIndex(optional): boolean
The starting index of history items to include.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSearchIndexingStatus_response
Type:
Show Source
object
-
baselineSchedule(optional):
object baselineSchedule
Scheduled baseline information.
-
historyItemCount(optional):
integer
Total count of history items.
-
historyItems(optional):
object historyItems
Repository items representing the indexing job history.
-
indexingJob(optional):
object indexingJob
The overall state information of indexing job.
-
indexingJobQueue(optional):
object indexingJobQueue
The array of queued jobs.
Nested Schema : baselineSchedule
Type:
object
Scheduled baseline information.
Show Source
-
daysOfMonth(optional):
string
The day or days of the month on which the schedule occurs. Not used if parseString is specified. If neither parseString or daysOfMonth is specified, defaults to all days of the month (equivalent to "*").
-
daysOfWeek(optional):
string
The day or days of the week on which the schedule occurs. Not used if parseString is specified. If neither parseString nor daysOfWeek is specified, defaults to all days of the the week (equivalent to "*").
-
hours(optional):
string
The hours of the day on which the schedule occurs. Not used if parseString is specified. If neither parseString nor hours is specified, defaults to all hours of the day (equivalent to "*").
-
locale(optional):
string
The optional locale to use. Defaults to the US locale.
-
minutes(optional):
string
The minutes of the hour on which the schedule occurs. Not used if parseString is specified. If neither parseString nor minutes is specified, defaults to all minutes of the hour (equivalent to "*").
-
months(optional):
string
The month or months on which the schedule occurs. Not used if parseString is specified. If neither parseString or months is specified, defaults to all months (equivalent to "*").
-
occurrences(optional):
string
The occurence of the day or days of the week on which the schedule occurs. Not used if parseString is specified. If neither parseString or occurences is specified, defaults to all occurences in the month (equivalent to "*").
-
parseString(optional):
string
The complete calendar schedule parse string. If present, will be used instead of hours, minutes, etc. A null parseString value will delete the baseline schedule
-
timeZone(optional):
string
The optional time zone to use when interpretting the schedule. If not specified, defaults to the time zone of the server JVM.
Nested Schema : historyItems
Type:
object
Repository items representing the indexing job history.
Show Source
-
repositoryId(optional):
string
The repository id of history item.
Nested Schema : indexingJob
Type:
object
The overall state information of indexing job.
Show Source
-
baseline(optional):
boolean
Whether this is a baseline index. True means baseline, false means partial.
-
finishTime(optional):
number
The finish time for the job in milliseconds.
-
forcedToBaseline(optional):
boolean
Whether this is forced to baseline.
-
phases(optional):
array phases
An indexing job is made up of indexing phases, which in turn create indexing tasks.
-
startTime(optional):
number
The start time for the job in milliseconds.
-
status(optional):
string
The overall status of the job.
-
success(optional):
string
Overall result of the job.
Nested Schema : indexingJobQueue
Type:
object
The array of queued jobs.
Show Source
-
repositoryId(optional):
string
The repository id of queued job.
Nested Schema : phases
Type:
array
An indexing job is made up of indexing phases, which in turn create indexing tasks.
Show Source
Nested Schema : items
Type:
Show Source
object
-
finishTime(optional):
number
The finish time for the phase in milliseconds.
-
phaseName(optional):
string
Name of the phase.
-
startTime(optional):
number
The start time for the phase in milliseconds.
-
tasks(optional):
array tasks
Tasks involved in the indexing job.
Nested Schema : items
Type:
Show Source
object
-
failureCount(optional):
integer
Count of items failed.
-
indexablePath(optional):
string
The Nucleus path of indexable component.
-
status(optional):
string
The status of the task.
-
success(optional):
boolean
Whether this task was successful.
-
successCount(optional):
integer
Count of items successful.
-
supportsStatusCounts(optional):
boolean
Whether supports status count was enabled
Example Response (application/json)
{
"historyItemCount":4,
"baselineSchedule":{
"occurrences":"*",
"hours":"2",
"months":"*",
"minutes":"1",
"parseString":"* * * * 2 1",
"daysOfMonth":"*",
"timeZone":"EST",
"daysOfWeek":"*"
},
"partialSchedule":{
"occurrences":"*",
"hours":"*",
"months":"*",
"parseString":"* * * * * 0,15,30,45",
"minutes":"0,15,30,45",
"daysOfMonth":"*",
"timeZone":"UTC",
"daysOfWeek":"*"
},
"indexingJob":{
"finishTime":1.415083869326E12,
"forcedToBaseline":false,
"forcedToBaselineFullExport":false,
"success":true,
"startTime":1.415083839107E12,
"baseline":false,
"phases":[
{
"finishTime":1.415083839113E12,
"startTime":1.415083839109E12,
"tasks":[
{
"success":true,
"supportsStatusCounts":false,
"successCount":0,
"indexablePath":"/atg/commerce/endeca/index/CategoryTreeService",
"failureCount":0,
"status":"COMPLETE"
}
],
"phaseName":"PreIndexing"
},
{
"finishTime":1.415083869325E12,
"startTime":1.415083839113E12,
"tasks":[
{
"success":true,
"supportsStatusCounts":true,
"successCount":0,
"indexablePath":"/atg/commerce/endeca/index/SchemaExporter",
"failureCount":0,
"status":"COMPLETE"
},
{
"success":true,
"supportsStatusCounts":true,
"successCount":0,
"indexablePath":"/atg/commerce/endeca/index/CategoryToDimensionOutputConfig",
"failureCount":0,
"status":"COMPLETE"
},
{
"success":true,
"supportsStatusCounts":true,
"successCount":0,
"indexablePath":"/atg/commerce/search/ProductCatalogOutputConfig",
"failureCount":0,
"status":"COMPLETE"
}
],
"phaseName":"RepositoryExport"
},
{
"finishTime":1.415083869326E12,
"startTime":1.415083869325E12,
"tasks":[
{
"success":true,
"supportsStatusCounts":false,
"successCount":0,
"indexablePath":"/atg/commerce/endeca/index/EndecaScriptService",
"failureCount":0,
"status":"COMPLETE"
}
],
"phaseName":"EndecaIndexing"
}
],
"indexingType":"PARTIAL",
"status":"COMPLETE"
},
"historyItems":null,
"indexingJobQueue":[
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code