Read edge relationships between objects.
Conduit edge.search
edge.search
edge.search
API Method: edge.search
API Method: edge.search
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Summary
- Read edge relationships between objects.
- Returns
- list<dict>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Edge Types
Edge Types
| Constant | Name | Inverse | Description |
|---|---|---|---|
| commit.revision | Commit Has Revision | revision.commit | The source commit is associated with the destination revision. |
| commit.task | Commit Has Task | task.commit | The source commit is associated with the destination task. |
| mention | Mention | mentioned-in | The source object has a comment which mentions the destination object. |
| mentioned-in | Mention In | mention | The source object is mentioned in a comment on the destination object. |
| revision.child | Revision Has Child | revision.parent | The source revision makes changes required by the destination revision. |
| revision.commit | Revision Has Commit | commit.revision | The source revision is associated with the destination commit. |
| revision.parent | Revision Has Parent | revision.child | The source revision depends on changes in the destination revision. |
| revision.task | Revision Has Task | task.revision | The source revision is associated with the destination task. |
| task.commit | Task Has Commit | commit.task | The source task is associated with the destination commit. |
| task.duplicate | Closed as Duplicate | task.merged-in | The source task has been closed as a duplicate of the destination task. |
| task.merged-in | Merged In | task.duplicate | The source task has had the destination task closed as a duplicate and merged into it. |
| task.parent | Parent Task | task.subtask | The source object has the destination object as a parent. |
| task.revision | Task Has Revision | revision.task | The source task is associated with the destination revision. |
| task.subtask | Subtask | task.parent | The source object has the destination object as a subtask. |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://tasks.sustainnaperville.org/ --conduit-token <conduit-token> -- edge.search
$ curl https://tasks.sustainnaperville.org/api/edge.search \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://tasks.sustainnaperville.org/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('edge.search', $api_parameters);
print_r($result);