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
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getSearchIndexingStatus_response
Type: object
Show Source
Nested Schema : baselineSchedule
Type: object
Scheduled baseline information.
Show Source
  • 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 "*").
  • 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 "*").
  • 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 "*").
  • The optional locale to use. Defaults to the US locale.
  • 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 "*").
  • 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 "*").
  • 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 "*").
  • The complete atg.service.scheduler.CalendarSchedule parse string. If present, will be used instead of hours, minutes, etc. A null parseString value will delete the baseline schedule
  • 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
Nested Schema : indexingJob
Type: object
The overall state information of indexing job.
Show Source
Nested Schema : indexingJobQueue
Type: object
The array of queued jobs.
Show Source
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: object
Show Source
Nested Schema : tasks
Type: array
Tasks involved in the indexing job.
Show Source
Nested Schema : items
Type: object
Show Source
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
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top