/
GA
ganjoor
/
RMuseum API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 19h ago · Updated 19h ago
View markdown
ganjoor
RMuseum API
put
Set Artifact Cover Item Index (Auth policies: artifact:modify)
latest
OpenAPI 3.0.4
2026-08-14
481
162
870.6 KB
64a5b49a158a
AppUser
32
Artifact
86
get
gets specified publish artifact item info (including images + attributes)
get
get all published artifacts (including CoverImage info but not items info)
post
Add new artifact (multipart/form-data) const data = new FormData(); data.append('name', 'تست'); data.append('description', ''); data.append('srcUrl', ''); data.append('picTitle', 'تست'); data.append('picDescription', ''); data.append('file', this.file); data.append('picSrcUrl', ''); (Auth policies: artifact:add)
get
get all artifacts visible by user (including CoverImage info but not items info) (Auth)
get
/api/artifacts/tagged/{tagUrl}/{valueUrl}
get
gets specified publish artifact info (including CoverImage + images)
get
get specific artifact info with limited number of images
get
get artifact images according to start and count params
delete
remove unpublished artifact having no notes and not bookmarked (Auth policies: artifact:delete)
get
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
get
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
get
gets specified publish artifact info (including CoverImage + images) (Auth)
get
gets specified publish artifact info (including CoverImage + images) (Auth)
get
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag (Auth)
get
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag (Auth)
put
edit artifactt master record (user should have additional permissions artifact:awaiting and artifact:publish to change status of artifact) (Auth policies: artifact:modify)
put
Set Artifact Cover Item Index (Auth policies: artifact:modify)
get
get tag bundle by frindly url
get
get all tags
post
add new tag (Auth policies: tag:modify)
get
/api/artifacts/tag/{friendlyUrl}
put
edit tag (Auth policies: tag:modify)
put
changes order of tags based on their position in artifacts (Auth policies: tag:modify)
put
changes order of tags based on their position in artifact items (Auth policies: tag:modify)
get
get tag value bundle by frindly url
get
get tag value by frindly url
post
add new tag value to artifact (Auth policies: artifact:edittag)
put
edit artifact attribute value (Auth policies: artifact:edittag)
delete
remove tag from artifact (Auth policies: artifact:edittag)
post
add new tag value to item (Auth policies: artifact:edittag)
put
edit item attribute value (Auth policies: artifact:edittag)
delete
remove tag from item (Auth policies: artifact:edittag)
put
changes order of tag values based on their position in an artifact (Auth policies: artifact:edittag)
put
changes order of tag values based on their position in an item (Auth policies: artifact:edittag)
put
update an artifact item info
get
gets specified publish artifact item info (including images + attributes) (Auth)
post
import from external resources (Auth policies: artifact:import)
get
keep alive (for import background service)
post
retry import (Auth policies: artifact:import)
post
due to a bug in loc json outputs some artifacts with more than 1000 pages were downloaded incompletely (Auth policies: artifact:import)
get
(Auth policies: artifact:add)
get
artifact bookmarks info (Auth)
post
bookmark artifact (Auth)
get
item bookmarks info (Auth)
post
bookmark item (Auth)
delete
item bookmarks info (Auth)
post
fav artifact (Auth)
post
fav item (Auth)
get
user bookmarks (Auth)
get
user favorites (Auth)
post
add note for artifact (Auth)
post
add note for artifact item (Auth)
put
Edit User Notes (Auth)
delete
delete user notes (Auth)
get
get private notes for artifact (Auth)
get
get private notes for artifact
get
get private notes for artifact item (Auth)
get
get public notes for artifact item
get
user public notes (Auth)
get
user public notes (Auth)
get
all users public notes
post
report a public note (Auth)
get
Get a list of reported notes (Auth policies: note:moderate)
delete
delete a report for abuse in public user notes (Auth policies: note:moderate)
delete
delete a reported user note (accept the complaint) (Auth policies: note:moderate)
get
get suggested ganjoor links (Auth)
post
suggest ganjoor link (Auth)
delete
remove ganjoor link (Auth policies: artifact:ganjoor)
get
finds next unsynchronized suggested link with an aleady synched one from the artificat if exists, return value might be null or an array with length 1 or 2 (has paging-headers) (Auth)
put
review suggested ganjoor link (Auth policies: artifact:ganjoor)
put
mark suggested ganjoor link as synchronized (Auth policies: artifact:ganjoor)
put
toc / temporary one time api / to be removed (Auth policies: artifact:ganjoor)
get
get suggested pinterest links (Auth)
post
suggest pinterest link for ganjoor (Auth)
delete
remove pinterest link (Auth policies: artifact:ganjoor)
put
review suggested ganjoor pinterest link (Auth policies: artifact:ganjoor)
put
mark suggested pinterest ganjoor link as synchronized (Auth policies: artifact:ganjoor)
put
start filling GanjoorLink table OriginalSource values (Auth policies: artifact:ganjoor)
delete
start removing original images (Auth policies: artifact:import)
get
search artifacts
get
search artifact items
put
start setting an artifact items as a category poems text original source (Auth policies: artifact:ganjoor)
put
upload artifact to external server (Auth policies: artifact:modify)
put
create images for ganjoor (Auth policies: artifact:modify)
put
create images for ganjoor - offline (Auth policies: artifact:modify)
put
add a new item to an artifact (Auth policies: artifact:modify)
AuditLog
1
ContributionStats
4
DonationAccounting
13
ExternalFTP
3
FAQ
14
Ganjoor
208
GanjoorPoetSuggestedPhotos
7
GanjoorPoetSuggestedSpecLines
7
GeoLocation
5
Image
5
MusicCatalogue
2
Notification
10
Numbering
9
Recitation
40
RGenericOptions
8
RImage
2
RLongRunningJobs
3
Role
8
SiteBanners
5
Translation
5
UserVisitsTracking
4
Artifact
Set Artifact Cover Item Index (Auth policies: artifact:modify)
put
/api/artifacts/{id}/cover
Path parameters
id
string
uuid
required
Request body
integer
required
Response
OK