Web Service: TuleapTrackerV5API

Port type TuleapTrackerV5APIPortTypeSource code

1. addArtifact
   Source code
   Description:
   Add an Artifact in the tracker tracker_id of the project group_id with the values given by value (an ArtifactFieldValue). Returns the Id of the created artifact if the creation succeed. Returns a soap fault if the group_id is not a valid one, if the tracker_name is not a valid one, or if the add failed.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#addArtifact
   Input:
   addArtifactRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   tracker_id type int
   value type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue

   • field_name type string
   • field_label type string
   • field_value type FieldValue
     • value type string
     • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
       • id type string
       • submitted_by type int
       • description type string
       • filename type string
       • filesize type int
       • filetype type string
       • action type string
     • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
       • bind_value_id type int
       • bind_value_label type string
   Output:
   addArtifactResponse (soap:body, use = encoded)Source code
   return type int
2. addSelectBoxValues
   Source code
   Description:
   Add values to Tracker selectBox field
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#addSelectBoxValues
   Input:
   addSelectBoxValuesRequest (soap:body, use = encoded)Source code
   sessionKey type string
   tracker_id type int
   field_id type int
   values type ArrayOfString - array of type string
   Output:
   addSelectBoxValuesResponse (soap:body, use = encoded)Source code
   return type boolean
3. appendTemporaryAttachmentChunk
   Source code
   Description:

   Appends file content chunk into selected attachment.
   
   attachment_name is generated by createTemporaryAttachment
   content must be base64 encoded
   
   Returns the number of written bytes on the file system.

   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#appendTemporaryAttachmentChunk
   Input:
   appendTemporaryAttachmentChunkRequest (soap:body, use = encoded)Source code
   sessionKey type string
   attachment_name type string
   content type string
   Output:
   appendTemporaryAttachmentChunkResponse (soap:body, use = encoded)Source code
   return type int
4. createTemporaryAttachment
   Source code
   Description:

   Provision an attachment for future upload
   
   This method is supposed to be run before "appendTemporaryAttachmentChunk" to
   allocate an file name on the server for upload before running "addArtifact" or
   "updateArtifact"
   
   Returns an attachment_name to be used with appendTemporaryAttachmentChunk.

   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#createTemporaryAttachment
   Input:
   createTemporaryAttachmentRequest (soap:body, use = encoded)Source code
   sessionKey type string
   Output:
   createTemporaryAttachmentResponse (soap:body, use = encoded)Source code
   return type string
5. getArtifact
   Source code
   Description:
   Returns the artifact (Artifact) identified by the id artifact_id Returns a soap fault if the group_id is not a valid one, if the tracker_id is not a valid one, or if the artifact_id is not a valid one.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#getArtifact
   Input:
   getArtifactRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   tracker_id type int
   artifact_id type int
   Output:
   getArtifactResponse (soap:body, use = encoded)Source code
   return type Artifact

   • artifact_id type int
   • tracker_id type int
   • submitted_by type int
   • submitted_on type int
   • cross_references type ArrayOfArtifactCrossReferences - array of type ArtifactCrossReferences
     • ref type string
     • url type string
   • last_update_date type int
   • value type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
     • field_name type string
     • field_label type string
     • field_value type FieldValue
       • value type string
       • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
         • id type string
         • submitted_by type int
         • description type string
         • filename type string
         • filesize type int
         • filetype type string
         • action type string
       • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
         • bind_value_id type int
         • bind_value_label type string
6. getArtifactAttachmentChunk
   Source code
   Description:
   Return base64 encoded chunk of request file
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#getArtifactAttachmentChunk
   Input:
   getArtifactAttachmentChunkRequest (soap:body, use = encoded)Source code
   sessionKey type string
   artifact_id type int
   attachment_id type int
   offset type int
   size type int
   Output:
   getArtifactAttachmentChunkResponse (soap:body, use = encoded)Source code
   return type string
7. getArtifactComments
   Source code
   Description:
   Returns the comments of an artifact.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#getArtifactComments
   Input:
   getArtifactCommentsRequest (soap:body, use = encoded)Source code
   sessionKey type string
   artifact_id type int
   Output:
   getArtifactCommentsResponse (soap:body, use = encoded)Source code
   return type ArrayOfArtifactComments - array of type ArtifactComments

   • submitted_by type int
   • email type string
   • submitted_on type int
   • body type string
8. getArtifactHistory
   Source code
   Description:
   Returns history (all changesets and comments) of an artifact.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#getArtifactHistory
   Input:
   getArtifactHistoryRequest (soap:body, use = encoded)Source code
   sessionKey type string
   artifact_id type int
   Output:
   getArtifactHistoryResponse (soap:body, use = encoded)Source code
   return type ArrayOfArtifactHistory - array of type ArtifactHistory

   • submitted_by type int
   • email type string
   • submitted_on type int
   • last_comment type ArtifactFollowupComment
     • submitted_by type int
     • submitted_on type int
     • format type string
     • body type string
   • fields type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
     • field_name type string
     • field_label type string
     • field_value type FieldValue
       • value type string
       • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
         • id type string
         • submitted_by type int
         • description type string
         • filename type string
         • filesize type int
         • filetype type string
         • action type string
       • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
         • bind_value_id type int
         • bind_value_label type string
9. getArtifacts
   Source code
   Description:
   Returns the ArtifactQueryResult of the tracker tracker_id in the project group_id that are matching the given criteria. If offset AND max_rows are filled, it returns only max_rows artifacts, skipping the first offset ones. It is not possible to sort artifact with this function (use getArtifactsFromReport if you want to sort). Returns a soap fault if the group_id is not a valid one or if the tracker_id is not a valid one.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198/plugins/tracker/soap#getArtifacts
   Input:
   getArtifactsRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   tracker_id type int
   criteria type ArrayOfCriteria - array of type Criteria

   • field_name type string
   • value type CriteriaValue
     • value type string
     • date type CriteriaValueDate
       • op type string
       • to_date type int
     • dateAdvanced type CriteriaValueDateAdvanced
       • from_date type int
       • to_date type int
   offset type int
   max_rows type int
   Output:
   getArtifactsResponse (soap:body, use = encoded)Source code
   return type ArtifactQueryResult

   • total_artifacts_number type int
   • artifacts type ArrayOfArtifact - array of type Artifact
     • artifact_id type int
     • tracker_id type int
     • submitted_by type int
     • submitted_on type int
     • cross_references type ArrayOfArtifactCrossReferences - array of type ArtifactCrossReferences
       • ref type string
       • url type string
     • last_update_date type int
     • value type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
       • field_name type string
       • field_label type string
       • field_value type FieldValue
         • value type string
         • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
           • id type string
           • submitted_by type int
           • description type string
           • filename type string
           • filesize type int
           • filetype type string
           • action type string
         • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
           • bind_value_id type int
           • bind_value_label type string
10. getArtifactsFromReport
    Source code
    Description:
    Execute a report and returns corresponding artifacts.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getArtifactsFromReport
    Input:
    getArtifactsFromReportRequest (soap:body, use = encoded)Source code
    sessionKey type string
    report_id type int
    offset type int
    max_rows type int
    Output:
    getArtifactsFromReportResponse (soap:body, use = encoded)Source code
    return type ArtifactQueryResult

    • total_artifacts_number type int
    • artifacts type ArrayOfArtifact - array of type Artifact
      • artifact_id type int
      • tracker_id type int
      • submitted_by type int
      • submitted_on type int
      • cross_references type ArrayOfArtifactCrossReferences - array of type ArtifactCrossReferences
        • ref type string
        • url type string
      • last_update_date type int
      • value type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
        • field_name type string
        • field_label type string
        • field_value type FieldValue
          • value type string
          • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
            • id type string
            • submitted_by type int
            • description type string
            • filename type string
            • filesize type int
            • filetype type string
            • action type string
          • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
            • bind_value_id type int
            • bind_value_label type string
11. getTrackerFields
    Source code
    Description:
    Returns the array of Trackerfields that are used in the tracker tracker_id of the project group_id. Returns a soap fault if the tracker ID or the group ID does not match with a valid project.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getTrackerFields
    Input:
    getTrackerFieldsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    tracker_id type int
    Output:
    getTrackerFieldsResponse (soap:body, use = encoded)Source code
    return type ArrayOfTrackerField - array of type TrackerField

    • tracker_id type int
    • field_id type int
    • short_name type string
    • label type string
    • type type string
    • values type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
      • bind_value_id type int
      • bind_value_label type string
    • binding type TrackerFieldBindType
      • bind_type type string
      • bind_list type ArrayOfUgroup - array of type UGroup
        • ugroup_id type int
        • name type string
    • permissions type ArrayOfString - array of type string
12. getTrackerList
    Source code
    Description:
    Returns the array of Tracker that belongs to the group identified by group ID. Returns a soap fault if the group ID does not match with a valid project.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getTrackerList
    Input:
    getTrackerListRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getTrackerListResponse (soap:body, use = encoded)Source code
    return type ArrayOfTracker - array of type Tracker

    • tracker_id type int
    • group_id type int
    • name type string
    • description type string
    • item_name type string
13. getTrackerReports
    Source code
    Description:
    Returns the reports the user can execute.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getTrackerReports
    Input:
    getTrackerReportsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    tracker_id type int
    Output:
    getTrackerReportsResponse (soap:body, use = encoded)Source code
    return type ArrayOfTrackerReport - array of type TrackerReport

    • id type int
    • name type string
    • description type string
    • user_id type int
    • is_default type boolean
14. getTrackerStructure
    Source code
    Description:
    Returns the tracker structure.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getTrackerStructure
    Input:
    getTrackerStructureRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    tracker_id type int
    Output:
    getTrackerStructureResponse (soap:body, use = encoded)Source code
    return type TrackerStructure

    • semantic type TrackerSemantic
      • title type TrackerSemanticTitle
        • field_name type string
      • status type TrackerSemanticStatus
        • field_name type string
        • values type ArrayOfInt - array of type int
      • contributor type TrackerSemanticContributor
        • field_name type string
      • initial_effort type AgileDashBoardSemanticInitialEffort
        • field_name type string
    • workflow type TrackerWorkflow
      • field_id type int
      • is_used type int
      • rules type TrackerWorkflowRuleArray
        • dates type TrackerWorkflowRuleDateArray - array of type TrackerWorkflowRuleDate
          • source_field_id type int
          • target_field_id type int
          • comparator type string
        • lists type TrackerWorkflowRuleListArray - array of type TrackerWorkflowRuleList
          • source_field_id type int
          • target_field_id type int
          • source_value_id type int
          • target_value_id type int
      • transitions type TrackerWorkflowTransitionArray - array of type TrackerWorkflowTransition
        • from_id type int
        • to_id type int
15. getVersion
    Source code
    Description:
    Returns the version number of the SOAP API. Changes are available in /plugins/tracker/soap/ChangeLog
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#getVersion
    Input:
    getVersionRequest (soap:body, use = encoded)Source code
    Output:
    getVersionResponse (soap:body, use = encoded)Source code
    return type float
16. purgeAllTemporaryAttachments
    Source code
    Description:
    Remove all temporary attachment not yet attached to an artifact
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#purgeAllTemporaryAttachments
    Input:
    purgeAllTemporaryAttachmentsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    Output:
    purgeAllTemporaryAttachmentsResponse (soap:body, use = encoded)Source code
    return type boolean
17. updateArtifact
    Source code
    Description:
    Update the artifact $artifact_id of the tracker $tracker_id in the project group_id with the values given by value. Add a follow-up comment $comment. Returns a soap fault if the group_id is not a valid one, if the tracker_id is not a valid one, if the artifart_id is not a valid one, or if the update failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198/plugins/tracker/soap#updateArtifact
    Input:
    updateArtifactRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    tracker_id type int
    artifact_id type int
    value type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue

    • field_name type string
    • field_label type string
    • field_value type FieldValue
      • value type string
      • file_info type ArrayOfFieldValueFileInfo - array of type FieldValueFileInfo
        • id type string
        • submitted_by type int
        • description type string
        • filename type string
        • filesize type int
        • filetype type string
        • action type string
      • bind_value type ArrayOfTrackerFieldBindValue - array of type TrackerFieldBindValue
        • bind_value_id type int
        • bind_value_label type string
    comment type string
    comment_format type string
    Output:
    updateArtifactResponse (soap:body, use = encoded)Source code
    return type int