common_api

Documentation

Index

• func AlertIndex(c *gin.Context)
• func AlertShow(c *gin.Context)
• func ChecksumIndex(c *gin.Context)
• func ChecksumShow(c *gin.Context)
• func DeletionRequestIndex(c *gin.Context)
• func DeletionRequestShow(c *gin.Context)
• func GenericFileIndex(c *gin.Context)
• func GenericFileShow(c *gin.Context)
• func IntellectualObjectIndex(c *gin.Context)
• func IntellectualObjectShow(c *gin.Context)
• func PremisEventIndex(c *gin.Context)
• func PremisEventShow(c *gin.Context)
• func WorkItemIndex(c *gin.Context)
• func WorkItemShow(c *gin.Context)

Functions

func AlertIndex

func AlertIndex(c *gin.Context)

AlertIndex shows list of alerts for the logged-in user, unless that user is sys admin, who can see all alerts.

GET /member-api/v3/alerts GET /admin-api/v3/alerts

func AlertShow

func AlertShow(c *gin.Context)

AlertShow shows the AlertView with the specified id for the specified user. Note that the AlertView table contains multiple entries for each Alert ID. But each alert goes only once to each recipient, so the combination of AlertID + UserID (recipient) is unique.

GET /member-api/v3/alerts/show/:id/:user_id GET /admin-api/v3/alerts/show/:id/:user_id

func ChecksumIndex

func ChecksumIndex(c *gin.Context)

ChecksumIndex shows list of objects.

GET /member-api/v3/checksums GET /admin-api/v3/checksums

func ChecksumShow

func ChecksumShow(c *gin.Context)

ChecksumShow returns the object with the specified id.

GET /member-api/v3/checksums/show/:id GET /admin-api/v3/checksums/show/:id

func DeletionRequestIndex

func DeletionRequestIndex(c *gin.Context)

DeletionRequestIndex shows list of deletion requests.

GET /member-api/v3/deletions GET /admin-api/v3/deletions

func DeletionRequestShow

func DeletionRequestShow(c *gin.Context)

DeletionRequestShow shows the deletion request with the specified id.

Note that this shows a read-only view of the request. It does not include the Approve/Cancel buttons. This read-only view may be available to users who do not have permission to initiate, approve, or cancel deletion requests but who still need a read-only view of the requests that have been submitted.

Deletions apply to files and/or intellectual objects. The methods for initiating, approving and rejecting deletion requests are in the Generic Files Controller (for files) and the Intellectual Objects Controller (for objects).

GET /member-api/v3/deletions/show/:id

func GenericFileIndex

func GenericFileIndex(c *gin.Context)

GenericFileIndex shows list of files. Unlike the admin API, the member API version returns a list of GenericFileView objects.

GET /member-api/v3/files

func GenericFileShow

func GenericFileShow(c *gin.Context)

GenericFileShow returns the object with the specified id.

GET /member-api/v3/files/show/:id GET /admin-api/v3/files/show/:id

func IntellectualObjectIndex

func IntellectualObjectIndex(c *gin.Context)

IntellectualObjectIndex shows list of objects.

GET /member-api/v3/objects GET /admin-api/v3/objects

func IntellectualObjectShow

func IntellectualObjectShow(c *gin.Context)

IntellectualObjectShow returns the object with the specified id.

GET /member-api/v3/objects/show/:id GET /admin-api/v3/objects/show/:id

func PremisEventIndex

func PremisEventIndex(c *gin.Context)

PremisEventIndex shows list of objects.

GET /member-api/v3/events GET /admin-api/v3/events

func PremisEventShow

func PremisEventShow(c *gin.Context)

PremisEventShow returns the object with the specified id.

GET /member-api/v3/events/show/:id GET /admin-api/v3/events/show/:id

func WorkItemIndex

func WorkItemIndex(c *gin.Context)

WorkItemIndex shows list of objects.

GET /member-api/v3/items GET /admin-api/v3/items

func WorkItemShow

func WorkItemShow(c *gin.Context)

WorkItemShow returns the object with the specified id.

GET /member-api/v3/items/show/:id GET /admin-api/v3/items/show/:id