REST API - saveCalendarReferences Add References

The table summarizes the REST API - saveCalendarReferences: Add References.

Request

Format POST <baseurl>/calendar/<name>/<version>/references
Path parameters
  • name: Name of the calendar to which the entry is being added.
  • version: Version number of the calendar; used to detect concurrent updates to the same calendar.
Query parameters
  • namespace=string (optional): The combination of namespace and name uniquely identifies a calendar. Note that the default SYSTEM calendar has no namespace.
  • ref=string (1..n): the calendar references to be associated with the specified calendar, one reference per repetition of the parameter. Can be obtained from getOrgModel.

Response

JSON Returns a JSON representation of the content of a saveCalendarReferencesResponse element.
XML Returns the content of a saveCalendarReferencesResponse element (from the WorkCalService schema).

Example

Request
POST <baseurl>/calendar/LONDON01/9/references?namespace=LONDON&ref=4F103A69-430B-49DE-8828-9889ACBBBB61
Response
   {
       "updated-calendar":
       {
           "@version": "10",
           "@namespace": "LONDON",
           "@name": "LONDON01"
       }
    }