•  
      request #1834 [SOAP] Missing operations to retrieve and run the reports of an user
    Infos
    #1834
    Stéphane Bégaudeau (begaudeaus)
    2012-12-14 13:42
    2012-11-20 17:12
    953
    Details
    [SOAP] Missing operations to retrieve and run the reports of an user
    The SOAP APIs do not have any operations to retrieve the reports of the users along with their properties (name) and to run them to obtain the list of the artifacts found by the criteria of the report: https://demo.tuleap.net/plugins/tracker/soap/view-wsdl

    Everything needed to download the artifact exists already.
    API
    Empty
    Empty
    • [ ] enhancement
    • [ ] internal improvement
    Empty
    Stage
    Empty
    Resolved (disabled)
    Empty
    Attachments
    Empty
    References
    Referencing request #1834

    Follow-ups

    User avatar
    last edited by: Manuel Vacelet (vaceletm) 2012-12-04 12:04

    Development on going.

    We introduce the method "getTrackerReports(sessionKey, group_id, tracker_id)" it returns an ArrayOfTrackerReport:

     'id'           => array('name'=>'id',          'type' => 'xsd:int'),
     'name'         => array('name'=>'name',        'type' => 'xsd:string'),
     'description'  => array('name'=>'description', 'type' => 'xsd:string'),
     'user_id'      => array('name'=>'user_id',     'type' => 'xsd:int'),
     'is_default'   => array('name'=>'is_default',  'type' => 'xsd:boolean'),
    

    To run the report, we introduce the method "getArtifactsFromReport(sessionKey, report_id, offset, max_rows)" that returns an ArtifactQueryResult. It behaves and returns the same thing than getArtifacts (therefore you don't need to query again the server to get artifacts' details)

    User avatar
    -> when you run a report, is it OK for you to get only the corresponding artifact ids (without the values) ?
    It is ok for us since we can get the values of an artifact with the operation "getArtifact".

    -> when you list the reports, is it OK to only have the name or do you need more informations (like the criteria of the report with their values) ?
    The name of the report, used to display it to the end user, and its identifier, to run the report later, are the only two pieces of information that we currently need.
    User avatar
    2 questions:
    -> when you run a report, is it OK for you to get only the corresponding artifact ids (without the values) ?
    -> when you list the reports, is it OK to only have the name or do you need more informations (like the criteria of the report with their values) ?