Help Center/ DataArts Studio/ API Reference/ Appendix/ Common Message Headers
Updated on 2022-09-15 GMT+08:00
View PDF

Common Message Headers

Common request header fields

Table 1 describes common request headers.

Table 1 Common request header fields

Field

Description

Mandatory

Example

Content-Type

Specifies the request body MIME type. This field is mandatory and its default value is application/json. Other values of this field will be provided for specific APIs if any.

Yes

The default value is application/json.

Content-Length

Specifies the length of the request body. The unit is byte.

No

3495

X-Language

Specifies the request language.

No

en_us

X-Project-Id

Specifies a project ID. Obtain the project ID by following the instructions in Project ID and Account ID.

No

e9993fc787d94b6c886cbaa340f9c0f4

X-Auth-Token

Specifies a user token.

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.

The token is the value of X-Subject-Token in the response header.

This field is mandatory for token authentication.

The following is part of an example token:

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

X-Sdk-Date

Time when the request is sent. The time is in YYYYMMDD'T'HHMMSS'Z' format.

The value is the current GMT time of the system.

This field is mandatory for AK/SK-based authentication.

20150907T101459Z

Host

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 hostname[:port]. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.

This field is mandatory for AK/SK-based authentication.

code.test.com

or

code.test.com:443

Authorization

Authentication information.

The value can be obtained from the request signing result.

This field is mandatory for AK/SK-based authentication.

SDK-HMAC-SHA256 Credential=QRUP2R3QFNAOVAWMYHZW/20160202/northchina/test/sdk_request, SignedHeaders=host;x-sdk-date, Signature=9d8b56b055c0e1f7a9498d881a7cb726be91b4f0cde1773b0b1557e987a480ce

workspace

Workspace ID. For details about how to obtain it, see DataArts Studio Instance ID and Workspace ID.
  • You do not need to set this field when calling a CDM API because in that case, only the default workspace can be used.
  • When a DataArts Factory API is called, data in the default workspace is queried by default. To query data in other workspaces, include this header in the query request.
  • This header is mandatory for calling the APIs of other modules. Otherwise, API calls will fail.

d1cd7861478748a6925bc02f47c69279

X-Dlm-Type

DataArts DataService edition, which is Exclusive

This parameter is mandatory for calling DataArts DataService APIs.

EXCLUSIVE: exclusive edition

Common response headers

Table 2 describes common response headers.

Table 2 Common response headers

Parameter

Description

Content-Length

Length of the response body. The unit is byte.

Date

Time when a response is returned

Content-type

Request body MIME type
Parent topic: Appendix