Update Schema for a Data Source (REST API: POST)

This operation updates the schema for a data source in Data Cube.

Caution

If you update the schema for a data source without first clearing the content of the data source, then there might be inconsistencies in the data. Therefore, consider deleting the contents of the data source before you update the schema. For information about clearing the data source, see Delete Data Source Content in Data Cube (REST API: POST).

Request

Syntax

POST webservice/dcube/updateschema HTTP/1.1 Host: host name Accept: application/xml Authtoken: authentication token update_schema_for_data_source_template.xml

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 Headers

Name	Description
Host	The host name of the Web Server or Command Center that is used in the API request.
Accept	The format of the response. Valid values are: application/xml.
Authtoken	The authentication token that you receive after successfully logging on. For details on receiving an authentication token, see Authentication.

XML

Download the update_schema_for_data_source_template.xml file that required for this request. The following table displays the parameters for the update_schema_for_data_source_template.xml file.

Note

In the XML template, you can add or remove as many <schemaFields> entries as you need.

Parameter	Description	Element	Parent Element
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.	DM2ContentIndexing_ManageSchemaReq
fieldName	The name of the data field.	schemaFields	schema
type	The type of data in the data field. Valid values are as follows: string int float long double date longstring	schemaFields	schema
indexed	A number that indicates whether the data in the field is crawled and indexed (1), or not be crawled and indexed (0).	schemaFields	schema
stored	A number that indicates whether the data in the field is stored in the index (1), or not be stored in the index (0).	schemaFields	schema
multiValued	A number that indicates whether the data in the field contains a single value (0), or multiple values (1).	schemaFields	schema
searchDefault	A number that indicates whether queries of the data source search the values in the data field by default (1), or do not search the data field by default (0).	schemaFields	schema
autocomplete	A number that indicates whether the data in the field is included in auto-completion (1), or is not included in auto-completion (0).	schemaFields	dschema

Examples

Sample Request

POST webservice/dcube/updateschema HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
<DM2ContentIndexing_ManageSchemaReq datasourceId="50">
    <schema>
        <schemaFields fieldName="SampleID" type="string" indexed="1" stored="1" multiValued="0" searchDefault="1" autocomplete="0"/>
        <schemaFields fieldName="SampleName" type="string" indexed="1" stored="1" multiValued="0" searchDefault="1" autocomplete="0"/>
    </schema>
</DM2ContentIndexing_ManageSchemaReq>

Sample Response

<DM2ContentIndexing_Error errLogMessage="Updated schema successfully" errorCode="0" />