topic Re: Trying to check out Doc with Rest api in Alfresco Archive

Trying to check out Doc with Rest api

erictice — Mon, 08 Jun 2009 20:59:32 GMT

Alright, I am using the following to check out a file from the api. It returns the atom/xml but doesn't checkout the doc. GetMethod method = new GetMethod( "http://<hostname>:<port>/alfresco/service/api/node/workspace/SpacesStore/48bd0658-1261-4b0a-a74c-3d57b8094208/checkedout")

Re: Trying to check out Doc with Rest api

openpj — Mon, 08 Jun 2009 21:56:35 GMT

If you would like to use Web Services API you must invoke any WS API call with the right SOAP Header in the request.
Here you can see all the informations you need about SOAP Headers.

If you are developing in Java language, maybe you could try to use the Alfresco Web Service Client, this is the Web Service Java stub precompilated from Alfresco and you can download it here (here for Alfresco Labs project).
Using this client you don't need to create SOAP Headers but you need only to use the Content Manipulation Language (CML) to invoke your queries on the repository.

Hope this helps.

Re: Trying to check out Doc with Rest api

erictice — Tue, 09 Jun 2009 13:45:53 GMT

I am trying to use the REST version not the SOAP version. But the documentation only says to do the following:

POST /alfresco/service/api/checkedout

Obviously you need to supply the id of the document you wish to checkout, so based on the format of other calls, it was reasonable to assume that the url would be

http://<hostname>:<port>/alfresco/service/api/node/workspace/SpacesStore/<id>/checkedout

This will return an atom-xml with some information and doesn't fail, but it does say that checkout is false and it was not checked out. So the question is, what is the proper url for the REST call? Is there an additional parameter that needs to be passed in?

Thank you

Re: Trying to check out Doc with Rest api

mrogers — Tue, 09 Jun 2009 14:06:44 GMT

Here's the script definition.

Create a private working copy of the object, copies the metadata and optionally content. It is up to the repository to determine if updates to the current version (not PWC) and prior versions are allowed if checked-out. 
 
Inputs: 
 
ID documentId: ObjectID of Doc Version to checkout 
 
Outputs: 
 
ID documentId: ObjectID of Private Working Copy 
Bool contentCopied 
 
Notes: 
 
It is repository-specific to determine the scope of visibility to the private working copy. 
Other users not in the scope of checkout will see the public (pre-checkout) version while those in scope will be able to work on the checked-out version. 
Copying content on checkout or not is repository-specific. 
CheckOut() may remove update permission on prior versions. 
CheckOut() on a non-document object will throw OperationNotSupportedException. 
Some repositories may not support updating of private working copies and the updates MUST be supplied via checkIn().

Re: Trying to check out Doc with Rest api

erictice — Tue, 09 Jun 2009 14:13:31 GMT

Yes, but then it has below that:

POST /alfresco/service/api/checkedout

Requirements:

    * Default Format: atomentry
    * Authentication: user
    * Transaction: required
    * Format Style: any

Definition:

    * Id: org/alfresco/repository/store/checkedout.post
    * Description: classpath:alfresco/templates/webscripts/org/alfresco/repository/store/checkedout.post.desc.xml

Re: Trying to check out Doc with Rest api

mrogers — Tue, 09 Jun 2009 15:07:15 GMT

Have you tried posting some atom to this script? Looking at the code, i'm fairly sure that you do not specify the ID on the URL.

And the code you started with is doing a GET not a POST.

Re: Trying to check out Doc with Rest api

erictice — Tue, 09 Jun 2009 15:28:19 GMT

I switched to a post and I am told with that URL that the Post method is not supported, even though the scripts exist for it.