Reference 360 > Reference 360 REST API > REST API versions
  

REST API versions

You can use different versions of REST APIs to perform tasks.
The following table describes REST APIs, their versions, and the functionalities provided by each version:
REST API
version
Description
configuration
version 1
Configures the Reference 360 organization with settings, such as the approval mode configuration, approval implementation mode, and the rule validation mode.
For more information about the configuration REST API, see configuration.
model
version 3
Exports or imports reference data sets, including their code lists and crosswalks, and hierarchies.
For more information about the model version 3 REST API, see model version 3.
import
version 1
Imports code values, value mappings, and hierarchy relationships, and retrieves the status of an import job and the detailed report for a failed import job based on asset IDs.
For more information about the import version 1 REST API, see import version 1.
import
version 2
Imports code values, value mappings, and hierarchy relationships with additional optional fields based on asset IDs.
For more information about the import version 2 REST API, see import version 2.
import
version 3
Imports code values, value mappings, and hierarchy relationships with additional optional fields based on internal IDs or aliases of assets.
For more information about the import version 3 REST API, see import version 3.
export
version 1
Exports code values from a code list and value mappings from a crosswalk to JSON and CSV formats based on asset IDs.
For more information about the export version 1 REST API, see export version 1.
export
version 2
Exports code values from a code list, value mappings from a crosswalk, and relationships within a hierarchy to JSON and CSV formats based on asset IDs.
For more information about the export version 2 REST API, see export version 2.
export
version 3
Use the REST API to perform the following actions based on asset IDs:
  • - Export code values from a code list and value mappings from a crosswalk to JSON and CSV formats.
  • - Export code values from a code list and value mappings from a crosswalk that were available at a specific point in time to JSON and CSV formats
For more information about the export version 3 REST API, see export version 3.
export
version 4
Use the REST API to perform the following actions based on the internal IDs or aliases of assets:
  • - Export code values from a code list and value mappings from a crosswalk to JSON and CSV formats.
  • - Export code values from a code list and value mappings from a crosswalk that were available at a specific point in time to JSON and CSV formats
For more information about the export version 4 REST API, see export version 4.
audit trail
version 1
Retrieves the history of the specified assets based on asset IDs.
For more information about the audit trail version 1 REST API, see audit trail version 1.
audit trail
version 2
Retrieves the history of the specified assets based on internal IDs or aliases of assets.
For more information about the audit trail version 2 REST API, see audit trail version 2.
rds
version 1
Retrieves the details for a reference data set, and code lists of a reference data set based on the asset ID of the reference data set.
For more information about the rds version 1 REST API, see rds version 1.
rds
version 2
Retrieves the details for a reference data set, and code lists of a reference data set based on the internal ID or alias of the reference data set.
For more information about the rds version 2 REST API, see rds version 2.
codelists
version 1
Use the REST API to perform the following actions based on the asset ID:
  • - Retrieve details of code lists and code values.
  • - Create, update, delete, search, and export code values directly without creating draft changes or sending changes for approval.
  • - Move code values within hierarchical code lists without locking the code list.
  • - Retrieve change events, crosswalks, and relationships for specified time ranges.
For more information about the codelists version 1 REST API, see codelists version 1.
codelists
version 2
Use the REST API to perform the following actions based on the internal ID or alias of the code list:
  • - Retrieve and manage code lists and code values.
  • - Create, update, delete, search, and export code values directly without creating draft changes or sending changes for approval.
  • - Move code values within hierarchical code lists without locking the code list.
  • - Retrieve change events, crosswalks, and summary information associated with a code list.
You can also unlock code lists locked by other users based on the asset ID.
For more information about the codelists version 2 REST API, see codelists version 2.
codelists
version 3
Unlocks a code list that's locked by another user based on the internal ID or alias of the code list.
For more information about the codelists version 3 REST API, see codelists version 3.
crosswalks
version 1
Use the REST API to perform the following actions based on the asset ID:
  • - Retrieve crosswalk details, value mappings, and change events for a specific time range.
  • - Unlock crosswalks that other users have locked.
  • - Run crosswalk cleanser jobs to remove duplicate mappings and retrieve job details.
For more information about the crosswalks version 1 REST API, see crosswalks version 1.
crosswalks
version 2
Use the REST API to perform the following actions based on the internal ID or alias of the crosswalk:
  • - Retrieve crosswalk details, value mappings, and change events for a specific time range.
  • - Unlock crosswalks that other users have locked.
  • - Run crosswalk cleanser jobs to remove duplicate mappings and retrieve job details.
  • - Delete value mappings by source and target code values.
For more information about the crosswalks version 2 REST API, see crosswalks version 2.
crosswalks
version 3
Use the REST API to perform the following actions based on the internal ID or alias of the crosswalk:
  • - Retrieve crosswalk details, value mappings, and change events for a specific time range.
  • - Delete value mappings by mapped source and target code values.
For more information about the crosswalks version 3 REST API, see crosswalk version 3.
hierarchies
version 1
Retrieves hierarchies, hierarchy details, and hierarchy model relationships based on the asset ID of the hierarchy.
For more information about the hierarchies version 1 REST API, see hierarchies version 1.
hierarchies
version 2
Retrieves a list of hierarchies, hierarchy details, and hierarchy model relationships based on the internal ID or alias of the hierarchy.
For more information about the hierarchies version 2 REST API, see hierarchies version 2.