Only projects where Document Management is enabled have permission to access the managed document methods.

The managed document methods allow you to check-in or check-out a document, lock or unlock a document, or add a reservation. The add reservation method always adds the specified user to the end of the list. You can also remove or move a reservation.

The current logged-in user is assumed to be the user who is requesting the document function in most cases. For example, the Check-out Document method checks-out the document for the current logged-in user. A user with project administrator privileges can remove reservations for other users, and check-in a checked-out document for anyone.

The standard XML and JSON representations of a managed document is shown below. These are returned by all of the methods described below.

When a document is checked-out or reserved, the DocMgmtUserID and DocMgmtUserName will be included. These fields identify the user who has the document checked-out, or the first person on the reservation list. The Reservations section lists the users in the reservation queue in the order of their position, the first being the top of the list.

<Document DocumentID="3" Name="contract.doc">
    <ProjectID>1234</ProjectID>
    <ItemID>82</ItemID>
    <AddedBy>CDA</AddedBy>
    <CreatedOn>2008-02-25</CreatedOn>
    <Size>492</Size>
    <DocMgmtStatus>0</DocMgmtStatus>
    <DocMgmtStatusDesc>Checked-out</DocMgmtStatusDesc>
    <DocMgmtUserID>15922</DocMgmtUserID>
    <DocMgmtUserName>Catherine Marten</DocMgmtUserName>
    <Reservations>
        <UserID>15847</UserID>
        <UserID>15922</UserID>
    </Reservations>
</Document>

• Check-out
• Check-in
• Remove Check-out

• Add Reservation
• Remove Reservation
• Move Reservation

• Lock
• Unlock