Function

This API is used to add the metadata.

URI

• URI format

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

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  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	No	String	Metadata description
  isOverwrite	Yes	Boolean	Whether to overwrite existing files
  gesMetadata	Yes	GesMetaData	Object of the message that stores the metadata

Request

• Request example

  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": "ChineseTitle",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "int",
                          "name": "Year",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "string",
                          "name": "Genres",
                          "cardinality": "set"
                      }
                  ]
              },
              {
                  "name": "user",
                  "properties": [
                      {
                          "dataType": "string",
                          "name": "ChineseName",
                          "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"
                      }
                  ]
              }
          ]
      }
  }

Response

• Parameter description

  Table 2 Parameter description

  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.
  metadata_id	String	Metadata ID
  name	String	Metadata name

• Response example (successful request)

  Http Status Code: 200
    {
     "id" : "ff8080815f9a3c84015f9a438ff70001",
     "name" : "movie_schema"
    }

• Response example (failed request)

  Http Status: 500
     {
       "errorCode": "GES.7010",
       "errorMessage": "Failed to verify the schema and data files."
     }

Return Value

• Normal

  200

• Abnormal

  Table 3 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.