REST API for Oracle Commerce Cloud December 2017

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: Type: boolean

The ending index of history items to include.
historyStartingIndex: Type: boolean

The starting index of history items to include.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getSearchIndexingStatus_response

Properties

baselineSchedule: Type: object baselineSchedule

Additional Properties Allowed:

Scheduled baseline information.
historyItemCount: Type: integer

Total count of history items.
historyItems: Type: object historyItems

Additional Properties Allowed:

Repository items representing the indexing job history.
indexingJob: Type: object indexingJob

Additional Properties Allowed:

The overall state information of indexing job.
indexingJobQueue: Type: object indexingJobQueue

Additional Properties Allowed:

The array of queued jobs.

Nested Schema : baselineSchedule

Type: object

Scheduled baseline information.

Properties

daysOfMonth: Type: 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: Type: 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: Type: 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: Type: string

The optional locale to use. Defaults to the US locale.
minutes: Type: 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: Type: 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: Type: 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: Type: string

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
timeZone: Type: 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.

Properties

repositoryId: Type: string

The repository id of history item.

Nested Schema : indexingJob

Type: object

The overall state information of indexing job.

Properties

baseline: Type: boolean

Whether this is a baseline index. True means baseline, false means partial.
finishTime: Type: number

The finish time for the job in milliseconds.
forcedToBaseline: Type: boolean

Whether this is forced to baseline.
phases: Type: array phases

Additional Properties Allowed:

An indexing job is made up of indexing phases, which in turn create indexing tasks.
startTime: Type: number

The start time for the job in milliseconds.
status: Type: string

The overall status of the job.
success: Type: string

Overall result of the job.

Nested Schema : indexingJobQueue

Type: object

The array of queued jobs.

Properties

repositoryId: Type: 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.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

finishTime: Type: number

The finish time for the phase in milliseconds.
phaseName: Type: string

Name of the phase.
startTime: Type: number

The start time for the phase in milliseconds.
tasks: Type: array tasks

Additional Properties Allowed:

Tasks involved in the indexing job.

Nested Schema : tasks

Type: array

Tasks involved in the indexing job.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

failureCount: Type: integer

Count of items failed.
indexablePath: Type: string

The Nucleus path of indexable component.
status: Type: string

The status of the task.
success: Type: boolean

Whether this task was successful.
successCount: Type: integer

Count of items successful.
supportsStatusCounts: Type: boolean

Whether supports status count was enabled

Example application/json


{
    "historyItemCount":4,
    "baselineSchedule":{
        "occurrences":"*",
        "hours":"2",
        "months":"*",
        "minutes":"1",
        "parseString":"* * * * 2 1",
        "daysOfMonth":"*",
        "timeZone":"EST",
        "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "historyItemCount": 4,
  "baselineSchedule": {
    "occurrences": "*",
    "hours": "2",
    "months": "*",
    "minutes": "1",
    "parseString": "* * * * 2 1",
    "daysOfMonth": "*",
    "timeZone": "EST",
    "daysOfWeek": "*"
  },
  "indexingJob": {
    "finishTime": 1415083869326,
    "forcedToBaseline": false,
    "forcedToBaselineFullExport": false,
    "success": true,
    "startTime": 1415083839107,
    "baseline": false,
    "phases": [
      {
        "finishTime": 1415083839113,
        "startTime": 1415083839109,
        "tasks": [{
          "success": true,
          "supportsStatusCounts": false,
          "successCount": 0,
          "indexablePath": "/atg/commerce/endeca/index/CategoryTreeService",
          "failureCount": 0,
          "status": "COMPLETE"
        }],
        "phaseName": "PreIndexing"
      },
      {
        "finishTime": 1415083869325,
        "startTime": 1415083839113,
        "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": 1415083869326,
        "startTime": 1415083869325,
        "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": []
}