Querying Metadata (1.0.2)

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. For details about how to obtain the project ID, 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. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt code. 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 code. 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	Maps of metadata properties. The key-value pairs are those in the imported metadata.

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": "ChineseTitle",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "int",
                        "name": "Year",
                        "cardinality": "single"
                    },
                    {
                        "dataType": "string",
                        "name": "Genres",
                        "cardinality": "set"
                    }
                ]
            },
            {
                "name": "user",
                "properties": [
                    {
                        "dataType": "string",
                        "name": "ChineseTitle",
                        "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	Request sent.
400	Request error.
401	Authentication failed.
403	No operation permission.
404	No resources found.
500	Internal service error.
503	Service unavailable.