doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0318.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2024-03-01 11:46:15 +00:00

152 lines
17 KiB
HTML

<a name="dataartsstudio_02_0318"></a><a name="dataartsstudio_02_0318"></a>
<h1 class="topictitle1">Common Message Headers </h1>
<div id="body0000001251236949"><div class="section" id="dataartsstudio_02_0318__section4225143513717"><h4 class="sectiontitle">Common request header fields</h4><p id="dataartsstudio_02_0318__p8225113512371"><a href="#dataartsstudio_02_0318__table92251435133719">Table 1</a> describes common request headers.</p>
<div class="tablenoborder"><a name="dataartsstudio_02_0318__table92251435133719"></a><a name="table92251435133719"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0318__table92251435133719" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request header fields</caption><thead align="left"><tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_row1286841153311"><th align="left" class="cellrowborder" valign="top" width="13.88%" id="mcps1.3.1.3.2.5.1.1"><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p178680183310"><strong id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_en-us_topic_0113746487_b1355613001117">Field</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.08%" id="mcps1.3.1.3.2.5.1.2"><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p78688118335"><strong id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_en-us_topic_0113746487_b612662015512">Description</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.259999999999998%" id="mcps1.3.1.3.2.5.1.3"><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p58686123316"><strong id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_en-us_topic_0113746487_b812872012519">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.779999999999998%" id="mcps1.3.1.3.2.5.1.4"><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p48681314333"><strong id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_en-us_topic_0113746487_b812932085119">Example</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_row386818143313"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p118689123320">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1486815116337">Request body type or format. Its default value is <span class="parmvalue" id="dataartsstudio_02_0318__making_request_parmvalue108912521353"><b>application/json</b></span>.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1086812114335">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1186841163310">application/json</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_row11868419337"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p178687119330">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p178681813332">Specifies the length of the request body. The unit is byte.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p18687183316">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p148689110334">3495</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_row1732253992112"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_p229714328223">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_p1529873218222">Specifies the request language.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_p8298133212224">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_p20298432152214">en_us</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_row2868171143313"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p586815118338">X-Project-Id</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1586811163312">Specifies a project ID. Obtain the project ID by following the instructions in <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p886812110335">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p198684143315">e9993fc787d94b6c886cbaa340f9c0f4</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_row188688113337"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p198684111335">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1086851153317">Specifies a user token.</p>
<p id="dataartsstudio_02_0318__making_request_p4825143942914">The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.</p>
<p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p1057635831">The token is the value of <strong id="dataartsstudio_02_0318__making_request_b18846637144615">X-Subject-Token</strong> in the response header.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p4868514338">This field is mandatory for token authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p27152505302">The following is part of an example token:</p>
<p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p168689113318">MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_row412429192816"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_p10782mcpsimp">X-Sdk-Date</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_p10784mcpsimp">Time when the request is sent. The time is in <strong id="dataartsstudio_02_0318__making_request_b12592411246">YYYYMMDD'T'HHMMSS'Z'</strong> format.</p>
<p id="dataartsstudio_02_0318__making_request_p10785mcpsimp">The value is the current GMT time of the system.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_p10787mcpsimp">This field is mandatory for AK/SK-based authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_p10789mcpsimp">20150907T101459Z</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_row92971324228"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p2086813163316">Host</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p58681814333">Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of <em id="dataartsstudio_02_0318__making_request_en-us_topic_0171007788_en-us_topic_0121682347_i1012185414574">hostname[:port]</em>. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p886815123319">This field is mandatory for AK/SK-based authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p486814118330">code.test.com</p>
<p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p5868161163317">or</p>
<p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281315_en-us_topic_0170647348_en-us_topic_0121682347_p786841123315">code.test.com:443</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_row1394612515242"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_p10792mcpsimp">Authorization</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_p10794mcpsimp">Authentication information.</p>
<p id="dataartsstudio_02_0318__making_request_p10795mcpsimp">The value can be obtained from the request signing result.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_p10799mcpsimp">This field is mandatory for AK/SK-based authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_p10801mcpsimp">-</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_row10534534112310"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_en-us_topic_0181281363_p169341251122511">Workspace ID. For details about how to obtain it, see <a href="dataartsstudio_02_0350.html">DataArts Studio Instance ID and Workspace ID</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><ul id="dataartsstudio_02_0318__making_request_ul1960555713242"><li id="dataartsstudio_02_0318__making_request_li1860516570243">You do not need to set this field when calling a CDM API because in that case, only the default workspace can be used.</li><li id="dataartsstudio_02_0318__making_request_li115375842915">This field is mandatory when there are multiple DataArts Studio instances during a call to a data development API.<p id="dataartsstudio_02_0318__making_request_p13534195819299"><a name="dataartsstudio_02_0318__making_request_li115375842915"></a><a name="making_request_li115375842915"></a>This field is optional when there is only one DataArts Studio instance. If this field is not specified, data in the default workspace is queried by default. To query data in other workspaces, include this field in the request header.</p>
</li></ul>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_p10859mcpsimp">d1cd7861478748a6925bc02f47c69279</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__making_request_row8351550141410"><td class="cellrowborder" valign="top" width="13.88%" headers="mcps1.3.1.3.2.5.1.1 "><p id="dataartsstudio_02_0318__making_request_p10862mcpsimp">X-Dlm-Type</p>
</td>
<td class="cellrowborder" valign="top" width="36.08%" headers="mcps1.3.1.3.2.5.1.2 "><p id="dataartsstudio_02_0318__making_request_p10864mcpsimp">DataArts DataService edition, which is Exclusive</p>
</td>
<td class="cellrowborder" valign="top" width="25.259999999999998%" headers="mcps1.3.1.3.2.5.1.3 "><p id="dataartsstudio_02_0318__making_request_p10866mcpsimp">This parameter is mandatory for calling DataArts DataService APIs.</p>
</td>
<td class="cellrowborder" valign="top" width="24.779999999999998%" headers="mcps1.3.1.3.2.5.1.4 "><p id="dataartsstudio_02_0318__making_request_p10869mcpsimp"><strong id="dataartsstudio_02_0318__making_request_b16981513193813">EXCLUSIVE</strong>: exclusive edition</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0318__section8305418193719"><h4 class="sectiontitle">Common response headers</h4><p id="dataartsstudio_02_0318__p1901224123719"><a href="#dataartsstudio_02_0318___table27956731162223">Table 2</a> describes common response headers.</p>
<div class="tablenoborder"><a name="dataartsstudio_02_0318___table27956731162223"></a><a name="_table27956731162223"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0318___table27956731162223" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Common response headers</caption><thead align="left"><tr id="dataartsstudio_02_0318__row109mcpsimp"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.2.3.2.3.1.1"><p id="dataartsstudio_02_0318__p111mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.2.3.2.3.1.2"><p id="dataartsstudio_02_0318__p113mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0318__row115mcpsimp"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.3.2.3.1.1 "><p id="dataartsstudio_02_0318__p117mcpsimp">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.3.2.3.1.2 "><p id="dataartsstudio_02_0318__p119mcpsimp">Length of the response body. The unit is byte.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__row120mcpsimp"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.3.2.3.1.1 "><p id="dataartsstudio_02_0318__p122mcpsimp">Date</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.3.2.3.1.2 "><p id="dataartsstudio_02_0318__p124mcpsimp">Time when a response is returned</p>
</td>
</tr>
<tr id="dataartsstudio_02_0318__row125mcpsimp"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.3.2.3.1.1 "><p id="dataartsstudio_02_0318__p127mcpsimp">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.3.2.3.1.2 "><p id="dataartsstudio_02_0318__p129mcpsimp">Request body MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0309.html">Appendix</a></div>
</div>
</div>