OCL Alpha Quick Reference

NOTE: The Quick Reference is out of date - refer to each resource for up-to-date detailed documentation

Table of Contents

• Users
• Organizations
• Sources
• Source Versions
• Collections
• Collection Versions
• Concepts
• Collection Concept References
• Stars
• Mappings
• Concept Names
• Concept Descriptions

Users

GET /user            # Get currently authenticated user
GET /users/:user     # Get public information about a user
GET /users           # List all users
POST /user           # Update currently authenticated user
POST /users          # Create new user
POST /users/:user    # Update user
DELETE /users/:user  # Deactivate user account

# Get organizations that user is a member of
GET /user/orgs
GET /users/:user/orgs 

Organizations

GET /orgs/:org          # Get organization
GET /orgs               # List all organizations
GET /users/:user/orgs   # List all organizations of which user is a member
GET /user/orgs          # List organizations of which authenticated user is a member
POST /orgs              # Create new organization
POST /orgs/:org         # Update organization

GET /orgs/:org/members  # List members of an organizations
GET /orgs/:org/members/:user # Get organization member status
DELETE /orgs/:org/members/:user # Remove member from organization

DELETE /orgs/:org       # Deactivate organization

Sources

# Get a source
GET /orgs/:org/sources/:source
GET /users/:user/sources/:source
GET /user/sources/:source

# List sources owned by a specific user or organization
GET /orgs/:org/sources
GET /users/:user/sources
GET /user/sources

# List all public sources
GET /sources

# Create source
POST /orgs/:org/sources
POST /users/:user/sources    # superuser only
POST /user/sources

# Edit source
POST /orgs/:org/sources/:source
POST /users/:user/sources/:source    # superuser only
POST /user/sources/:source

# Deactivate source
DELETE /orgs/:org/sources/:source
DELETE /users/:user/sources/:source    # superuser only
DELETE /user/sources/:source

Source Versions

# Get latest released version information of a source
GET /user/sources/:source/latest
GET /users/:user/sources/:source/latest
GET /orgs/:org/sources/:source/latest

# Get specific version information of a source
GET /user/sources/:source/:version
GET /users/:user/sources/:source/:version
GET /orgs/:org/sources/:source/:version

# Get version information of the children of a specific source version
GET /user/sources/:source/:version/children
GET /users/:user/sources/:source/:version/children
GET /orgs/:org/sources/:source/:version/children

# List source versions
GET /user/sources/:source/versions
GET /users/:user/sources/:source/versions
GET /orgs/:org/sources/:source/versions

# Create new version of a source
POST /user/sources/:source/versions
POST /users/:user/sources/:source/versions
POST /orgs/:org/sources/:source/versions

# Edit a version of a source
POST /user/sources/:source/:version
POST /users/:user/sources/:source/:version
POST /orgs/:org/sources/:source/:version

# Deactivate a version of a source
DELETE /user/sources/:source/:version
DELETE /users/:user/sources/:source/:version
DELETE /orgs/:org/sources/:source/:version

Collections

# Get a collection
GET /user/collections/:collection
GET /users/:user/collections/:collection
GET /orgs/:org/collections/:collection

# List collections for a specific user or organization
GET /user/collections
GET /users/:user/collections
GET /orgs/:org/collections

# List all public collections
GET /collections

# Create new collection
POST /user/collections
POST /users/:user/collections   # superuser only
POST /orgs/:org/collections

# Edit collection
POST /user/collections/:collection
POST /users/:user/collections/:collection   # superuser only
POST /orgs/:org/collections/:collection

# Deactivate collection
DELETE /user/collections/:collection
DELETE /users/:user/collections/:collection   # superuser only
DELETE /orgs/:org/collections/:collection

Collection Versions

# Get the information of the latest **released** version of a collection
GET /user/collections/:collection/latest
GET /users/:user/collections/:collection/latest
GET /orgs/:org/collections/:collection/latest

# Get specific version information for a collection
GET /user/collections/:collection/versions/:version
GET /users/:user/collections/:collection/versions/:version
GET /orgs/:org/collections/:collection/versions/:version

# List children of a collection version
GET /user/collections/:collection/versions/:version/children
GET /users/:user/collections/:collection/versions/:version/children
GET /orgs/:org/collections/:collection/versions/:version/children

# List all versions of a collection
GET /user/collections/:collection/versions
GET /users/:user/collections/:collection/versions
GET /orgs/:org/collections/:collection/versions

# Create new version of a collection
POST /user/collections/:collection/versions
POST /users/:user/collections/:collection/versions
POST /orgs/:org/collections/:collection/versions

# Edit a version of a collection
POST /user/collections/:collection/versions/:version
POST /users/:user/collections/:collection/versions/:version
POST /orgs/:org/collections/:collection/versions/:version

# Deactivate a version of a collection
DELETE /user/collections/:collection/versions/:version
DELETE /users/:user/collections/:collection/versions/:version
DELETE /orgs/:org/collections/:collection/versions/:version

Concepts

# Get the latest version of a concept
GET /orgs/:org/sources/:source/concepts/:concept
GET /users/:user/sources/:source/concepts/:concept
GET /user/sources/:source/concepts/:concept

# Get the concept from a specific source version
GET /orgs/:org/sources/:source/:sourceVersion/concepts/:concept
GET /users/:user/sources/:source/:sourceVersion/concepts/:concept
GET /user/sources/:source/:sourceVersion/concepts/:concept

# Get a specific concept version
GET /orgs/:org/sources/:source/concepts/:concept/:conceptVersion
GET /users/:user/sources/:source/concepts/:concept/:conceptVersion
GET /user/sources/:source/concepts/:concept/:conceptVersion

# List concepts for a specific source
GET /orgs/:org/sources/:source/concepts
GET /orgs/:org/sources/:source/:sourceVersion/concepts

# List the latest versions of concepts across public sources
GET /concepts

# List versions of a concept
GET /orgs/:org/source/:source/concepts/:concept/versions

# Create a new concept
POST /orgs/:org/sources/:source/concepts
POST /users/:user/sources/:source/concepts
POST /user/sources/:source/concepts

# Edit a concept
POST /orgs/:org/sources/:source/concepts/:concept
POST /users/:user/sources/:source/concepts/:concept
POST /user/sources/:source/concepts/:concept

# Retire a concept
DELETE /orgs/:org/sources/:source/concepts/:concept
DELETE /users/:user/sources/:source/concepts/:concept
DELETE /user/sources/:source/concepts/:concept

Collection Concept References

# List concepts in a collection
GET /orgs/:org/collections/:collection/concepts
GET /users/:user/collections/:collection/concepts
GET /user/collections/:collection/concepts

# Get concept reference only
GET /orgs/:org/collections/:collection/concepts?reference=true
GET /users/:user/collections/:collection/concepts?reference=true
GET /user/collections/:collection/concepts?reference=true

# List concepts in a specific version of a collection
GET /orgs/:org/collections/:collection/:version/concepts
GET /users/:user/collections/:collection/:version/concepts
GET /user/collections/:collection/:version/concepts

# Get single concept from a collection
GET /orgs/:org/collections/:collection/concepts/:conceptReferenceId
GET /users/:user/collections/:collection/concepts/:conceptReferenceId
GET /user/collections/:collection/concepts/:conceptReferenceId

# Get single concept reference from a collection
GET /orgs/:org/collections/:collection/concepts/:conceptReferenceId?reference=true
GET /users/:user/collections/:collection/concepts/:conceptReferenceId?reference=true
GET /user/collections/:collection/concepts/:conceptReferenceId?reference=true

# Add concept reference to a collection
POST /user/collections/:collection/concepts
POST /users/:user/collections/:collection/concepts
POST /orgs/:org/collections/:collection/concepts

# Remove concept reference from a collection
DELETE /user/collections/:collection/concepts/:conceptReferenceId
DELETE /users/:user/collections/:collection/concepts/:conceptReferenceId
DELETE /orgs/:org/collections/:collection/concepts/:conceptReferenceId

Stars

Mappings

# Get a mapping
GET /user/sources/:source/concepts/:concept/mappings/:mapping
GET /users/:user/:sources/:source/concepts/:concept/mappings/:mapping
GET /orgs/:org/:sources/:source/concepts/:concept/mappings/:mapping

# List mappings for a concept
GET /user/:sources/:source/concepts/:concept/mappings
GET /users/:user/sources/:source/concepts/:concept/mappings
GET /orgs/:org/sources/:source/concepts/:concept/mappings

# List **inverse mappings** for a concept
GET /user/:sources/:source/concepts/:concept/mappings?includeInverseMappings=1
GET /users/:user/sources/:source/concepts/:concept/mappings?includeInverseMappings=1
GET /orgs/:org/sources/:source/concepts/:concept/mappings?includeInverseMappings=1

# List mappings across concepts and sources
GET /mappings

# Create a new mapping
POST /user/sources/:source/concepts/:concept/mappings
POST /users/:user/sources/:source/concepts/:concept/mappings
POST /orgs/:org/sources/:source/concepts/:concept/mappings

# Edit a mapping
POST /user/sources/:source/concepts/:concept/mappings/:mapping
POST /users/:user/sources/:source/concepts/:concept/mappings/:mapping
POST /orgs/:org/sources/:source/concepts/:concept/mappings/:mapping

# Delete a mapping
DELETE /user/sources/:source/concepts/:concept/mappings/:mapping
DELETE /users/:user/sources/:source/concepts/:concept/mappings/:mapping
DELETE /orgs/:org/sources/:source/concepts/:concept/mappings/:mapping

Concept Names

Concept Descriptions