Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getSearchIndexingStatus_response

Type: object

Show Source

• 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.

{
    "properties":{
        "historyItemCount":{
            "description":"Total count of history items.",
            "type":"integer"
        },
        "baselineSchedule":{
            "description":"Scheduled baseline information.",
            "type":"object",
            "properties":{
                "occurrences":{
                    "description":"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 \"*\").",
                    "type":"string"
                },
                "hours":{
                    "description":"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 \"*\").",
                    "type":"string"
                },
                "months":{
                    "description":"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 \"*\").",
                    "type":"string"
                },
                "parseString":{
                    "description":"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",
                    "type":"string"
                },
                "minutes":{
                    "description":"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 \"*\").",
                    "type":"string"
                },
                "daysOfMonth":{
                    "description":"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 \"*\").",
                    "type":"string"
                },
                "timeZone":{
                    "description":"The optional time zone to use when interpretting the schedule. If not specified, defaults to the time zone of the server JVM.",
                    "type":"string"
                },
                "locale":{
                    "description":"The optional locale to use. Defaults to the US locale.",
                    "type":"string"
                },
                "daysOfWeek":{
                    "description":"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 \"*\").",
                    "type":"string"
                }
            }
        },
        "indexingJob":{
            "description":"The overall state information of indexing job.",
            "type":"object",
            "properties":{
                "finishTime":{
                    "description":"The finish time for the job in milliseconds.",
                    "type":"number"
                },
                "forcedToBaseline":{
                    "description":"Whether this is forced to baseline.",
                    "type":"boolean"
                },
                "success":{
                    "description":"Overall result of the job.",
                    "type":"string"
                },
                "startTime":{
                    "description":"The start time for the job in milliseconds.",
                    "type":"number"
                },
                "baseline":{
                    "description":"Whether this is a baseline index. True means baseline, false means partial.",
                    "type":"boolean"
                },
                "phases":{
                    "description":"An indexing job is made up of indexing phases, which in turn create indexing tasks.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "finishTime":{
                                "description":"The finish time for the phase in milliseconds.",
                                "type":"number"
                            },
                            "startTime":{
                                "description":"The start time for the phase in milliseconds.",
                                "type":"number"
                            },
                            "phaseName":{
                                "description":"Name of the phase.",
                                "type":"string"
                            },
                            "tasks":{
                                "description":"Tasks involved in the indexing job.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "description":"Whether this task was successful.",
                                            "type":"boolean"
                                        },
                                        "successCount":{
                                            "description":"Count of items successful.",
                                            "type":"integer"
                                        },
                                        "supportsStatusCounts":{
                                            "description":"Whether supports status count was enabled",
                                            "type":"boolean"
                                        },
                                        "indexablePath":{
                                            "description":"The Nucleus path of indexable component.",
                                            "type":"string"
                                        },
                                        "failureCount":{
                                            "description":"Count of items failed.",
                                            "type":"integer"
                                        },
                                        "status":{
                                            "description":"The status of the task.",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "status":{
                    "description":"The overall status of the job.",
                    "type":"string"
                }
            }
        },
        "historyItems":{
            "description":"Repository items representing the indexing job history.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The repository id of history item.",
                    "type":"string"
                }
            }
        },
        "indexingJobQueue":{
            "description":"The array of queued jobs.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The repository id of queued job.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"Scheduled baseline information.",
    "type":"object",
    "properties":{
        "occurrences":{
            "description":"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 \"*\").",
            "type":"string"
        },
        "hours":{
            "description":"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 \"*\").",
            "type":"string"
        },
        "months":{
            "description":"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 \"*\").",
            "type":"string"
        },
        "parseString":{
            "description":"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",
            "type":"string"
        },
        "minutes":{
            "description":"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 \"*\").",
            "type":"string"
        },
        "daysOfMonth":{
            "description":"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 \"*\").",
            "type":"string"
        },
        "timeZone":{
            "description":"The optional time zone to use when interpretting the schedule. If not specified, defaults to the time zone of the server JVM.",
            "type":"string"
        },
        "locale":{
            "description":"The optional locale to use. Defaults to the US locale.",
            "type":"string"
        },
        "daysOfWeek":{
            "description":"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 \"*\").",
            "type":"string"
        }
    }
}

Nested Schema : historyItems

Type: object

Repository items representing the indexing job history.

Show Source

• repositoryId(optional): string
  The repository id of history item.

{
    "description":"Repository items representing the indexing job history.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The repository id of history item.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The overall state information of indexing job.",
    "type":"object",
    "properties":{
        "finishTime":{
            "description":"The finish time for the job in milliseconds.",
            "type":"number"
        },
        "forcedToBaseline":{
            "description":"Whether this is forced to baseline.",
            "type":"boolean"
        },
        "success":{
            "description":"Overall result of the job.",
            "type":"string"
        },
        "startTime":{
            "description":"The start time for the job in milliseconds.",
            "type":"number"
        },
        "baseline":{
            "description":"Whether this is a baseline index. True means baseline, false means partial.",
            "type":"boolean"
        },
        "phases":{
            "description":"An indexing job is made up of indexing phases, which in turn create indexing tasks.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "finishTime":{
                        "description":"The finish time for the phase in milliseconds.",
                        "type":"number"
                    },
                    "startTime":{
                        "description":"The start time for the phase in milliseconds.",
                        "type":"number"
                    },
                    "phaseName":{
                        "description":"Name of the phase.",
                        "type":"string"
                    },
                    "tasks":{
                        "description":"Tasks involved in the indexing job.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "success":{
                                    "description":"Whether this task was successful.",
                                    "type":"boolean"
                                },
                                "successCount":{
                                    "description":"Count of items successful.",
                                    "type":"integer"
                                },
                                "supportsStatusCounts":{
                                    "description":"Whether supports status count was enabled",
                                    "type":"boolean"
                                },
                                "indexablePath":{
                                    "description":"The Nucleus path of indexable component.",
                                    "type":"string"
                                },
                                "failureCount":{
                                    "description":"Count of items failed.",
                                    "type":"integer"
                                },
                                "status":{
                                    "description":"The status of the task.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "status":{
            "description":"The overall status of the job.",
            "type":"string"
        }
    }
}

Nested Schema : indexingJobQueue

Type: object

The array of queued jobs.

Show Source

• repositoryId(optional): string
  The repository id of queued job.

{
    "description":"The array of queued jobs.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The repository id of queued job.",
            "type":"string"
        }
    }
}

Nested Schema : phases

Type: array

An indexing job is made up of indexing phases, which in turn create indexing tasks.

Show Source

• Array of: object items

{
    "description":"An indexing job is made up of indexing phases, which in turn create indexing tasks.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "finishTime":{
                "description":"The finish time for the phase in milliseconds.",
                "type":"number"
            },
            "startTime":{
                "description":"The start time for the phase in milliseconds.",
                "type":"number"
            },
            "phaseName":{
                "description":"Name of the phase.",
                "type":"string"
            },
            "tasks":{
                "description":"Tasks involved in the indexing job.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "success":{
                            "description":"Whether this task was successful.",
                            "type":"boolean"
                        },
                        "successCount":{
                            "description":"Count of items successful.",
                            "type":"integer"
                        },
                        "supportsStatusCounts":{
                            "description":"Whether supports status count was enabled",
                            "type":"boolean"
                        },
                        "indexablePath":{
                            "description":"The Nucleus path of indexable component.",
                            "type":"string"
                        },
                        "failureCount":{
                            "description":"Count of items failed.",
                            "type":"integer"
                        },
                        "status":{
                            "description":"The status of the task.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "finishTime":{
            "description":"The finish time for the phase in milliseconds.",
            "type":"number"
        },
        "startTime":{
            "description":"The start time for the phase in milliseconds.",
            "type":"number"
        },
        "phaseName":{
            "description":"Name of the phase.",
            "type":"string"
        },
        "tasks":{
            "description":"Tasks involved in the indexing job.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "success":{
                        "description":"Whether this task was successful.",
                        "type":"boolean"
                    },
                    "successCount":{
                        "description":"Count of items successful.",
                        "type":"integer"
                    },
                    "supportsStatusCounts":{
                        "description":"Whether supports status count was enabled",
                        "type":"boolean"
                    },
                    "indexablePath":{
                        "description":"The Nucleus path of indexable component.",
                        "type":"string"
                    },
                    "failureCount":{
                        "description":"Count of items failed.",
                        "type":"integer"
                    },
                    "status":{
                        "description":"The status of the task.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : tasks

Type: array

Tasks involved in the indexing job.

Show Source

• Array of: object items

{
    "description":"Tasks involved in the indexing job.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "success":{
                "description":"Whether this task was successful.",
                "type":"boolean"
            },
            "successCount":{
                "description":"Count of items successful.",
                "type":"integer"
            },
            "supportsStatusCounts":{
                "description":"Whether supports status count was enabled",
                "type":"boolean"
            },
            "indexablePath":{
                "description":"The Nucleus path of indexable component.",
                "type":"string"
            },
            "failureCount":{
                "description":"Count of items failed.",
                "type":"integer"
            },
            "status":{
                "description":"The status of the task.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "success":{
            "description":"Whether this task was successful.",
            "type":"boolean"
        },
        "successCount":{
            "description":"Count of items successful.",
            "type":"integer"
        },
        "supportsStatusCounts":{
            "description":"Whether supports status count was enabled",
            "type":"boolean"
        },
        "indexablePath":{
            "description":"The Nucleus path of indexable component.",
            "type":"string"
        },
        "failureCount":{
            "description":"Count of items failed.",
            "type":"integer"
        },
        "status":{
            "description":"The status of the task.",
            "type":"string"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top