Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Metadata Management APIs/ Adding Metadata
Updated on 2022-08-09 GMT+08:00
View PDF

Adding Metadata

Function

This API is used to add the metadata.

URI

POST /v1.0/{project_id}/graphs/metadatas

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.

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.)
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

metadataPath

Yes

String

Metadata storage address

name

Yes

String

Metadata name, which contains 1 to 64 characters consisting of only letters, digits, and underscores (_)

description

Yes

String

Metadata description

isOverwrite

Yes

Boolean

Whether to overwrite existing files

gesMetadata

Yes

Object

Object for storing metadata message information.

Response Parameters

Status code: 200

Table 4 Response body parameter

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.

id

String

Metadata ID

name

String

Metadata name

Example Request

POST https://Endpoint/v1.0/{project_id}/graphs/metadatas 
{
    "metadataPath": "gesdata/demo_movie/schema.xml",
    "name": "movie_schema",
    "description": "xxxxx",
    "isOverwrite": "true",
    "encryption":{
                   "enable":true,
                   "masterKeyId":"2fc79d04-7010-4f63-9534-d8de74ab67e0"
                  },
    "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": "Name",
                        "cardinality": "single"
                    },
                    {
                        "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"
                    }
                ]
            }
        ]
    }
}

Example Response

Example response with status code 200:

OK

{
  "id" : "ff8080815f9a3c84015f9a438ff70001",
  "name" : "movie_schema"
}

Status code: 500

Internal Server Error

{
  "errorCode" : "GES.2067",
  "errorMessage" : "name: 1 to 64 characters, only letters, digits, and underscores(_) are allowed."
}

Status Code

Status Code

Description

200

OK

500

Internal Server Error
Parent topic: Metadata Management APIs