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

This operation returns the status of and information about the most recent crawling operation for a data source in Data Cube.

Request

Syntax

GET <webservice>/dcube/GetStatus/{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 the data source ID is not known, use the View Data Sources and Properties (REST API: GET)to retrieve it.	Yes

Name

Description

Required

datasourceId

The data source ID for the data source.

If the data source ID is not known, 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 is received after you successfully log on. For more information about receiving an authentication token, see Authentication.

Name

Description

Host

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

The format of the response.

Valid value is: application/xml.

Authtoken

The authentication token that is received after you successfully log on.

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

Response

Response Parameters

Parameter	Description	Element
Number of items failed	The number of items that failed in the most recent crawl operation.	numFailed
Total count	The number of items that were successful in the most recent crawl operation.	totalcount
End time	The time that the most recent crawl ended. Shown in UTC format.	endUTCTime
Number of items denied access	The number of items that were skipped in the most recent crawl operation because of access restrictions.	numAccessDenied
Number of items added	The number of items that were added to the data source in the most recent crawl operation.	numAdded
Start time	The time that the most recent crawl started. Shown in UTC format. Valid values are: Idle: 0 Starting: 1 Running: 2 Finishing: 3 Finished: 4 Stopping: 5 Stopped: 6 Aborting: 7 Aborted: 10 Exception: 11 Syncing: 13	startUTCTime

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_SEJobResp>  <status numFailed="0" totalcount="18" endUTCTime="1481804801" numAccessDenied="0" numAdded="18" startUTCTime="1481804800" state="4" />

</DM2ContentIndexing_SEJobResp>