Web Service: TuleapSubversionAPI

Port type TuleapSubversionAPIPortTypeSource code

1. getSvnLog
   Source code
   Description:
   Retrieves the SVN revisions of the project visible by the requesting user.
   
   Returned format:
   
array(
array(
"revision" => Revision number,
"author" => User id,
"date" => timestamp,
"message" => commit message,
)
)

   
   Example:
   
array(
array(
"revision" => 12214,
"author" => 123,
"date" => 1337788549,
"message" => "Fix bug #456",
)
array(
"revision" => 12213,
"author" => 123,
"date" => 1337788530,
"message" => "Fix bug #789",
)
)

   
   
   Error codes:
   * 3001, Invalid session (wrong $sessionKey)
   * 3002, User do not have access to the project
   * 3005, Invalid user id
   
   @param String $sessionKey Session key of the requesting user
   @param Integer $group_id ID of the project the subversion repository belongs to
   @param Integer $limit Maximum revisions returned
   @param Integer $author_id Id of commit author
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/soap/svn#getSvnLog
   Input:
   getSvnLogRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   limit type int
   author_id type int
   Output:
   getSvnLogResponse (soap:body, use = encoded)Source code
   getSvnLog type ArrayOfRevision - array of type Revision

   • revision type string
   • author type string
   • date type string
   • message type string
2. getSvnPath
   Source code
   Description:
   Returns the content of a directory in Subversion according to user permissions
   
   

   
   
   • If user cannot see the content it gets an empty array.
   
   
   • The returned content is relative (/project/tags) gives array("1.0", "2.0").
   
   

   
   
   Error codes:
   * 3001, Invalid session (wrong $sessionKey)
   * 3002, User do not have access to the project
   
   @param String $sessionKey Session key of the desired project admin
   @param Integer $group_id ID of the project the subversion repository belongs to
   @param String $path Path to the directory to list (eg. '/tags')
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/soap/svn#getSvnPath
   Input:
   getSvnPathRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   path type string
   Output:
   getSvnPathResponse (soap:body, use = encoded)Source code
   getSvnPath type ArrayOfstring - array of type string
3. getSvnPathsWithLogDetails
   Source code
   Description:
   Returns the detailed content of a directory in Subversion according to user permissions
   
   

   
   
   • If user cannot see the content it gets an empty array.
   
   
   • The returned content is relative (/project/tags) gives
     array(
     0 => array(
     'path' => '/tags',
     'author => 169,
     'timestamp' => 1545265465,
     'message' => 'some commit message'),
     1 => array(
     'path' => '/tags',
     'author => 587,
     'timestamp' => 11545824,
     'message' => 'some other commit message'),
     ).
   
   

   
   
   Error codes:
   * 3001, Invalid session (wrong $sessionKey)
   * 3002, User do not have access to the project
   
   @param String $sessionKey Session key of the desired project admin
   @param Integer $group_id ID of the project the subversion repository belongs to
   @param String $path Path to the directory to list (eg. '/tags')
   @param String $sort The type of sort wanted: ASC or DESC
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/soap/svn#getSvnPathsWithLogDetails
   Input:
   getSvnPathsWithLogDetailsRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   path type string
   sort type string
   Output:
   getSvnPathsWithLogDetailsResponse (soap:body, use = encoded)Source code
   getSvnPathsWithLogDetails type ArrayOfSvnPathDetails - array of type SvnPathDetails

   • path type string
   • author type int
   • message type string
   • timestamp type int
4. getSvnStatsFiles
   Source code
   Description:
   Return top most modified files during the given period
   
   @param String $sessionKey Session key of the requesting user
   @param Integer $group_id ID of the project the subversion repository belongs to
   @param Integer $start_date Start of period (unix timestamp)
   @param Integer $end_date End of period (unix timestamp)
   @param Integer $limit Max number of files to return
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/soap/svn#getSvnStatsFiles
   Input:
   getSvnStatsFilesRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   start_date type int
   end_date type int
   limit type int
   Output:
   getSvnStatsFilesResponse (soap:body, use = encoded)Source code
   getSvnStatsFiles type ArrayOfSvnPathInfo - array of type SvnPathInfo

   • path type string
   • commit_count type int
5. getSvnStatsUsers
   Source code
   Description:
   Returns the list of active users (commiters) between start_date and end_date
   
   @param String $sessionKey Session key of the requesting user
   @param Integer $group_id ID of the project the subversion repository belongs to
   @param Integer $start_date Start of period (unix timestamp)
   @param Integer $end_date End of period (unix timestamp)
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/soap/svn#getSvnStatsUsers
   Input:
   getSvnStatsUsersRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   start_date type int
   end_date type int
   Output:
   getSvnStatsUsersResponse (soap:body, use = encoded)Source code
   getSvnStatsUsers type ArrayOfCommiter - array of type Commiter

   • user_id type int
   • commit_count type int