Start Traversal Run
Requests a Traversal run using the named job’s current job config and TraversalConfig, reusing an active run instead of starting a duplicate. Use the returned run number for later inspection
Endpoint
POST /api/v3/jobs/{jobName}/traversal/start
Path Parameters
| Name | Type | Description |
|---|---|---|
| jobName | string | Required. Unique job name within the tenant. Reuse the same value to manage job config, start crawls, fetch URLs, inspect tasks and Traversal runs, and query indexed data |
Responses
200 (Ok)
Returns TraversalRunResult as a TraversalRunResult.
400 (Bad Request)
Invalid request parameters. Refer to the response text for more information
403 (Forbidden)
Access restricted. Refer to the response text for more information
Data Contracts
TraversalRunResult
Result returned when starting or attaching to a Traversal run
Fields:
| Name | Type | Description |
|---|---|---|
| RunNum | long | Traversal run number |
| IsNew | bool | True when a new run was started; false when an existing in-progress run was returned |