Back to top

Activities 

Activities 

Get global activities
/activities
    Returns all post activities generated in the system by anyone.
    Get global activities
    /activities
        Returns all post activities generated in the system by anyone.
    

      Activity 

      Delete an activity
      /activities/{activity}
           :rest activity The id of the activity
      
        Get an activity
        /activities/{activity}
             :rest activity The id of the activity
        

          Context activities 

          Add a context activity
          /contexts/{hash}/activities
               If an actor is found on the request body it will be taken as the ownership of the activity, either
               the actor being a Person or a Context. If no actor specified on json payload, the current authenticated
               user will be taken as request.actor.
          
            Get context activities
            /contexts/{hash}/activities
                Returns all the activities posted on a context
            
                 :rest hash The hash of the context url where the activties where posted
            
              Get context activities
              /contexts/{hash}/activities
                  Returns all the activities posted on a context
              
                   :rest hash The hash of the context url where the activties where posted
              

                Context authors 

                Get context authors
                /contexts/{hash}/activities/authors

                  File 

                  Get an activity file
                  /activities/{activity}/file/download
                      :rest activity The id of the activity
                  

                    Image 

                    Get an activity image
                    /activities/{activity}/image
                        :rest activity The id of the activity
                        :rest size The named size of the activity, defaults to large
                    

                      Named size Image 

                      Get an activity image
                      /activities/{activity}/image/{size}
                          :rest activity The id of the activity
                          :rest size The named size of the activity, defaults to large
                      

                        User Timeline 

                        Get user timeline
                        /people/{username}/timeline

                          User Timeline authors 

                          Get timeline authors
                          /people/{username}/timeline/authors

                            User activities 

                            Add a timeline activity
                            /people/{username}/activities
                                 Add activity posted as {username}. User in url will be taken as the actor that will own
                                 the activity. When url {username} and authenticated user don't match, user must have special
                                 permissions to be able to impersoate the activity.
                            
                              Get user activities
                              /people/{username}/activities
                                  Returns all post activities generated by a user in his timeline or contexts.
                              
                                Get user activities
                                /people/{username}/activities
                                    Returns all post activities generated by a user in his timeline or contexts.
                                

                                  favorite 

                                  Unfavorite activity
                                  /activities/{activity}/favorites/{username}

                                    favorites 

                                    Favorite activity
                                    /activities/{activity}/favorites

                                      flag 

                                      Flag an activity
                                      /activities/{activity}/flag
                                        Unflag an activity
                                        /activities/{activity}/flag

                                          like 

                                          Unlike activity
                                          /activities/{activity}/likes/{username}

                                            likes 

                                            Like activity
                                            /activities/{activity}/likes

                                              Comments 

                                              Activity comment 

                                              Delete an activity
                                              /activities/{activity}/comments/{comment}

                                                Activity comments 

                                                Add a comment to an activity
                                                /activities/{activity}/comments
                                                  Get activity comments
                                                  /activities/{activity}/comments
                                                      Return the comments for an activity.
                                                  

                                                  Comments (Global) [/activities/comments]

                                                    Get global comments
                                                    /activities/{activity}/comments
                                                      Get global comments
                                                      /activities/{activity}/comments

                                                        Context comments 

                                                        Get context activities comments
                                                        /contexts/{hash}/comments
                                                          Get context activities comments
                                                          /contexts/{hash}/comments

                                                            User comments 

                                                            Get user comments
                                                            /people/{username}/comments
                                                                Get all the comments generated by a user anywhere
                                                            
                                                              Get user comments
                                                              /people/{username}/comments
                                                                  Get all the comments generated by a user anywhere
                                                              

                                                                Contexts 

                                                                Context 

                                                                Modify a context
                                                                /contexts/{hash}
                                                                  Delete a context
                                                                  /contexts/{hash}
                                                                    Get a context
                                                                    /contexts/{hash}

                                                                      Context avatar 

                                                                      Get context avatar
                                                                      /contexts/{hash}/avatar
                                                                          To the date, this is only implemented to
                                                                          work integrated with Twitter.
                                                                      

                                                                        Context permission 

                                                                        Grant user permission on context
                                                                        /contexts/{hash}/permissions/{username}/{permission}
                                                                          Revoke user permission on context
                                                                          /contexts/{hash}/permissions/{username}/{permission}

                                                                            Context permissions defaults 

                                                                            Reset user permissions on context
                                                                            /contexts/{hash}/permissions/{username}/defaults

                                                                              Context tag 

                                                                              Delete context tags
                                                                              /contexts/{hash}/tags/{tag}

                                                                                Context tags 

                                                                                Add context tags
                                                                                /contexts/{hash}/tags
                                                                                  Delete all context tags
                                                                                  /contexts/{hash}/tags
                                                                                    Get context tags
                                                                                    /contexts/{hash}/tags

                                                                                      Contexts 

                                                                                      Adds a context
                                                                                      /contexts
                                                                                        Get all contexts
                                                                                        /contexts

                                                                                          Public contexts 

                                                                                          Get all public contexts
                                                                                          /contexts/public
                                                                                              Returns a list of all public subscribable contexts
                                                                                          

                                                                                            User subscription 

                                                                                            Unsubscribe user from context
                                                                                            /contexts/{hash}/subscriptions/{username}

                                                                                              Users subscribed to context 

                                                                                              Subscribe user to context
                                                                                              /contexts/{hash}/subscriptions
                                                                                                Get all context subscriptions
                                                                                                /contexts/{hash}/subscriptions

                                                                                                  Conversations 

                                                                                                  Conversation 

                                                                                                  Modify a conversation
                                                                                                  /conversations/{id}
                                                                                                    Delete a conversation
                                                                                                    /conversations/{id}
                                                                                                      Get a conversation
                                                                                                      /conversations/{id}

                                                                                                        Conversation avatar 

                                                                                                        Get conversation avatar
                                                                                                        /conversations/{id}/avatar
                                                                                                            Returns conversation avatar. Public endpoint.
                                                                                                        

                                                                                                          Conversation mesages 

                                                                                                          Adds a message to a conversation
                                                                                                          /conversations/{id}/messages
                                                                                                              The request.actor is the one "talking", either if it was the authenticated user,
                                                                                                              the rest username or the post body actor, in this order.
                                                                                                          
                                                                                                            Get all messages from a conversation
                                                                                                            /conversations/{id}/messages

                                                                                                              Conversation owner 

                                                                                                              Transfer conversation ownership
                                                                                                              /conversations/{id}/owner

                                                                                                                Conversation participant 

                                                                                                                Leave conversation
                                                                                                                /conversations/{id}/participants/{username}

                                                                                                                  Conversation participants 

                                                                                                                  Join conversation
                                                                                                                  /conversations/{id}/participants

                                                                                                                    Conversations 

                                                                                                                    Add a new conversation
                                                                                                                    /conversations
                                                                                                                      Delete all conversations
                                                                                                                      /conversations
                                                                                                                          Deletes ALL the conversations from ALL users in max doing all the consequent unsubscriptions
                                                                                                                      
                                                                                                                        Get user conversations
                                                                                                                        /conversations

                                                                                                                          User conversation 

                                                                                                                          Get a user conversation subscription
                                                                                                                          /people/{username}/conversations/{id}

                                                                                                                            User conversation messages 

                                                                                                                            Adds a message to a conversation
                                                                                                                            /people/{username}/conversations/{id}/messages
                                                                                                                                The request.actor is the one "talking", either if it was the authenticated user,
                                                                                                                                the rest username or the post body actor, in this order.
                                                                                                                            

                                                                                                                              Management 

                                                                                                                              Conversations maintenance 

                                                                                                                              Rebuild conversation subscriptions
                                                                                                                              /admin/maintenance/conversations
                                                                                                                                  Performs sanity checks on existing subscriptions
                                                                                                                              

                                                                                                                                Dates maintenance 

                                                                                                                                Rebuild dates of activities
                                                                                                                                /admin/maintenance/dates
                                                                                                                                    Now currently sets the lastComment id field
                                                                                                                                

                                                                                                                                  Error Exception 

                                                                                                                                  Get an exception
                                                                                                                                  /admin/maintenance/exceptions/{hash}

                                                                                                                                    Error Exception list 

                                                                                                                                    Get all exceptions
                                                                                                                                    /admin/maintenance/exceptions

                                                                                                                                      Keywords maintenance 

                                                                                                                                      Rebuild keywords of all activities
                                                                                                                                      /admin/maintenance/keywords

                                                                                                                                        Security settings 

                                                                                                                                        Get security settings
                                                                                                                                        /admin/security
                                                                                                                                            Expose the current MAX security roles and its members
                                                                                                                                        

                                                                                                                                          Subscriptions maintenance 

                                                                                                                                          Rebuild context subscriptions
                                                                                                                                          /admin/maintenance/subscriptions
                                                                                                                                              Performs sanity checks on existing subscriptions
                                                                                                                                          

                                                                                                                                            User role 

                                                                                                                                            Grants a role to a user
                                                                                                                                            /admin/security/roles/{role}/users/{user}
                                                                                                                                              Check if user has a role
                                                                                                                                              /admin/security/roles/{role}/users/{user}
                                                                                                                                                Removes a role from a user
                                                                                                                                                /admin/security/roles/{role}/users/{user}

                                                                                                                                                  Users Maintenance 

                                                                                                                                                  Rebuild users
                                                                                                                                                  /admin/maintenance/users
                                                                                                                                                      Sets sensible defaults and perform consistency checks.
                                                                                                                                                      Checks that owner of the object must be the same as the user object
                                                                                                                                                  

                                                                                                                                                    Users with security 

                                                                                                                                                    Get users roles
                                                                                                                                                    /admin/security/users

                                                                                                                                                      Messages 

                                                                                                                                                      File 

                                                                                                                                                      Get a message file
                                                                                                                                                      /messages/{id}/file/download

                                                                                                                                                        Image 

                                                                                                                                                        Get a message image
                                                                                                                                                        /messages/{id}/image

                                                                                                                                                          Named size Image 

                                                                                                                                                          Get a message image
                                                                                                                                                          /messages/{id}/image/{size}

                                                                                                                                                            Subscriptions 

                                                                                                                                                            User subscriptions 

                                                                                                                                                            Get all user subscriptions
                                                                                                                                                            /people/{username}/subscriptions

                                                                                                                                                              Tokens 

                                                                                                                                                              Context tokens 

                                                                                                                                                              Return context tokens
                                                                                                                                                              /contexts/{hash}/tokens

                                                                                                                                                                Conversation tokens 

                                                                                                                                                                Return conversation tokens
                                                                                                                                                                /conversations/{id}/tokens

                                                                                                                                                                  Device token 

                                                                                                                                                                  Delete user device token
                                                                                                                                                                  /tokens/{token}

                                                                                                                                                                    Device tokens 

                                                                                                                                                                    Adds a user device token
                                                                                                                                                                    /tokens
                                                                                                                                                                        Adds a new user device linked to a user. If the token already exists for any user, we'll assume that the new
                                                                                                                                                                        user is using the old user's device, so we'll delete all the previous tokens and replace them with the new one.
                                                                                                                                                                    

                                                                                                                                                                      User device tokens 

                                                                                                                                                                      Delete all user device tokens
                                                                                                                                                                      /people/{username}/tokens
                                                                                                                                                                        Delete all platform tokens
                                                                                                                                                                        /people/{username}/tokens

                                                                                                                                                                          User device tokens by platform 

                                                                                                                                                                          Delete all user device tokens for platform
                                                                                                                                                                          /people/{username}/tokens/platforms/{platform}
                                                                                                                                                                            Get all user tokens for platform
                                                                                                                                                                            /people/{username}/tokens/platforms/{platform}

                                                                                                                                                                              User 

                                                                                                                                                                              User 

                                                                                                                                                                              Modify a user
                                                                                                                                                                              /people/{username}
                                                                                                                                                                                Delete a user
                                                                                                                                                                                /people/{username}
                                                                                                                                                                                  Get a user
                                                                                                                                                                                  /people/{username}

                                                                                                                                                                                    User avatar 

                                                                                                                                                                                    Upload user avatar
                                                                                                                                                                                    /people/{username}/avatar
                                                                                                                                                                                      Get user avatar
                                                                                                                                                                                      /people/{username}/avatar

                                                                                                                                                                                        User avatar sizes 

                                                                                                                                                                                        Get user avatar
                                                                                                                                                                                        /people/{username}/avatar/{size}

                                                                                                                                                                                          Users 

                                                                                                                                                                                          Add a user
                                                                                                                                                                                          /people
                                                                                                                                                                                            Search users
                                                                                                                                                                                            /people
                                                                                                                                                                                                Return the result of a query specified by the username param as
                                                                                                                                                                                                a list of usernames. For UI use only.
                                                                                                                                                                                            

                                                                                                                                                                                              Generated by aglio on 03 Apr 2015