Help Center> Graph Engine Service> API Reference> Service Plane APIs> Algorithm APIs> Algorithm API Parameter References> Shortest Path (2.1.5)
View PDF

Shortest Path (2.1.5)

Table 1 parameters parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

source

Yes

Source vertex ID of a path

String

-

-

target

Yes

Target vertex ID of a path

String

-

-

weight

No

Weight of an edge

String

Empty or character string

  • Empty: The default weight and distance of edges are 1.
  • Character string: The property of the corresponding edge is the weight. If the edge does not have a property, the weight is 1 by default.
    NOTE:

    The weight of an edge must be greater than 0.

-

directed

No

Whether to consider the edge direction

Boolean

true or false

false

timeWindow

No

Time window used for time filtering

Json

For details, see Table 2.

NOTE:

timeWindow does not support the shortest path with weight. That is, parameters timeWindow and weight cannot be both specified.

-
Table 2 timeWindow parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

filterName

Yes

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