Versions Compared

Key

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

Request URI: /fcr:tx; /tx:{transaction_id}/path/to/resource, /tx:{transaction_id}/fcr:tx, /tx:{transaction_id}/fcr:commit, /tx:{transaction_id}/fcr:rollback

Methods: GET, POST

 

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

...

Status
subtletrue
colourGreen
title200
OK: If the request was successful

Status
subtletrue
colourRed
title410
Gone: Transaction not found


...

Status
colourBlue
titlePOST
Create a new transaction (or keep an existing transaction alive)

Info

After retrieving a transaction resource, the client can execute any REST API method prefixed by the transaction location.

...

Code Block
Status: 201 Created
 
Headers:
Location: http://localhost:8080/rest/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 the base URL for performing REST API operations within the transaction.  When you are done with the transaction, either append "/fcr:tx/fcr:commit" to commit the transaction to the repository or "/fcr:tx/fcr:rollback" to discard the changes.

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

...

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

 

...


Status
colourBlue
titlePOST
Keep an existing transaction alive

 

Example:

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

Response:

Code Block
Status: 204 No Content
 
Headers:
Location: http://localhost:8080/rest/tx:83e34464-144e-43d9-af13-b3464a1fb9b5
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
title410
  Gone: if the transaction doesn't exist

 

...

 

Status
colourBlue
titlePOST
 Save and commit an open transaction.

...

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

Status
subtletrue
colourRed
title410
Gone: if the transaction doesn't exist

 

...

 

 

Status
colourBlue
titlePOST
 Rollback and close an open transaction

...

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

Status
subtletrue
colourRed
title410
Gone: if the transaction doesn't exist