Updated on 2023-08-04 GMT+08:00

Shortest Path of Vertex Sets (2.1.5)

Table 1 parameters parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

sources

Yes

Source vertex ID set

String

The value is in the standard CSV format. IDs are separated by commas (,), for example, Alice, Nana.

The maximum ID number is 100000.

-

targets

Yes

Target vertex ID set

String

The value is in the standard CSV format. IDs are separated by commas (,), for example, Alice, Nana.

The maximum ID number is 100000.

-

directed

No

Whether an edge is directed

Boolean

true or false

false

timeWindow

No

Time window used for time filtering

Object

For details, see Table 2.

-

Table 2 timeWindow parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

filterName

No

Name of the time property used for time filtering

String

Character string: The property on the corresponding vertex/edge is used as the time.

-

filterType

No

Filtering by vertex or edge

String

V: filtering by vertex

E: filtering by edge

BOTH: filtering by vertex and edge

BOTH

startTime

No

Start time

String

Date character string or timestamp

-

endTime

No

End time

String

Date character string or timestamp

-

Table 3 response_data parameter description

Parameter

Type

Description

path

List

Shortest path. The format is as follows:

[vertexId,...]

where

vertexId is of the string type.

source

String

Source vertex ID

target

String

Target vertex ID