This Confluence wiki site, maintained by DuraSpace prior to the recent merger with LYRASIS, will transition from the duraspace.org domain to the lyrasis.org domain on Saturday, Nov 16 beginning at approximately 7pm ET. A period of downtime of 2-3 hours is expected. After the transition, this wiki will be available at https://wiki.lyrasis.org/. All links to duraspace.org wiki pages will be redirected to the correct lyrasis.org URL. If you have questions prior to or following the transition please contact: wikihelp@lyrasis.org.
Page tree
Skip to end of metadata
Go to start of metadata

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

 

 

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

Methods: GET, POST, DELETE

 

GET Get a single audit entry

Query Parameters:

FORMAT   (Optional) Output format of response, possibilities TBD.

Example:

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

Response:

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

 

DELETE Delete a single audit entry

Example:

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

 

GET Get the audit history of this resource

Query Parameters:

FROM   (Optional) Restricts the audit entries to those that occur after this timestamp.

TO   (Optional) Restricts the audit entries to those that occur before this timestamp.

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

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

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

FORMAT   (Optional) Output format of response, possibilities TBD.

Example:

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.

 

POST 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:

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

 

GET Get the audit history of the repository

Query Parameters:

FROM   (Optional) Restricts the audit entries to those that occur after this timestamp.

TO   (Optional) Restricts the audit entries to those that occur before this timestamp.

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

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

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

FORMAT   (Optional) Output format of response, possibilities TBD.

Example:

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.

 

POST 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:

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

  • No labels

2 Comments

  1. I'd prefer to see, as much as possible, such a service be "plain" LDP instead of new REST endpoints. As I posted to the list, this seems more or less like a textbook example of LDPC, and I think it would be great to try to minimize departure from the existing API if we could.

    1. Are you suggesting having new audit-LDPCs that contain audit-LDPRs? or having existing repository LDPCs contain audit-LDPRs? or something else?