Ontoserver Management API

Admin

/api/addBundle

Request

Parameters
Name Located in Required Description Default Schema
file query yes A FHIR Bundle object containing a set of resources - ref

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation

/api/auditReports

Request

Parameters

Response

**Content-Type: ** application/json, application/fhir+json

Status Code Reason Response Model
200 successful operation

/api/availableCodeSystemIndexes

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[AtomArtifact]

/api/availableCodeSystemSources

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[AtomArtifact]

/api/deleteCodeSystem

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

Response

Status Code Reason Response Model

| default | successful operation | - |

/api/indexCodeSystem

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
validate query yes Indicates whether the server should validate the index if it already exists - boolean

Response

Status Code Reason Response Model
200 successful operation

/api/indexedCodeSystems

Request

Parameters

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation Array[CodeSystem]

/api/sct/addRf2

Request

Parameters
Name Located in Required Description Default Schema
file query yes The ZIP file containing RF2 packaged according to IHTSDO conventions - ref
type query yes The release type. One of SCT_RF2_FULL, SCT_RF2_ALL, or SCT_RF2_SNAPSHOT. - string

Response

**Content-Type: ** application/json

Status Code Reason Response Model
200 successful operation

Syndication

/synd/fetchSyndicatedContentEntry

Request

Parameters
Name Located in Required Description Default Schema
entryId query yes The atom entry ID to fetch - string

Response

Status Code Reason Response Model

| default | successful operation | - |

/synd/getBinaryIndexZip

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 Array[]

/synd/setIndexSyndicationStatus

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
syndicate query yes Whether to publish a binary index for the code system - boolean

Response

Status Code Reason Response Model

| default | successful operation | - |

/synd/syndication.xml

Request

Parameters

Response

Status Code Reason Response Model
200 successful operation