Performing Custom Operations

Function

This API is used to perform a specified custom operation.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-operation

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.
graph_name	Yes	String	Graph name

Request Parameters

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
api	Yes	String	Available APIs used by the custom operation.
command	Yes	String	Command executed by the custom operation.

Response Parameters

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 code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	json	Execution result of the custom operation. This parameter is left blank when the request fails.

Example Request

Perform a specified custom operation. The API used for the custom operation is gremlin, and the command is {\"command\": \"g.V('1')\"}.

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-operation
{
    "api": "gremlin",
    "command": "{\"command\": \"g.V('1')\"}"
}

Example Response

Status code: 200

Example response (successful request)

{
     "data":{
         "vertices":[
             {
                 "id":"1",
                 "label":"movie",
                 "properties":{
                     "genres":[
                         "Comedy"
                     ],
                     "movieid":[
                         1
                     ],
                     "title":[
                         "Airplane! (1980)"
                     ]
                 }
             }
         ],
         "runtime":0.126476598
     }
 }

Status code: 400

Example response for a failed request

Internal Server Error
{  
     "errorCode":"GES.8814",
     "errorMessage":"Unsupported API."
 }

Status Code

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.

Error Code

See Error Code.

Parent topic: Custom Operations APIs

Предыдущая статья

Custom Operations APIs

Следующая статья

Cypher Queries

Была ли эта статья полезна?

Поддержка Юридические документы