Skip to main content

APIs

Extend the functionality of Komodo Publications Planning with these REST APIs:

Check Pubs API version

You can check the current active version number of the Pubs API with the Pubs API Version (mvn__PP_Pubs_API_Version__mdt) custom metadata type. As of Komodo Publications Planning's Spring '23 release, there is only one Pubs API version available and therefore only one Pubs API Version metadata record that has already been marked as active. However, in future releases where the Pubs API is updated, there will be multiple metadata records provided for each available version of the Pubs API. You should only modify the existing Pubs API Version metadata records if you decide to revert the Pubs API to a previous version. There are two ways you can revert the Pubs API version in the custom metadata type:

  1. Modify the API versions in the active metadata record:

    1. Navigate to the Pubs API Version metadata record whose Is Active? (mvn__PP_isActive__c) field equals true.

    2. Update the Portal API Version (mvn__PP_Portal_API_Version__c) and/or the Pubs API Version (mvn__PP_Pubs_API_Version__c) fields to the version of the Pubs API you wish to use for the Collaborator Portal and external API clients, respectively.

  2. Deactivate the active metadata record and activate an inactive metadata record:

    1. Navigate to the Pubs API Version metadata record whose Is Active? (mvn__PP_isActive__c) field equals true.

    2. Uncheck the Is Active? field so that it becomes false.

    3. Navigate to the Pubs API Version metadata record that has your desired values in the Portal API Version (mvn__PP_Portal_API_Version__c) and/or the Pubs API Version (mvn__PP_Pubs_API_Version__c) fields based on the version of the Pubs API you wish to use for the Collaborator Portal and external API clients, respectively.

    4. Check the Is Active? field so that it becomes true.