Part of Content release process
Appendix D - Ontoserver’s documentation
/synd/fetchSyndicatedContentEntry
https://ontoserver.csiro.au/docs/6/api-swagger.html#Syndication
Post
Fetch an artifact from the upstream syndication feed into the server. For entries of type Bundle: only 'batch' and 'collection' are supported. Future versions may support 'transaction', and unsupported contained Resource types will be ignored.
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entryId | query | no | The atom entry ID to fetch | string | |
| resourceType | query | no | The type of resource to fetch | string | |
| url | query | no | The URL of the resource (CodeSystem, ValueSet, ConceptMap or StructureDefinition) to fetch | string | |
| version | query | no | The version of the resource to fetch | string | |
| bundleInterpretation | query | no | If the entry is a Bundle, how to process the Bundle. Valid values are: 'batch' and 'collection' | string |
Response
| Status code | Reason | Response model |
|---|---|---|
| 200 | successful operation |
/synd/getBinaryIndexZip
https://ontoserver.csiro.au/docs/6/api-swagger.html#getBinaryIndexZip
GET
Retrieve the binary index for a code system from the server (if available)
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| codeSystemId | query | yes | A code system identifier, e.g. http://snomed.info/sct | string | |
| codeSystemVersion | query | yes | The version of the specified code system | string | |
| indexVersion | query | yes | The internal version of the binary index format | string |
Response
Content-Type: application/zip
| Status code | Reason | Response model |
|---|---|---|
| 200 | successful operation | InputStreamResource |
/synd/redoPreload
https://ontoserver.csiro.au/docs/6/api-swagger.html#redoPreload
POST
Re-executes the data load performed at start in the preload feed without having to restart the server.<p>Execution will be asynchronous or synchronous depending upon the configuration of atom.preload.async, which is true by default.
Request
Parameters
Response
| Status code | Reason | Response model |
|---|---|---|
| 200 | Preload execution has been started | |
| 500 | Preload could not be re-executed |
Last edited: 3 March 2021 1:52 pm