Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt


Request URI: /fcr:tx; /fcr:tx/{transaction_id}

Methods: GET, POST, PUT, DELETE

Status
titleGET
 Get the current status of the repository in a transaction

Example:

Code Block
curl -i "http://localhost:8080/rest/fcr:tx/86dd0891-d975-42d8-8837-a24ad6041b59"

Response:

Code Block
Status: 204 NO CONTENT
 
Atomic-Expires: Sat, 16 Nov 2013 00:32:57 GMT


Status:

Status
subtletrue
colourGreen
title204
No Content: If the request was successful

Status
subtletrue
colourRed
title404
Not Found: Transaction doesn't exist

Status
subtletrue
colourRed
title410
Gone: Transaction expired



Status
colourBlue
titlePOST
Create a new transaction

Info

After retrieving a transaction resource, the client can execute any REST API method with the transaction resource sent in the Atomic-ID header.


Warning

Transactions are automatically closed and rolled back after 3 minutes of inactivity. Transactions can be refreshed by POSTing to /rest/fcr:tx/{tx:id}


Example:

Code Block
curl -i -X POST "http://localhost:8080/rest/fcr:tx" 

Response:

Code Block
Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/fcr:tx:/83e34464-144e-43d9-af13-b3464a1fb9b5
Expires: Sat, 16 Nov 2013 00:32:57 GMT

Usage:

When a transaction has been created, it will return a Location header.  Use this location as Atomic-ID header when performing REST API operations within the transaction.  When you are done with the transaction, either PUT to the transaction location to commit the transaction to the repository or DELETE the transaction location to discard the changes.

Code Block
curl -X POST -H"Atomic-ID: http://localhost:8080/rest/fcr:tx/83e34464-144e-43d9-af13-b3464a1fb9b5" "http://localhost:8080/rest/path/to/object/to/create"
curl -X DELETE -H"Atomic-ID: http://localhost:8080/rest/fcr:tx/83e34464-144e-43d9-af13-b3464a1fb9b5" "http://localhost:8080/rest/path/to/resource/to/delete"
curl -X PUT "http://localhost:8080/rest/fcr:tx/83e34464-144e-43d9-af13-b3464a1fb9b5"

Status:

Status
subtletrue
colourGreen
title201
  Created: if the transaction is created successfully




Status
colourBlue
titlePOST
Keep an existing transaction alive


Example:

Code Block
curl -i -X POST "http://localhost:8080/rest/fcr:tx/83e34464-144e-43d9-af13-b3464a1fb9b5" 

Response:

Code Block
Status: 204 No Content
 
Headers:
Location: http://localhost:8080/rest/tx:83e34464-144e-43d9-af13-b3464a1fb9b5
Atomic-Expires: Sat, 16 Nov 2013 03:35:43 GMT


Status:

Status
subtletrue
colourGreen
title204
  No Content: if the transaction is renewed successfully

Status
subtletrue
colourRed
title404
Not Found: Transaction doesn't exist

Status
subtletrue
colourRed
title410
Gone: Transaction expired



Status
colourBlue
titlePOST
Save and commit an open transaction


Any operations you made within the scope of the transaction will be applied together, meaning if any of them fail, the whole transaction will fail.

Example:

Code Block
curl -i -X PUT "http://localhost:8080/rest/fcr:tx/123456789" 

Response:

Code Block
Status: 204 No Content

Status:

Status
subtletrue
colourGreen
title204
 No Content: if the transaction is committed successfully

Status
subtletrue
colourRed
title404
Not Found: Transaction doesn't exist

Status
subtletrue
colourRed
title409
Conflict: Transaction did not commit successfully

Status
subtletrue
colourRed
title410
Gone: Transaction expired



Status
colourBlue
titlePOST
Rollback and close an open transaction

Example:

Code Block
curl -i -X DELETE "http://localhost:8080/rest/fcr:tx/123456789" 

Response:

Code Block
Status: 204 No Content

Status:

Status
subtletrue
colourGreen
title204
 No Content: if the transaction is discarded successfully

Status
subtletrue
colourRed
title404
Not Found: Transaction doesn't exist

Status
subtletrue
colourRed
title409
Conflict: Transaction did not commit successfully

Status
subtletrue
colourRed
title410
Gone: Transaction expired

...