Versions Compared

Old Version 2

changes.mady.by.user Doron Shalvi

Saved on

compared with

New Version Current

changes.mady.by.user Andrew Woods

Saved on

Key

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

This REST API will not be implemented. The page is here an historical artifact of in-progress discussions.

 

Table of Contents

 

Excerpt

Request URI: /audit:{audit_id}, /path/to/some/resource/fcr:audit, /fcr:audit

Methods: GET, POST, DELETE

 

Status
titleGET
 Get a single audit entry

Query Parameters:

Status
subtletrue
titleformat
   (Optional) Output format of response, possibilities TBD.

Example:

Code Block
curl "http://localhost:8080/rest/audit:12345"

Response:

Returns the audit entry, including the full contents of the audit entry.

 

Status
colourRed
titleDELETE
 Delete a single audit entry

Example:

Code Block
curl -X DELETE "http://localhost:8080/rest/audit:12345"

 

Status
titleGET
 Get the audit history of this resource

Query Parameters:

Status
subtletrue
titlefrom
   (Optional) Restricts the audit entries to those that occur after this timestamp.

Status
subtletrue
titleto
   (Optional) Restricts the audit entries to those that occur before this timestamp.

Status
subtletrue
titlescope
   (Optional) Restricts the audit entries to internal or external entries. Valid values: "internal", "external".

Status
subtletrue
titleagent
   (Optional) Restricts the audit entries to those that were created by this agent. See list of agents.

Status
subtletrue
titletype
   (Optional) Restricts the audit entries to those of this type. See list of types.

Status
subtletrue
titleformat
   (Optional) Output format of response, possibilities TBD.

Example:

Code Block
curl "http://localhost:8080/rest/path/to/some/resource/fcr:audit"

Response:

Returns all audit entries that meet the specified criteria, including the full contents of the audit entries.

 

Status
colourBlue
titlePOST
 Add an external audit entry on this resource

Request Headers:

TYPE  The type of the audit entry. See list of types. Should this be optional?

DESCRIPTION  (Optional) A text description of the event.

Example:

Code Block
curl -X POST "http://localhost:8080/rest/path/to/some/resource/fcr:audit"

 

Status
titleGET
 Get the audit history of the repository

Query Parameters:

Status
subtletrue
titlefrom
   (Optional) Restricts the audit entries to those that occur after this timestamp.

Status
subtletrue
titleto
   (Optional) Restricts the audit entries to those that occur before this timestamp.

Status
subtletrue
titlescope
   (Optional) Restricts the audit entries to internal or external entries. Valid values: "internal", "external".

Status
subtletrue
titleagent
   (Optional) Restricts the audit entries to those that were created by this agent. See list of agents.

Status
subtletrue
titletype
   (Optional) Restricts the audit entries to those of this type. See list of types.

Status
subtletrue
titleformat
   (Optional) Output format of response, possibilities TBD.

Example:

Code Block
curl "http://localhost:8080/rest/fcr:audit"

Response:

Returns all audit entries that meet the specified criteria, including the full contents of the audit entries.

 

Status
colourBlue
titlePOST
 Add an external audit entry on the repository

Request Headers:

TYPE  The type of the audit entry. See list of types. Should this be optional?

DESCRIPTION  (Optional) A text description of the event.

Example:

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