Querying Metadata

Function

This API is used to query the metadata of a graph.

URI

GET /v1.0/{project_id}/graphs/metadatas/{metadata_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
metadata_id	Yes	String	Metadata ID

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
gesMetadata	GesMetaData object	Object for storing metadata message information.

**Table 4** GesMetaData
Parameter	Type	Description
labels	Array of Label objects	Label data structure set

**Table 5** Label
Parameter	Type	Description
name	String	Label name
properties	Object	Property map

Example Request

GET https://Endpoint/v1.0/{project_id}/graphs/metadatas/{metadata_id}

Example Response

Example response with status code 200:

{
    "gesMetadata": {
        "labels": [
            {
                "name": "friends",
                "properties": null
            },
            {
                "name": "movie",
                "properties": [
                    {
                        "dataType": "string",
                        "name": "Title",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "int",
                        "name": "Year",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "string",
                        "name": "Genres",
                        "cardinality": "set"
                    }
                ]
            },
            {
                "name": "user",
                "properties": [
                    {
                        "dataType": "string",
                        "name": "Title",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "int",
                        "name": "Year",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "string",
                        "name": "Genres",
                        "cardinality": "set"
                    }{
                        "typeName1": "F",
                        "typeName2": "M",
                        "typeNameCount": "2",
                        "dataType": "enum",
                        "name": "Gender",
                        "cardinality": "single"
                    },
                    {
                        "typeName1": "Under 18",
                        "typeName2": "18-24",
                        "typeName3": "25-34",
                        "typeName4": "35-44",
                        "typeNameCount": "7",
                        "dataType": "enum",
                        "name": "Age",
                        "typeName5": "45-49",
                        "typeName6": "50-55",
                        "cardinality": "single",
                        "typeName7": "56+"
                    },
                    {
                        "dataType": "string",
                        "name": "Occupation",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "char array",
                        "name": "Zip-code",
                        "maxDataSize": "12",
                        "cardinality": "single"
                    }
                ]
            },
            {
                "name": "rate",
                "properties": [
                    {
                        "dataType": "int",
                        "name": "Score",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "date",
                        "name": "Datetime",
                        "cardinality": "single"
                    }
                ]
            }
        ]
    }
}

Status code: 500

Internal Server Error

{
  "errorCode" : "GES.7006",
  "errorMessage" : "The underlying graph engine has internal error."
}

Status Code

Status Code	Description
200	OK
500	Internal Server Error

Parent topic: Metadata Management APIs

Previous topic: Querying the Metadata List

Next topic: Adding Metadata

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot