Loading...

End User Access > Command Center > Developer Tools > REST API > REST API Reference > REST APIs for Data Cube > View Crawling History

View Crawling History for Data Sources in Data Cube (REST API: GET)

This operation returns information about the crawling history for a data source in Data Cube.

Request

Syntax

GET <webservice>/dcube/GetHistory/{datasourceId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

datasourceId

The data source ID for the data source.

If you don't know the data source ID, then you can use the View Data Sources and Properties (REST API: GET)to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response.

Valid value is: application/xml.

Authtoken

The authentication token that you receive after you log on.

For more information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

Number of items failed

Number of items that failed in the latest crawl operation.

numFailed

Total count

Number of items that were successful in the latest crawl operation.

totalcount

End time

Time that the latest crawl ended. Shown in UTC format.

endUTCTime

Number of items denied access

Number of items that were skipped in the latest crawl operation due to access restrictions.

numAccessDenied

Number of items added

Number of items that were added to the data source in the latest crawl operation.

numAdded

Start time

The time that the latest crawl started. Shown in UTC format.

startUTCTime

Job state

The state of the most recent crawl operation.

Valid values are:

  • 0: Idle
  • 1: Starting
  • 2: Running
  • 3: Finishing
  • 4: Finished
  • 5: Stopping
  • 6: Stopped
  • 7: Aborting
  • 10: Aborted
  • 11: Exception
  • 13: Syncing

state

Examples

Sample Request

GET <webservice>/dcube/GetStatus/4452 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<DM2ContentIndexing_DataSourceHistoryResp>
  <status numFailed="310" totalcount="0" endUTCTime="1478151529" numAccessDenied="0" numAdded="170" startUTCTime="1478151106" state="4" />
  <status numFailed="533" totalcount="0" endUTCTime="1472801069" numAccessDenied="0" numAdded="396" startUTCTime="1472800742" state="4" />
  <status numFailed="529" totalcount="0" endUTCTime="1472800511" numAccessDenied="0" numAdded="405" startUTCTime="1472800188" state="4" />
  <status numFailed="524" totalcount="0" endUTCTime="1472799789" numAccessDenied="0" numAdded="397" startUTCTime="1472799412" state="4" />
  <status numFailed="512" totalcount="0" endUTCTime="1472121227" numAccessDenied="0" numAdded="386" startUTCTime="1472120873" state="4" />
  <status numFailed="102" totalcount="0" endUTCTime="1472120866" numAccessDenied="0" numAdded="111" startUTCTime="1472120762" state="4" />
  <status numFailed="439" totalcount="0" endUTCTime="1472120438" numAccessDenied="0" numAdded="353" startUTCTime="1472119994" state="4" />
  <status numFailed="1" totalcount="0" endUTCTime="1472119039" numAccessDenied="0" numAdded="6" startUTCTime="1472118972" state="4" />
</DM2ContentIndexing_DataSourceHistoryResp>

Last modified: 1/31/2019 3:14:25 PM