Importing a Metadata File from OBS (1.0.0)

Function

This API is used to import a metadata file from OBS.

URI

POST /v2/{project_id}/graphs/metadata/upload-from-obs

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
metadata_path	Yes	String	Definition Metadata file storage path. Constraints N/A Range N/A Default Value N/A
name	Yes	String	Definition Metadata file name. Constraints N/A Range N/A Default Value N/A
description	No	String	Definition Metadata file description. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Definition Metadata file ID. Range N/A
name	String	Definition Metadata file name. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

Example Request

Import metadata from OBS. The metadata is stored in devdata/unionsdk/schema.xml and the metadata name is test_schema.

POST https://{Endpoint}/v2/{project_id}/graphs/metadata/upload-from-obs

{
  "metadata_path" : "devdata/unionsdk/schema.xml",
  "name" : "test_schema",
  "description" : "xx"
}

Example Response

Status code: 200

Example response for a successful request

{
  "id" : "d30d2e94-f2ee-4344-af49-eb27fd002eea",
  "name" : "test_schema"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "test_schema The name already exists.",
  "error_code" : "GES.2067"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.