Modern Campus Catalog Emblem Modern Campus CMS Emblem Modern Campus Curriculum Emblem Modern Campus Involve Emblem Modern Campus Lifelong Learning Extended Education Emblem Modern Campus Message Emblem Modern Campus Navigate Emblem Modern Campus Schedule Emblem Modern Campus Virtual Tours & Maps Emblem Modern Campus Lifelong Learning Workforce and Community Emblem Site Menu Open Site Menu Close

CMS API Changes for 2024.2

With the release of CMS 2024.2, released on July 18th, 2024, we made significant behind the scenes changes to the CMS. As a result, some APIs had to be fully replaced. We are here to assist you in understanding and adapting to the new APIs.

MessagesLink to this section

These APIs are utilized for interacting with the Inbox of the CMS. The following table will explain the changes in 2024.2. These are breaking changes.

API Changes

Old APINew APINotable Changes

POST
/messages/delete

DELETE
/rs/messages

  • New URI
  • Method is now DELETE
  • Request Parameters are different
  • Added /rs/messages/{message-id} to delete an individual message
N/A

DELETE
/rs/messages/{message-id}

  • New API to delete an individual message

GET
/messages/list

GET
/rs/messages

  • New URI
  • New API is now Back-End paginated
  • Additional parameters for gathering the correct list of messages
  • Folder query string is only INBOX or OUTBOX
  • Response data structure is different

POST
/messages/new

POST
/rs/messages

  • New URI
  • Request body is different structure
    • text changed to context
    • send_email changed to email
  • No longer can create Workflow messages through this endpoint

GET
/messages/view

GET
/rs/messages/{message-id}

  • New URI
  • Message ID is now in the URI instead of query string
  • Account name is not required in the request
  • Response data structure is different

Messages 2024.2 API Documentation

WorkflowLink to this section

These APIs are utilized for interacting with the workflow of the CMS. The following table will explain the changes in 2024.2. These are breaking changes.

Completed workflow requests older than two years will be removed on a weekly basis.

API Changes

Old APINew APINotable Changes

GET
/workflow_archive_request

PUT
/rs/workflow-items/{request-id}/archived

  • New URI
  • Method is now PUT
  • Request ID is now in the URI instead of query string
  • Request body either true or false to change the archive state of the workflow item.
    • This is plain text.
  • Response data structure is different

GET
/workflow/archived

GET
/rs/workflow-items

  • New URI
  • Query string of archived to determine if you want to include archived items
  • Response data structure is different

GET
/workflow/list

GET
/rs/workflow-items

  • New URI
  • Query string of archived to determine if you want to include archived items
  • Response data structure is different

GET
/workflow/messages

GET
/rs/workflow-items/{request-id}/messages

  • New URI
  • Request ID is now in the URI instead of query string
  • Response data structure is different

GET
/workflow/users

GET
/rs/workflow-items/{request-id}/users

  • New URI
  • Request ID is now in the URI instead of query string
  • Response data structure is different

GET
/workflow/view

GET
/rs/workflow-items/{request-id}

  • New URI
  • Request ID is now in the URI instead of query string
  • Response data structure is different
N/A

POST
/rs/workflow-items/{request-id}/messages

  • New API to add a workflow message to a workflow item
  • This API used to use somewhat map to /messages/new, but is now separated
N/A

GET
/rs/workflow-items/{request-id}/messages/{message-id}

  • New API to get an individual workflow item message

Workflow 2024.2 API Documentation

WorkersLink to this section

This API was previously undocumented but it allows users to check on the progress of long-running processes. Long-running processes are site publishes, dependency manager scans, find and replace, and so forth. The previous APIs will still be active after the release of 2024.2 but will be removed in a future release.

Worker processes that have completed will be removed every two hours.

API Changes

Old APINew APINotable Changes

GET
/workers/status

GET
/rs/workers/{worker-id}

  • New URI
  • Must use Worker ID to gather the worker information

N/A

GET
/rs/workers

  • New API for gathering the list of workers.
  • Completed workers will be removed from the list approximately every 2 hours.

Workers 2024.2 API Documentation

By continuing to use this site, you agree to the storing of first- and third-party cookies on your device to enhance site navigation; analyze site, product, and service usage; and assist in our marketing and promotional efforts. Cookie Policy