API Reference

This section explains how to interact with OCL using REST APIs. Please refer to the swagger documentation for more in depth understanding of how to interact with each individual REST API call.

• Bulk Import API
  • Overview
  • Bulk Import File Formats
  • Required and Optional CSV Bulk Import Fields
  • OCL Bulk Import API Reference
  • Bulk Import examples using curl
  • Bulk Import via the OCL TermBrowser
• Concepts
  • Overview
  • Get a single concept from a source
  • List concepts in a source
  • List concepts across public sources
  • Create new concept
  • Edit concept
  • Retire concept
  • List versions of a concept
  • Get a single concept name
  • List concept names
  • Create new concept name
  • Edit concept name
  • Delete concept name
  • Get a single concept description
  • List concept descriptions
  • Create new concept description
  • Edit concept description
  • Delete concept description
  • Get a single extra
  • List all extras
  • Create or Update an extra
  • Delete an extra
  • Search and Filter Behavior
  • Issues
• Collections
  • Overview
  • Get a single collection
  • List all collections for a specific user or organization
  • List all collections for all of a user’s organizations
  • List all public collections
  • Create collection
  • Edit collection
  • Deactivate a collection
  • Get single version of a collection
  • List all versions of a collection
  • Create new version of a collection
  • Edit a collection version
  • Deactivate a collection version
  • Retrieve and clear processing flag on a collection version
  • List all references in a collection
  • Add a reference to a collection
  • Delete a reference from a collection
  • Get single concept from a collection
  • List concepts referenced in a collection
  • Concept subresource Requests
  • Get a single mapping from a collection
  • List mappings for a single concept that are contained in the collection
  • List mappings in a collection
  • Search and Filter Behavior
  • Older material - keeping here to integrate into the updated documentation
• Custom (Extra) Attributes
  • Introduction
  • Interacting with Custom Attributes using the OCL API
  • Filtering using Custom Attribute
  • Creating and Formatting Custom Attributes in TermBrowser
  • Creating and Formatting Custom Attributes using CSV Import or ocldev tools
• Collection Expansions
  • Overview
  • Generate an expansion for a collection version
  • Get a list of expansions for a collection version
  • Get an expansion for a collection version
  • Delete an expansion for a collection version
• Export API
  • Overview
  • Get an export of a repository version
  • Create an export of a repository version
  • Delete an export file
  • Full Example
• Mappings
  • Overview
  • Get a single mapping
  • List mappings for a concept within a single source
  • List all mappings within a specific source
  • List mappings across public sources
  • Create a new mapping
  • Edit a mapping
  • Retire mapping
  • Search and Filter Behavior
  • Issues and Potential Future Features
• Orgs
  • Overview
  • Get a single organization
  • List organizations
  • Create new organization
  • Update organization
  • Deactivate an organization
  • Delete an organization
  • List members of an organization
  • Get organization member status
  • Add new member to organization
  • Remove member from organization
  • Search and Filter Behavior
• Operation: $cascade
  • Overview
  • Get a list of resources that are associated with a concept within a specific source or collection version
• Operation: $clone
  • Overview
  • Clone a Concept and its associated resources
  • Example request and response
• Operation: $resolveReference
  • Overview
  • Reference syntax
  • $resolveReference Parameters
• Permissions Summary
  • Syntax
  • Notes
  • Permissions
• Repositories
  • Overview
  • List all repositories globally or for a specific user or organization
• Sources
  • Overview
  • Get a single source
  • List all sources for specific user or organization
  • List all sources for all of a user’s organizations
  • List all public sources
  • Create source
  • Edit source
  • Deactivate a source
  • Get single version of a source
  • List children of a source version – DEPRECATED
  • List all versions of a source
  • Create new version of a source
  • Edit a source version
  • Deactivate a source version
  • Retrieve and clear processing flag on a source version
  • Search and Filter Behavior
• Canonical URL Registries
  • Overview
  • Attributes for an entry in the canonical URL registry
  • Get/search list of URL registry entries, with paging
  • Get registry entry
  • Create a new URL registry entry
  • Update a URL registry entry
  • Delete a URL registry entry
  • Operation: $lookup
  • Future Requirements
• Users
  • Overview
  • Get a single user
  • Get the authenticated user
  • Partial update of a user
  • List all users
  • Create new user
  • List organizations that user is a member of
  • Deactivate a user account
  • Reactivate a deactivated user account
  • Retrieve auth token
  • Proposed Search and Filter Behavior
  • Issues
• Other
  • Formatted CSV Responses
  • Subscriptions
  • Validation Schemas