Appendix A. RESTful API Reference

This appendix contains the full list of the publicly available Web scripts that compose the Alfresco RESTful API. The Web scripts are organized by package.

CALENDAR

This section describes the Calendar Web scripts within the /org/alfresco/calendar package.

Retrieve Day Events

The following Web script retrieves day events.

GET /alfresco/service/calendar/RetrieveDayEvents?d={requiredDate}&s={currentSpace}

The Web script description document specifies the following options:

  • user: The authentication access

  • required: The transaction level

  • extension: The format style

  • html: The default response format

Retrieve Event Defaults

The following Web script retrieves event defaults.

GET /alfresco/service/calendar/RetrieveEventDefaults?s={spaceRef}

The Web script description document specifies the following options:

  • user: The authentication access

  • required: The transaction level

  • extension: The format style

  • html: The default format response

Retrieve Event Details

The following Web script retrieves the details of an event.

GET /alfresco/service/calendar/RetrieveEventDetails?e={eventId}

The Web script description document specifies the following options:

  • user: The authentication access

  • required: The transaction level

  • extension: The format style

  • html: The default format response

Retrieve Month Events

The following Web script retrieves monthly events.

GET /alfresco/service/calendar/RetrieveMonthEvents?d={requiredDate}
&s={currentSpace}

The Web script description document specifies the following options: ...

Get Professional Alfresco: Practical Solutions for Enterprise Content Management now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial