Web Service: CodendiAPI

Port type CodendiAPIPortTypeSource code

1. addArtifact
   Source code
   Description:
   Add an Artifact in the tracker group_artifact_id of the project group_id with the values given by status_id, close_date, summary, details, severity and extra_fields for the non-standard fields. 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 group_artifact_id 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#addArtifact
   Input:
   addArtifactRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   status_id type int
   close_date type int
   summary type string
   details type string
   severity type int
   extra_fields type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue

   • field_id type int
   • artifact_id type int
   • field_value type string
   Output:
   addArtifactResponse (soap:body, use = encoded)Source code
   return type int
2. addArtifactAttachedFile
   Source code
   Description:
   Add an attached file to the artifact artifact_id of the tracker group_artifact_id of the project group_id. The attached file is described by the raw encoded_data (encoded in base64), the description of the file, the name of the file and it type (the mimi-type -- plain/text, image/jpeg, etc ...). Returns the ID of the attached file if the attachment succeed. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, or if the artifact_id is not a valid one, or if the attachment failed.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198#addArtifactAttachedFile
   Input:
   addArtifactAttachedFileRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   artifact_id type int
   encoded_data type string
   description type string
   filename type string
   filetype type string
   Output:
   addArtifactAttachedFileResponse (soap:body, use = encoded)Source code
   return type int
3. addArtifactCC
   Source code
   Description:
   Add a list of emails or logins in the CC list of a specific artifact, with an optional comment
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198#addArtifactCC
   Input:
   addArtifactCCRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   artifact_id type int
   cc_list type string
   cc_comment type string
   Output:
   addArtifactCCResponse (soap:body, use = encoded)Source code
   return type boolean
4. addArtifactDependencies
   Source code
   Description:
   Add the list of dependencies is_dependent_on_artifact_id to the list of dependencies of the artifact artifact_id of the tracker group_artifact_id of the project group_id. Returns true if the add succeed. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifact_id 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#addArtifactDependencies
   Input:
   addArtifactDependenciesRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   artifact_id type int
   is_dependent_on_artifact_ids type string
   Output:
   addArtifactDependenciesResponse (soap:body, use = encoded)Source code
   return type boolean
5. addArtifactFollowup
   Source code
   Description:
   Add a follow-up body to the artifact artifact_id of the tracker group_artifact_id of the project group_id, with optionals comment type and canned response. If canned response is set, it will replace the body. Returns nothing if the add succeed. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifact_id 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#addArtifactFollowup
   Input:
   addArtifactFollowupRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   artifact_id type int
   body type string
   comment_type_id type int
   format type int
   Output:
   addArtifactFollowupResponse (soap:body, use = encoded)Source code
   return type boolean
6. addArtifactWithFieldNames
   Source code
   Description:
   Add an Artifact in the tracker tracker_name of the project group_id with the values given by status_id, close_date, summary, details, severity and extra_fields for the non-standard fields. 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#addArtifact
   Input:
   addArtifactWithFieldNamesRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   group_artifact_id type int
   status_id type int
   close_date type int
   summary type string
   details type string
   severity type int
   extra_fields type ArrayOfArtifactFieldNameValue - array of type ArtifactFieldNameValue

   • field_name type string
   • field_value type string
   Output:
   addArtifactWithFieldNamesResponse (soap:body, use = encoded)Source code
   return type int
7. addFile
   Source code
   Description:
   Add a File to the File Release Manager of the project group_id with the values given by package_id, release_id, filename, base64_contents, type_id, processor_id, reference_md5 and comment. The content of the file must be encoded in base64. Returns the ID of the created file if the creation succeed. Returns a soap fault if the group_id is not a valid one, if the package does not match with the group ID, if the release does not match with the package ID, 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#addFile
   Input:
   addFileRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   package_id type int
   release_id type int
   filename type string
   base64_contents type string
   type_id type int
   processor_id type int
   reference_md5 type string
   comment type string
   Output:
   addFileResponse (soap:body, use = encoded)Source code
   addFile type int
8. addFileChunk
   Source code
   Description:
   Add a chunk to a file in the incoming directory to be released later in FRS. The content of the chunk must be encoded in base64. Returns the size of the written chunk if the chunk addition succeed. Returns a soap fault if the session is not valid or if the addition failed.
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://147.135.128.198#addFileChunk
   Input:
   addFileChunkRequest (soap:body, use = encoded)Source code
   sessionKey type string
   filename type string
   contents type string
   first_chunk type boolean
   Output:
   addFileChunkResponse (soap:body, use = encoded)Source code
   addFileChunk type integer
9. addPackage
   Source code
   Description:
   Add a Package to the File Release Manager of the project group_id with the values given by package_name, status_id, rank and approve_license. Returns the ID of the created package if the creation succeed. Returns a soap fault if the group_id 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#addPackage
   Input:
   addPackageRequest (soap:body, use = encoded)Source code
   sessionKey type string
   group_id type int
   package_name type string
   status_id type int
   rank type int
   approve_license type boolean
   Output:
   addPackageResponse (soap:body, use = encoded)Source code
   addPackageResponse type int
10. addRelease
    Source code
    Description:
    Add a Release to the File Release Manager of the project group_id with the values given by package_id, name, notes, changes, status_id and release_date. Returns the ID of the created release if the creation succeed. Returns a soap fault if the group_id is not a valid one, if the package does not match with the group ID, 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#addRelease
    Input:
    addReleaseRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    name type string
    notes type string
    changes type string
    status_id type int
    release_date type int
    Output:
    addReleaseResponse (soap:body, use = encoded)Source code
    addRelease type int
11. addUploadedFile
    Source code
    Description:
    Add a File to the File Release Manager of the project group_id with the values given by package_id, release_id, filename, type_id, processor_id, reference_md5 and comment. The file must already be present in the incoming directory. Returns the ID of the created file if the creation succeed. Returns a soap fault if the group_id is not a valid one, if the package does not match with the group ID, if the release does not match with the package ID, 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#addUploadedFile
    Input:
    addUploadedFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    filename type string
    type_id type int
    processor_id type int
    reference_md5 type string
    comment type string
    Output:
    addUploadedFileResponse (soap:body, use = encoded)Source code
    addUploadedFile type int
12. appendDocmanFileChunk
    Source code
    Description:
    Appends a chunk of data to the last version of a file

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    content             Content
    chunk_offset        Chunk offset
    chunk_size          Chunk size
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#appendDocmanFileChunk
    Input:
    appendDocmanFileChunkRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    content type string
    chunk_offset type int
    chunk_size type int
    Output:
    appendDocmanFileChunkResponse (soap:body, use = encoded)Source code
    appendDocmanFileChunkResponse type int
13. checkUsersExistence
    Source code
    Description:
    Returns the users that exist with their user name
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#checkUsersExistence
    Input:
    checkUsersExistenceRequest (soap:body, use = encoded)Source code
    sessionKey type string
    users type ArrayOfstring - array of type string
    Output:
    checkUsersExistenceResponse (soap:body, use = encoded)Source code
    return type ArrayOfUserInfo - array of type UserInfo

    • identifier type string
    • username type string
    • id type string
    • real_name type string
    • email type string
    • ldap_id type string
14. createDocmanEmbeddedFile
    Source code
    Description:
    Creates a docman embedded file

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    content             Content
    permissions         Permissions
    metadata            Metadata values
    author              Version author
    date                Version date (timestamp)
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanEmbeddedFile
    Input:
    createDocmanEmbeddedFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    obsolescence_date type string
    content type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    author type string
    date type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanEmbeddedFileResponse (soap:body, use = encoded)Source code
    createDocmanEmbeddedFileResponse type int
15. createDocmanEmbeddedFileVersion
    Source code
    Description:
    Creates a docman embedded file version

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    label               version label
    changelog           Version changelog
    content             Content
    author              Version author
    date                Version date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanEmbeddedFileVersion
    Input:
    createDocmanEmbeddedFileVersionRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    label type string
    changelog type string
    content type string
    author type string
    date type string
    Output:
    createDocmanEmbeddedFileVersionResponse (soap:body, use = encoded)Source code
    createDocmanEmbeddedFileVersionResponse type int
16. createDocmanEmptyDocument
    Source code
    Description:
    Creates a docman empty document

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanEmptyDocument
    Input:
    createDocmanEmptyDocumentRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    obsolescence_date type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanEmptyDocumentResponse (soap:body, use = encoded)Source code
    createDocmanEmptyDocumentResponse type int
17. createDocmanFile
    Source code
    Description:
    Creates a docman file

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    permissions         Permissions
    metadata            Metadata values
    file_size           File size
    file_name           File name
    mime_type           Mime type
    content             Content
    chunk_offset        Chunk offset
    chunk_size          Chunk size
    author              Version author
    date                Version date (timestamp)
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanFile
    Input:
    createDocmanFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    obsolescence_date type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    file_size type int
    file_name type string
    mime_type type string
    content type string
    chunk_offset type int
    chunk_size type int
    author type string
    date type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanFileResponse (soap:body, use = encoded)Source code
    createDocmanFileResponse type int
18. createDocmanFileVersion
    Source code
    Description:
    Creates a docman file version

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    label               version label
    changelog           Version changelog
    file_size           File size
    file_name           File name
    mime_type           Mime type
    content             Content
    chunk_offset        Chunk offset
    chunk_size          Chunk size
    author              Version author
    date                Version date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanFileVersion
    Input:
    createDocmanFileVersionRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    label type string
    changelog type string
    file_size type int
    file_name type string
    mime_type type string
    content type string
    chunk_offset type int
    chunk_size type int
    author type string
    date type string
    Output:
    createDocmanFileVersionResponse (soap:body, use = encoded)Source code
    createDocmanFileVersionResponse type int
19. createDocmanFolder
    Source code
    Description:
    Create a folder

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanFolder
    Input:
    createDocmanFolderRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanFolderResponse (soap:body, use = encoded)Source code
    createDocmanFolderResponse type int
20. createDocmanLink
    Source code
    Description:
    Creates a docman link

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    content             Content
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanLink
    Input:
    createDocmanLinkRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    obsolescence_date type string
    content type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanLinkResponse (soap:body, use = encoded)Source code
    createDocmanLinkResponse type int
21. createDocmanWikiPage
    Source code
    Description:
    Creates a docman wiki page

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    title               Title
    description         Description
    ordering            Ordering (begin, end)
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    content             Content
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#createDocmanWikiPage
    Input:
    createDocmanWikiPageRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    title type string
    description type string
    ordering type string
    status type string
    obsolescence_date type string
    content type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    createDocmanWikiPageResponse (soap:body, use = encoded)Source code
    createDocmanWikiPageResponse type int
22. deleteArtifactAttachedFile
    Source code
    Description:
    Delete the attached file file_id from the artifact artifact_id of the tracker group_artifact_id of the project group_id. Returns the ID of the deleted file if the deletion succeed. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifact_id is not a valid one, if the file_id is not a valid one or if the deletion failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteArtifactAttachedFile
    Input:
    deleteArtifactAttachedFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    file_id type int
    Output:
    deleteArtifactAttachedFileResponse (soap:body, use = encoded)Source code
    return type int
23. deleteArtifactCC
    Source code
    Description:
    Delete a CC to the CC list of the artifact
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteArtifactCC
    Input:
    deleteArtifactCCRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    artifact_cc_id type int
    Output:
    deleteArtifactCCResponse (soap:body, use = encoded)Source code
    return type boolean
24. deleteArtifactDependency
    Source code
    Description:
    Delete the dependency between the artifact dependent_on_artifact_id and the artifact artifact_id of the tracker group_artifact_id of the project group_id. Returns the ID of the deleted dependency if the deletion succeed. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifact_id is not a valid one, if the dependent_on_artifact_id is not a valid artifact id, or if the deletion failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteArtifactDependency
    Input:
    deleteArtifactDependencyRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    dependent_on_artifact_id type int
    Output:
    deleteArtifactDependencyResponse (soap:body, use = encoded)Source code
    return type int
25. deleteArtifactFollowUp
    Source code
    Description:
    Delete the follow_up artifact_history_id of the tracker $group_artifact_id in the project group_id for the artifact $artifact_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifart_id is not a valid one, if the artifact_history_id is not a valid one, or if the deletion failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteArtifact
    Input:
    deleteArtifactFollowUpRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    artifact_history_id type int
    Output:
    deleteArtifactFollowUpResponse (soap:body, use = encoded)Source code
    return type boolean
26. deleteDocmanItem
    Source code
    Description:
    Delete an item (document or folder)

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteDocmanItem
    Input:
    deleteDocmanItemRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    Output:
    deleteDocmanItemResponse (soap:body, use = encoded)Source code
    deleteDocmanItemResponse type int
27. deleteEmptyPackage
    Source code
    Description:
    Delete a package or all empty packages in project group_id. Returns the list of deleted packages if succeed, or a soap fault if an error occured.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteEmptyPackage
    Input:
    deleteEmptyPackageRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    cleanup_all type boolean
    Output:
    deleteEmptyPackageResponse (soap:body, use = encoded)Source code
    deleteEmptyPackageResponse type ArrayOfFRSPackage - array of type FRSPackage

    • package_id type int
    • group_id type int
    • name type string
    • status_id type int
    • rank type int
    • approve_license type boolean
28. deleteEmptyRelease
    Source code
    Description:
    Delete a release or all empty releases in package package_id. Returns the list of deleted releases if succeed, or a soap fault if an error occured.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteEmptyRelease
    Input:
    deleteEmptyReleaseRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    cleanup_all type boolean
    Output:
    deleteEmptyReleaseResponse (soap:body, use = encoded)Source code
    deleteEmptyReleaseResponse type ArrayOfFRSRelease - array of type FRSRelease

    • release_id type int
    • package_id type int
    • name type string
    • notes type string
    • changes type string
    • status_id type string
    • release_date type int
    • released_by type string
29. deleteFile
    Source code
    Description:
    Delete the file file_id in release release_id in package package_id. Returns true if succeed, or a soap fault if an error occured.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#deleteFile
    Input:
    deleteFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    file_id type int
    Output:
    deleteFileResponse (soap:body, use = encoded)Source code
    deleteFileResponse type boolean
30. existArtifactSummary
    Source code
    Description:
    Check if there is an artifact in the tracker group_artifact_id that already have the summary summary (the summary is unique inside a given tracker). Returns the ID of the artifact containing the same summary in the tracker, or -1 if the summary does not exist in this tracker.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#existArtifactSummary
    Input:
    existArtifactSummaryRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_artifact_id type int
    summary type string
    Output:
    existArtifactSummaryResponse (soap:body, use = encoded)Source code
    return type int
31. getAPIVersion
    Source code
    Description:
    Returns the current version of this Web Service API.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getAPIVersion
    Input:
    getAPIVersionRequest (soap:body, use = encoded)Source code
    Output:
    getAPIVersionResponse (soap:body, use = encoded)Source code
    return type string
32. getArtifactAttachedFile
    Source code
    Description:
    Returns the attached file (ArtifactFile) with the id file_id attached to the artifact artifact_id in the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifact_id is not a valid one, or if the file_id doesnt match with the given artifact_id.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getArtifactAttachedFile
    Input:
    getArtifactAttachedFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    file_id type int
    Output:
    getArtifactAttachedFileResponse (soap:body, use = encoded)Source code
    return type ArtifactFile

    • id type int
    • artifact_id type int
    • filename type string
    • description type string
    • bin_data type base64Binary
    • filesize type int
    • filetype type string
    • adddate type int
    • submitted_by type string
33. getArtifactAttachedFiles
    Source code
    Description:
    Returns the array of attached files (ArtifactFile) attached to the artifact artifact_id in the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, or if the artifact_id is not a valid one. NOTE : for performance reasons, the result does not contain the content of the file. Please use getArtifactAttachedFile to get the content of a single file
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getArtifactAttachedFiles
    Input:
    getArtifactAttachedFilesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactAttachedFilesResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactFile - array of type ArtifactFile

    • id type int
    • artifact_id type int
    • filename type string
    • description type string
    • bin_data type base64Binary
    • filesize type int
    • filetype type string
    • adddate type int
    • submitted_by type string
34. getArtifactById
    Source code
    Description:
    Returns the artifact (Artifact) identified by the id artifact_id in the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_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#getArtifactById
    Input:
    getArtifactByIdRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactByIdResponse (soap:body, use = encoded)Source code
    return type Artifact

    • artifact_id type int
    • group_artifact_id type int
    • status_id type int
    • submitted_by type int
    • open_date type int
    • close_date type int
    • last_update_date type int
    • summary type string
    • details type string
    • severity type int
    • extra_fields type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
      • field_id type int
      • artifact_id type int
      • field_value type string
35. getArtifactCCList
    Source code
    Description:
    Get the list of emails or logins in the CC list of a specific artifact
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getArtifactCCList
    Input:
    getArtifactCCListRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactCCListResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactCC - array of type ArtifactCC

    • artifact_cc_id type int
    • artifact_id type int
    • email type string
    • added_by type int
    • added_by_name type string
    • comment type string
    • date type int
36. getArtifactCannedResponses
    Source code
    Description:
    Returns the list of canned responses (ArtifactCanned) for the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one or if group_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#getArtifactCannedResponses
    Input:
    getArtifactCannedResponsesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    Output:
    getArtifactCannedResponsesResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactCanned - array of type ArtifactCanned

    • artifact_canned_id type int
    • group_artifact_id type int
    • title type string
    • body type string
37. getArtifactDependencies
    Source code
    Description:
    Returns the list of the dependencies (ArtifactDependency) for the artifact artifact_id of the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_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#getArtifactDependencies
    Input:
    getArtifactDependenciesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactDependenciesResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactDependency - array of type ArtifactDependency

    • artifact_depend_id type int
    • artifact_id type int
    • is_dependent_on_artifact_id type int
    • summary type string
    • tracker_id type int
    • tracker_name type string
    • group_id type int
    • group_name type string
38. getArtifactFollowups
    Source code
    Description:
    Returns the list of follow-ups (ArtifactFollowup) of the artifact artifact_id of the tracker group_artifact_id in the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, or if the artifart_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#getArtifactFollowups
    Input:
    getArtifactFollowupsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactFollowupsResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactFollowup - array of type ArtifactFollowup

    • artifact_id type int
    • follow_up_id type int
    • comment type string
    • date type int
    • original_date type int
    • by type string
    • original_by type string
    • comment_type_id type int
    • comment_type type string
    • field_name type string
    • user_can_edit type int
39. getArtifactHistory
    Source code
    Description:
    Get the history of the artifact (the history of the fields values)
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getArtifactHistory
    Input:
    getArtifactHistoryRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactHistoryResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactHistory - array of type ArtifactHistory

    • field_name type string
    • old_value type string
    • new_value type string
    • modification_by type string
    • date type int
40. getArtifactInverseDependencies
    Source code
    Description:
    Returns the list of the dependencies (ArtifactDependency) that other artifact can have with the artifact artifact_id of the tracker group_artifact_id of the project group_id. Returns a soap fault if the group_id is not a valid one, if the group_artifact_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#getArtifactInverseDependencies
    Input:
    getArtifactInverseDependenciesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    Output:
    getArtifactInverseDependenciesResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactDependency - array of type ArtifactDependency

    • artifact_depend_id type int
    • artifact_id type int
    • is_dependent_on_artifact_id type int
    • summary type string
    • tracker_id type int
    • tracker_name type string
    • group_id type int
    • group_name type string
41. getArtifactReports
    Source code
    Description:
    Returns the list of reports (ArtifactReport) for the tracker group_artifact_id of the project group_id of the current user. Returns a soap fault if the group_id is not a valid one, if the group_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#getArtifactReports
    Input:
    getArtifactReportsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    Output:
    getArtifactReportsResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactReport - array of type ArtifactReport

    • report_id type int
    • group_artifact_id type int
    • name type string
    • description type string
    • scope type string
    • fields type ArrayOfArtifactReportField - array of type ArtifactReportField
      • report_id type int
      • field_name type string
      • show_on_query type int
      • show_on_result type int
      • place_query type int
      • place_result type int
      • col_width type int
42. getArtifactType
    Source code
    Description:
    Returns the ArtifactType (tracker) with the ID group_artifact_id that belongs to the group identified by group ID. Returns a soap fault if the group ID does not match with a valid project, or if the group_artifact_id is invalid or is not a tracker of the project.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getArtifactType
    Input:
    getArtifactTypeRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    Output:
    getArtifactTypeResponse (soap:body, use = encoded)Source code
    return type ArtifactType

    • group_artifact_id type int
    • group_id type int
    • name type string
    • description type string
    • item_name type string
    • open_count type int
    • total_count type int
    • total_file_size type float
    • field_sets type ArrayOfArtifactFieldSet - array of type ArtifactFieldSet
      • field_set_id type int
      • group_artifact_id type int
      • name type string
      • label type string
      • description type string
      • description_text type string
      • rank type int
      • fields type ArrayOfArtifactField - array of type ArtifactField
        • field_id type int
        • group_artifact_id type int
        • field_set_id type int
        • field_name type string
        • data_type type int
        • display_type type string
        • display_size type string
        • label type string
        • description type string
        • scope type string
        • required type int
        • empty_ok type int
        • keep_history type int
        • special type int
        • value_function type string
        • available_values type ArrayOfArtifactFieldValueList - array of type ArtifactFieldValueList
          • field_id type int
          • group_artifact_id type int
          • value_id type int
          • value type string
          • description type string
          • order_id type int
          • status type string
        • default_value type string
        • user_can_submit type boolean
        • user_can_update type boolean
        • user_can_read type boolean
        • is_standard_field type boolean
    • field_dependencies type ArrayOfArtifactRule - array of type ArtifactRule
      • rule_id type int
      • group_artifact_id type int
      • source_field_id type int
      • source_value_id type int
      • target_field_id type int
      • target_value_id type int
43. getArtifactTypes
    Source code
    Description:
    Returns the array of ArtifactType (trackers) 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#getArtifactTypes
    Input:
    getArtifactTypesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getArtifactTypesResponse (soap:body, use = encoded)Source code
    return type ArrayOfArtifactType - array of type ArtifactType

    • group_artifact_id type int
    • group_id type int
    • name type string
    • description type string
    • item_name type string
    • open_count type int
    • total_count type int
    • total_file_size type float
    • field_sets type ArrayOfArtifactFieldSet - array of type ArtifactFieldSet
      • field_set_id type int
      • group_artifact_id type int
      • name type string
      • label type string
      • description type string
      • description_text type string
      • rank type int
      • fields type ArrayOfArtifactField - array of type ArtifactField
        • field_id type int
        • group_artifact_id type int
        • field_set_id type int
        • field_name type string
        • data_type type int
        • display_type type string
        • display_size type string
        • label type string
        • description type string
        • scope type string
        • required type int
        • empty_ok type int
        • keep_history type int
        • special type int
        • value_function type string
        • available_values type ArrayOfArtifactFieldValueList - array of type ArtifactFieldValueList
          • field_id type int
          • group_artifact_id type int
          • value_id type int
          • value type string
          • description type string
          • order_id type int
          • status type string
        • default_value type string
        • user_can_submit type boolean
        • user_can_update type boolean
        • user_can_read type boolean
        • is_standard_field type boolean
    • field_dependencies type ArrayOfArtifactRule - array of type ArtifactRule
      • rule_id type int
      • group_artifact_id type int
      • source_field_id type int
      • source_value_id type int
      • target_field_id type int
      • target_value_id type int
44. getArtifacts
    Source code
    Description:
    Returns the ArtifactQueryResult of the tracker group_artifact_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 group_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#getArtifacts
    Input:
    getArtifactsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    criteria type ArrayOfCriteria - array of type Criteria

    • field_name type string
    • field_value type string
    • operator type string
    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
      • group_artifact_id type int
      • status_id type int
      • submitted_by type int
      • open_date type int
      • close_date type int
      • last_update_date type int
      • summary type string
      • details type string
      • severity type int
      • extra_fields type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue
        • field_id type int
        • artifact_id type int
        • field_value type string
45. getArtifactsFromReport
    Source code
    Description:
    Returns the ArtifactReportResult of the tracker group_artifact_id in the project group_id with the report report_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. The result will be sorted, as defined in the param sort_criteria. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one or if the report_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#getArtifactsFromReport
    Input:
    getArtifactsFromReportRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    report_id type int
    criteria type ArrayOfCriteria - array of type Criteria

    • field_name type string
    • field_value type string
    • operator type string
    offset type int
    max_rows type int
    sort_criteria type ArrayOfSortCriteria - array of type SortCriteria

    • field_name type string
    • sort_direction type string
    Output:
    getArtifactsFromReportResponse (soap:body, use = encoded)Source code
    return type ArtifactFromReportResult

    • total_artifacts_number type int
    • artifacts type ArrayOfArtifactFromReport - array of type ArtifactFromReport
      • artifact_id type int
      • severity type int
      • fields type ArrayOfArtifactFieldFromReport - array of type ArtifactFieldFromReport
        • field_name type string
        • field_value type string
46. getDocmanFileAllVersionsMD5sum
    Source code
    Description:
    Returns the MD5 checksum of the file (all versions) corresponding to the provided item ID

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanFileAllVersionsMD5sum
    Input:
    getDocmanFileAllVersionsMD5sumRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    Output:
    getDocmanFileAllVersionsMD5sumResponse (soap:body, use = encoded)Source code
    getDocmanFileAllVersionsMD5sumResponse type ArrayOfstring - array of type string
47. getDocmanFileChunk
    Source code
    Description:
    Returns a part (chunk) of the content, encoded in base64, of the file/embedded file which id item_id of a given version version_number, if the version is not specified it will be the current one, in the project group_id.Returns an error if the group ID does not match with a valid project, or if the item ID does not match with the right group ID, or if the version number does not match with the item ID.

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    version_number      Version number
    chunk_offset        Chunk offset
    chunk_size          Chunk size
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanFileChunk
    Input:
    getDocmanFileChunkRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    version_number type int
    chunk_offset type int
    chunk_size type int
    Output:
    getDocmanFileChunkResponse (soap:body, use = encoded)Source code
    getDocmanFileChunkResponse type string
48. getDocmanFileContents
    Source code
    Description:
    Returns the content of a file (or embedded file) base64 encoded. (version_number = -1 means last)

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    version_number      Version number
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanFileContents
    Input:
    getDocmanFileContentsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    version_number type int
    Output:
    getDocmanFileContentsResponse (soap:body, use = encoded)Source code
    getDocmanFileContentsResponse type string
49. getDocmanFileMD5sum
    Source code
    Description:
    Returns the MD5 checksum of the file (last version) corresponding to the provided item ID

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    version_number      Version number
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanFileMD5sum
    Input:
    getDocmanFileMD5sumRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    version_number type int
    Output:
    getDocmanFileMD5sumResponse (soap:body, use = encoded)Source code
    getDocmanFileMD5sumResponse type string
50. getDocmanProjectMetadata
    Source code
    Description:
    Returns the metadata of the given project

    sessionKey          Session key
    group_id            Group ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanProjectMetadata
    Input:
    getDocmanProjectMetadataRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getDocmanProjectMetadataResponse (soap:body, use = encoded)Source code
    getDocmanProjectMetadataResponse type ArrayOfMetadata - array of type Metadata

    • label type string
    • name type string
    • type type string
    • isMultipleValuesAllowed type int
    • isEmptyAllowed type int
    • listOfValues type ArrayOfMetadataListValue - array of type MetadataListValue
      • id type int
      • name type string
51. getDocmanTreeInfo
    Source code
    Description:
    Returns the tree information of the given project

    sessionKey          Session key
    group_id            Group ID
    parent_id           Parent ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getDocmanTreeInfo
    Input:
    getDocmanTreeInfoRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    parent_id type int
    Output:
    getDocmanTreeInfoResponse (soap:body, use = encoded)Source code
    getDocmanTreeInfoResponse type ArrayOfItemInfo - array of type ItemInfo

    • id type int
    • parent_id type int
    • title type string
    • filename type string
    • type type string
    • nb_versions type int
52. getFile
    Source code
    Description:
    Returns the content (encoded in base64) of the file contained in the release release_id in the package package_id, in the project group_id. Returns a soap fault if the group ID does not match with a valid project, or if the package ID does not match with the right group ID, or if the release ID does not match with the right package ID, or if the file ID does not match with the right release ID.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getFile
    Input:
    getFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    file_id type int
    Output:
    getFileResponse (soap:body, use = encoded)Source code
    getFileResponse type string
53. getFileChunk
    Source code
    Description:
    Returns a part (chunk) of the content, encoded in base64, of the file contained in the release release_id in the package package_id, in the project group_id. You specify the offset where the download should start and the size to transfer. Returns a soap fault if the group ID does not match with a valid project, or if the package ID does not match with the right group ID, or if the release ID does not match with the right package ID, or if the file ID does not match with the right release ID.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getFileChunk
    Input:
    getFileChunkRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    file_id type int
    offset type int
    size type int
    Output:
    getFileChunkResponse (soap:body, use = encoded)Source code
    getFileChunkResponse type string
54. getFileInfo
    Source code
    Description:
    Returns the metadata of the file contained in the release release_id in the package package_id, in the project group_id. Returns a soap fault if the group ID does not match with a valid project, or if the package ID does not match with the right group ID, or if the release ID does not match with the right package ID, or if the file ID does not match with the right release ID.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getFileInfo
    Input:
    getFileInfoRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    file_id type int
    Output:
    getFileInfoResponse (soap:body, use = encoded)Source code
    getFileInfoResponse type FRSFile

    • file_id type int
    • release_id type int
    • file_name type string
    • file_size type int
    • type_id type int
    • processor_id type int
    • release_time type int
    • post_date type int
    • computed_md5 type string
    • reference_md5 type string
    • user_id type int
    • comment type string
55. getFiles
    Source code
    Description:
    Returns the array of FRSFiles that belongs to the group identified by group ID, to the package identified by package_id and to the release identfied by release_id. Returns a soap fault if the group ID does not match with a valid project, or if the package ID does not match with the right group ID, or if the release ID does not match with the right package ID.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getFiles
    Input:
    getFilesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    Output:
    getFilesResponse (soap:body, use = encoded)Source code
    getFilesResponse type ArrayOfFRSFile - array of type FRSFile

    • file_id type int
    • release_id type int
    • file_name type string
    • file_size type int
    • type_id type int
    • processor_id type int
    • release_time type int
    • post_date type int
    • computed_md5 type string
    • reference_md5 type string
    • user_id type int
    • comment type string
56. getGroupById
    Source code
    Description:
    Returns the Group object associated with the given ID, or a soap fault if the 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#getGroupById
    Input:
    getGroupByIdRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getGroupByIdResponse (soap:body, use = encoded)Source code
    return type Group

    • group_id type int
    • group_name type string
    • unix_group_name type string
    • description type string
57. getGroupByName
    Source code
    Description:
    Returns a Group object matching with the given unix_group_name, or a soap fault if the name 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#getGroupByName
    Input:
    getGroupByNameRequest (soap:body, use = encoded)Source code
    sessionKey type string
    unix_group_name type string
    Output:
    getGroupByNameResponse (soap:body, use = encoded)Source code
    return type Group

    • group_id type int
    • group_name type string
    • unix_group_name type string
    • description type string
58. getGroupUgroups
    Source code
    Description:
    Returns the Ugroups associated to the given project:

           [ 
             ["ugroup_id" => 120,
              "name"      => "my custom group",
              "members"   => [ ["user_id"   => 115,
                                "user_name" => "john_doe"],
                             ]
             ]
           ]
         

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getGroupUgroups
    Input:
    getGroupUgroupsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getGroupUgroupsResponse (soap:body, use = encoded)Source code
    return type ArrayOfUgroup - array of type Ugroup

    • ugroup_id type int
    • name type string
    • members type ArrayOfUGroupMember - array of type UGroupMember
      • user_id type int
      • user_name type string
59. getMyProjects
    Source code
    Description:
    Returns the list of Groups that the current user belong to
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getMyProjects
    Input:
    getMyProjectsRequest (soap:body, use = encoded)Source code
    sessionKey type string
    Output:
    getMyProjectsResponse (soap:body, use = encoded)Source code
    return type ArrayOfGroup - array of type Group

    • group_id type int
    • group_name type string
    • unix_group_name type string
    • description type string
60. getPackages
    Source code
    Description:
    Returns the array of FRSPackages 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#getPackages
    Input:
    getPackagesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getPackagesResponse (soap:body, use = encoded)Source code
    getPackagesResponse type ArrayOfFRSPackage - array of type FRSPackage

    • package_id type int
    • group_id type int
    • name type string
    • status_id type int
    • rank type int
    • approve_license type boolean
61. getProjectGroupsAndUsers
    Source code
    Description:
    Returns all groups defined in project both dynamic and static (aka user group).

          [
            ["ugroup_id" => 3,
             "name"      => "project_members",
             "members"   => [ ["user_id"   => 115,
                               "user_name" => "john_doe"],
                              ["user_id"   => 120,
                               "user_name" => "foo_bar"]
                            ]
            ],
            ["ugroup_id" => 120,
             "name"      => "my custom group",
             "members"   => [ ["user_id"   => 115,
                               "user_name" => "john_doe"],
                            ]
            ]
          ]
         

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getProjectGroupsAndUsers
    Input:
    getProjectGroupsAndUsersRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getProjectGroupsAndUsersResponse (soap:body, use = encoded)Source code
    return type ArrayOfUgroup - array of type Ugroup

    • ugroup_id type int
    • name type string
    • members type ArrayOfUGroupMember - array of type UGroupMember
      • user_id type int
      • user_name type string
62. getReleases
    Source code
    Description:
    Returns the array of FRSReleases that belongs to the group identified by group ID and to the package identified by package_id. Returns a soap fault if the group ID does not match with a valid project, or if the package ID does not match with the right group ID.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getReleases
    Input:
    getReleasesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    Output:
    getReleasesResponse (soap:body, use = encoded)Source code
    getReleasesResponse type ArrayOfFRSRelease - array of type FRSRelease

    • release_id type int
    • package_id type int
    • name type string
    • notes type string
    • changes type string
    • status_id type string
    • release_date type int
    • released_by type string
63. getRootFolder
    Source code
    Description:
    Returns the document object id that is at the top of the docman given a group object

    sessionKey          Session key
    group_id            Group ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getRootFolder
    Input:
    getRootFolderRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getRootFolderResponse (soap:body, use = encoded)Source code
    getRootFolderResponse type int
64. getTrackerList
    Source code
    Description:
    Returns the array of TrackerDesc (light description of trackers) 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#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 ArrayOfTrackerDesc - array of type TrackerDesc

    • group_artifact_id type int
    • group_id type int
    • name type string
    • description type string
    • item_name type string
    • open_count type int
    • total_count type int
    • reports_desc type ArrayOfArtifactReportDesc - array of type ArtifactReportDesc
      • report_id type int
      • group_artifact_id type int
      • name type string
      • description type string
      • scope type string
65. getUploadedFiles
    Source code
    Description:
    Get the file names of the file present in the incoming directory on the server.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getUploadedFiles
    Input:
    getUploadedFilesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    Output:
    getUploadedFilesResponse (soap:body, use = encoded)Source code
    getUploadedFilesResponse type ArrayOfstring - array of type string
66. getUserInfo
    Source code
    Description:
    Returns the user info matching the given id
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#getUserInfo
    Input:
    getUserInfoRequest (soap:body, use = encoded)Source code
    sessionKey type string
    user_id type int
    Output:
    getUserInfoResponse (soap:body, use = encoded)Source code
    return type UserInfo

    • identifier type string
    • username type string
    • id type string
    • real_name type string
    • email type string
    • ldap_id type string
67. listFolder
    Source code
    Description:
    List folder contents

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#listFolder
    Input:
    listFolderRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    Output:
    listFolderResponse (soap:body, use = encoded)Source code
    listFolderResponse type ArrayOfDocman_Item - array of type Docman_Item

    • item_id type int
    • parent_id type int
    • group_id type int
    • title type string
    • description type string
    • create_date type int
    • update_date type int
    • delete_date type int
    • user_id type int
    • status type int
    • obsolescence_date type int
    • rank type int
    • item_type type int
68. login
    Source code
    Description:
    Login Tuleap Server with given login and password. Returns a soap fault if the login failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#login
    Input:
    loginRequest (soap:body, use = encoded)Source code
    loginname type string
    passwd type string
    Output:
    loginResponse (soap:body, use = encoded)Source code
    return type Session

    • user_id type int
    • session_hash type string
69. loginAs
    Source code
    Description:
    Login Tuleap Server with given admin_session_name and login. Returns a soap fault if the login failed.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#loginAs
    Input:
    loginAsRequest (soap:body, use = encoded)Source code
    admin_session_hash type string
    loginname type string
    Output:
    loginAsResponse (soap:body, use = encoded)Source code
    return type string
70. logout
    Source code
    Description:
    Logout the session identified by the given sessionKey From Codendi Server. Returns a soap fault if the sessionKey is not a valid session key.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#logout
    Input:
    logoutRequest (soap:body, use = encoded)Source code
    sessionKey type string
    Output:
    logoutResponse (soap:body, use = encoded)Source code
71. monitorDocmanItem
    Source code
    Description:
    Enables the monitoring of an item by a user

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#monitorDocmanItem
    Input:
    monitorDocmanItemRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    Output:
    monitorDocmanItemResponse (soap:body, use = encoded)Source code
    monitorDocmanItemResponse type boolean
72. moveDocmanItem
    Source code
    Description:
    Moves an item in a new folder

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    new_parent          New parent ID
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#moveDocmanItem
    Input:
    moveDocmanItemRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    new_parent type int
    Output:
    moveDocmanItemResponse (soap:body, use = encoded)Source code
    moveDocmanItemResponse type boolean
73. retrieveSession
    Source code
    Description:
    Retrieve a valid session with a given session_hash and version. Returns a soap fault if the session is not valid.
    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#retrieveSession
    Input:
    retrieveSessionRequest (soap:body, use = encoded)Source code
    session_hash type string
    Output:
    retrieveSessionResponse (soap:body, use = encoded)Source code
    return type Session

    • user_id type int
    • session_hash type string
74. searchDocmanItem
    Source code
    Description:
    Returns all the items that match given criterias

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    criterias           Criteria
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#searchDocmanItem
    Input:
    searchDocmanItemRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    criterias type ArrayOfCriteria - array of type Criteria

    • field_name type string
    • field_value type string
    • operator type string
    Output:
    searchDocmanItemResponse (soap:body, use = encoded)Source code
    searchDocmanItemResponse type ArrayOfDocman_Item - array of type Docman_Item

    • item_id type int
    • parent_id type int
    • group_id type int
    • title type string
    • description type string
    • create_date type int
    • update_date type int
    • delete_date type int
    • user_id type int
    • status type int
    • obsolescence_date type int
    • rank type int
    • item_type type int
75. updateArtifact
    Source code
    Description:
    Update the artifact $artifact_id of the tracker $group_artifact_id in the project group_id with the values given by status_id, close_date, summary, details, severity and extra_fields for the non-standard fields. Returns a soap fault if the group_id is not a valid one, if the group_artifact_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#updateArtifact
    Input:
    updateArtifactRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    status_id type int
    close_date type int
    summary type string
    details type string
    severity type int
    extra_fields type ArrayOfArtifactFieldValue - array of type ArtifactFieldValue

    • field_id type int
    • artifact_id type int
    • field_value type string
    Output:
    updateArtifactResponse (soap:body, use = encoded)Source code
    return type int
76. updateArtifactFollowUp
    Source code
    Description:
    Update the follow_up artifact_history_id of the tracker $group_artifact_id in the project group_id for the artifact $artifact_id with the new comment $comment. Returns a soap fault if the group_id is not a valid one, if the group_artifact_id is not a valid one, if the artifart_id is not a valid one, if the artifact_history_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#updateArtifact
    Input:
    updateArtifactFollowUpRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    artifact_history_id type int
    comment type string
    Output:
    updateArtifactFollowUpResponse (soap:body, use = encoded)Source code
    return type boolean
77. updateArtifactWithFieldNames
    Source code
    Description:
    Update the artifact $artifact_id of the tracker $tracker_name in the project group_id with the values given by status_id, close_date, summary, details, severity and extra_fields for the non-standard fields. Returns a soap fault if the group_id is not a valid one, if the group_artifact_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#updateArtifact
    Input:
    updateArtifactWithFieldNamesRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    group_artifact_id type int
    artifact_id type int
    status_id type int
    close_date type int
    summary type string
    details type string
    severity type int
    extra_fields type ArrayOfArtifactFieldNameValue - array of type ArtifactFieldNameValue

    • field_name type string
    • field_value type string
    Output:
    updateArtifactWithFieldNamesResponse (soap:body, use = encoded)Source code
    return type int
78. updateDocmanEmbeddedFile
    Source code
    Description:
    Updates a docman embedded file

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanEmbeddedFile
    Input:
    updateDocmanEmbeddedFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    obsolescence_date type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanEmbeddedFileResponse (soap:body, use = encoded)Source code
    updateDocmanEmbeddedFileResponse type int
79. updateDocmanEmptyDocument
    Source code
    Description:
    Updates a docman empty document

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanEmptyDocument
    Input:
    updateDocmanEmptyDocumentRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    obsolescence_date type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanEmptyDocumentResponse (soap:body, use = encoded)Source code
    updateDocmanEmptyDocumentResponse type int
80. updateDocmanFile
    Source code
    Description:
    Updates a docman file

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanFile
    Input:
    updateDocmanFileRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    obsolescence_date type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanFileResponse (soap:body, use = encoded)Source code
    updateDocmanFileResponse type int
81. updateDocmanFolder
    Source code
    Description:
    Updates a docman folder

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanFolder
    Input:
    updateDocmanFolderRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanFolderResponse (soap:body, use = encoded)Source code
    updateDocmanFolderResponse type int
82. updateDocmanLink
    Source code
    Description:
    Updates a docman link

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    content             Content
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanLink
    Input:
    updateDocmanLinkRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    obsolescence_date type string
    content type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanLinkResponse (soap:body, use = encoded)Source code
    updateDocmanLinkResponse type int
83. updateDocmanWikiPage
    Source code
    Description:
    Updates a docman wiki page

    sessionKey          Session key
    group_id            Group ID
    item_id             item ID
    title               Title
    description         Description
    status              Status (none, draft, approved, rejected)
    obsolescence_date   Obsolescence date (timestamp)
    content             Content
    permissions         Permissions
    metadata            Metadata values
    owner               Owner of the item
    create_date         Item creation date (timestamp)
    update_date         Item update date (timestamp)
    

    Style:
    rpc
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    SOAP action:
    http://147.135.128.198#updateDocmanWikiPage
    Input:
    updateDocmanWikiPageRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    item_id type int
    title type string
    description type string
    status type string
    obsolescence_date type string
    content type string
    permissions type ArrayOfPermission - array of type Permission

    • type type string
    • ugroup_id type int
    metadata type ArrayOfMetadataValue - array of type MetadataValue

    • label type string
    • value type string
    owner type string
    create_date type string
    update_date type string
    Output:
    updateDocmanWikiPageResponse (soap:body, use = encoded)Source code
    updateDocmanWikiPageResponse type int
84. updateFileComment
    Source code
    Description:
    Update the comment of a File in a release with the values given by group_id, package_id, release_id, file_id and comment. Returns boolean if the update succeed. Returns a soap fault if the group_id is not a valid one, if the package does not match with the group ID, if the release does not match with the package ID, if the file does not match with the file ID, 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#updateFileComment
    Input:
    updateFileCommentRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    file_id type int
    comment type string
    Output:
    updateFileCommentResponse (soap:body, use = encoded)Source code
    updateFileCommentResponse type boolean
85. updateRelease
    Source code
    Description:
    Updates a Release in the File Release Manager of the project group_id with the values given by package_id, release_id, name, notes, changes and status_id. Returns true if the update succeed. Returns a soap fault if the group_id is not a valid one, if the package does not match with the group ID, if the release does not exist or access to it is not permiited 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#updateRelease
    Input:
    updateReleaseRequest (soap:body, use = encoded)Source code
    sessionKey type string
    group_id type int
    package_id type int
    release_id type int
    notes type string
    changes type string
    status_id type int
    Output:
    updateReleaseResponse (soap:body, use = encoded)Source code
    updateRelease type boolean