Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Commit bae81f6

Browse files
authored
Merge pull request #72 from SynBioHub/add_SBOLExplorer_API_endpoints
Add sbol explorer api endpoints
2 parents 7b27b6d + 61a9c86 commit bae81f6

File tree

1 file changed

+55
-12
lines changed

1 file changed

+55
-12
lines changed

source/index.html.md

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3572,6 +3572,42 @@ fetch(url, { method: 'GET', headers: headers})
35723572
.then(res => res.buffer()).then(buf => console.log(buf.toString()))
35733573
.catch (error=>console.log(error))
35743574
```
3575+
## View SBOLExplorer Indexing Log
3576+
3577+
`GET <SynBioHub URL>/admin/explorerIndexingLog`
3578+
3579+
View the SBOLExplorer index log.
3580+
3581+
```plaintext
3582+
curl -X GET -H "Accept: text/plain" -H "X-authorization: <token>" <SynBioHub URL>/admin/explorerIndexingLog
3583+
```
3584+
3585+
```python
3586+
import requests
3587+
3588+
response = requests.get(
3589+
'<SynBioHub URL>/admin/explorerIndexingLog',
3590+
headers={
3591+
'Accept': 'text/plain',
3592+
'X-authorization': '<token>'
3593+
},
3594+
)
3595+
3596+
print(response.status_code)
3597+
print(response.content)
3598+
```
3599+
3600+
```javascript
3601+
const fetch = require("node-fetch");
3602+
const url = '<SynBioHub URL>/admin/explorerIndexingLog'
3603+
const headers={
3604+
"Accept" : "text/plain; charset=UTF-8",
3605+
"X-authorization" : "<token>"
3606+
};
3607+
fetch(url, { method: 'GET', headers: headers})
3608+
.then(res => res.buffer()).then(buf => console.log(buf.toString()))
3609+
.catch (error=>console.log(error))
3610+
```
35753611
## View SBOLExplorer Config
35763612

35773613
`GET <SynBioHub URL>/admin/explorer`
@@ -3636,10 +3672,12 @@ response = requests.post(
36363672
'useDistributedSearch': '<useDistributedSearch>'
36373673
'pagerankTolerance': '<pagerangeTolerance>',
36383674
'uclustIdentity': '<uclustIdentity>',
3639-
'synbiohubPublicGraph': '<synbiohubPublicGraph>',
36403675
'elasticsearchEndpont':'<elasticsearchEndpoint>',
36413676
'elasticsearchIndexName':'<elasticSearchIndexName>',
36423677
'spraqlEndpoint':'<sparqlEndpoint>',
3678+
'useCron': '<autoUpdateIndex>',
3679+
'cronDay': '<days>',
3680+
'whichSearch': '<USchecked>' ? 'usearch' : 'vsearch'
36433681
},
36443682
)
36453683

@@ -3656,16 +3694,19 @@ var headers={
36563694
"X-authorization" : "<token>"
36573695
};
36583696

3659-
const params = new URLSearchParams();
3660-
params.append('useSBOLExplorer', '<useSBOLExplorer>');
3661-
params.append('SBOLExplorerEndpoint', '<SBOLExplorerEndpoint>');
3662-
params.append('useDistributedSearch', '<useDistributedSearch>');
3663-
params.append('pagerankTolerance', '<pagerangeTolerance>');
3664-
params.append('uclustIdentity', '<uclustIdentity>');
3665-
params.append('synbiohubPublicGraph', '<synbiohubPublicGraph>');
3666-
params.append('elasticsearchEndpont','<elasticsearchEndpoint>');
3667-
params.append('elasticsearchIndexName','<elasticSearchIndexName>');
3668-
params.append('spraqlEndpoint','<sparqlEndpoint>');
3697+
const params = {
3698+
'useSBOLExplorer': '<useSBOLExplorer>'
3699+
'SBOLExplorerEndpoint': '<SBOLExplorerEndpoint>',
3700+
'useDistributedSearch': '<useDistributedSearch>',
3701+
'pagerankTolerance': '<pagerangeTolerance>',
3702+
'uclustIdentity': '<uclustIdentity>',
3703+
'elasticsearchEndpont': '<elasticsearchEndpoint>',
3704+
'elasticsearchIndexName': '<elasticSearchIndexName>',
3705+
'spraqlEndpoint': '<sparqlEndpoint>',
3706+
'useCron': '<autoUpdateIndex>',
3707+
'cronDay': '<days>',
3708+
'whichSearch': '<USchecked>' ? 'usearch' : 'vsearch'
3709+
}
36693710

36703711
fetch(url, { method: 'POST', headers: headers, body:params})
36713712
.then(res => res.buffer()).then(buf => console.log(buf.toString()))
@@ -3680,10 +3721,12 @@ SBOLExplorerEndpoint | The endpoint where SBOLExplorer can be found
36803721
useDistributedSearch | Boolean indicating whether distributed search should be used
36813722
pagerankTolerance | The Pagerank tolerance factor
36823723
uclustIdentity | The UClust clustering identity
3683-
synbiohubPublicGraph | The SynBioHub public graph for this instance
36843724
elasticsearchEndpoint | The endpoint where Elasticsearch can be found
36853725
elasticsearchIndexName | The Elasticsearch index name
36863726
sparqlEndpoint | The Virtuoso SPARQL endpoint
3727+
useCron | Update the index automatically
3728+
cronDay | How often the index is automatically updated
3729+
whichSearch | Which algorithms to use, 'usearch' or 'vsearch'
36873730

36883731
## Update SBOLExplorer Index
36893732

0 commit comments

Comments
 (0)