Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AccountFavouriteResource
  • /accountfavourites/{userId}
  • /accountfavourites/{userId}/prepare
  • GET
  • POST
AccountFolderResource
  • /accountfolders
  • /accountfolders/{accountFolderId}/prepare
  • GET
  • POST
AgreementResource
  • /agreements
  • /agreements/{agreementId}
  • GET POST
  • DELETE PUT
AgreementSocietyRelationshipResource
  • /agreementsocietyrelationships
  • /agreementsocietyrelationships/{agreementSocietyRelationshipId}
  • GET POST
  • DELETE PUT
AlbumHierarchyNodeRelationshipResource
  • /albumhierarchynoderelationships/{albumHierarchyNodeRelationshipId}/prepare
  • POST
AlbumResource
  • /albums
  • /albums/{albumId}
  • /albums/{albumId}/prepare
  • GET POST
  • DELETE PUT
  • POST
AudioFileResource
  • /audiofiles
  • /audiofiles/{audioFileId}
  • POST
  • DELETE PUT
BroadcasterResource
  • /broadcasters
  • /broadcasters/{broadcasterId}
  • GET POST
  • DELETE PUT
BroadcasterTerritoryRelationshipResource
  • /broadcasterterritoryrelationships
  • /broadcasterterritoryrelationships/{broadcasterTerritoryRelationshipId}
  • GET POST
  • DELETE PUT
DocumentResource
  • /documents
  • /documents/{handle}
  • GET POST
  • GET
GenreResource
  • /genres
  • /genres/{genreId}
  • GET POST
  • DELETE PUT
HierarchyNodeResource
  • /hierarchynodes
  • /hierarchynodes/{hierarchyNodeId}/prepare
  • GET
  • POST
ImportableBatchResource
  • /importablebatches
  • /importablebatches/{importableBatchId}
  • /importablebatches/{importableBatchId}/events
  • GET POST
  • DELETE PUT
  • GET POST
ImportableFileResource
  • /importablefiles
  • /importablefiles/{importableFileId}
  • GET POST
  • DELETE
ImportableTrackResource
  • /importabletracks
  • /importabletracks/{importableTrackId}
  • GET POST
  • DELETE
KeywordResource
  • /keywords
  • /keywords/{keywordId}
  • GET POST
  • DELETE PUT
LibraryOwnerResource
  • /libraryowners
  • /libraryowners/{libraryOwnerId}
  • GET POST
  • DELETE PUT
LibraryResource
  • /libraries
  • /libraries/{libraryId}
  • GET POST
  • DELETE PUT
LongRunningTaskResource
  • /tasks
  • /tasks/{taskId}
  • GET POST
  • GET
MediaTypeBroadcasterRelationshipResource
  • /mediatypebroadcasterrelationships
  • /mediatypebroadcasterrelationships/{mediaTypeBroadcasterRelationshipId}
  • /mediatypebroadcasterrelationships/{mediaTypebroadcasterRelationshipId}
  • GET POST
  • DELETE
  • PUT
MediaTypeResource
  • /mediatypes
  • /mediatypes/{mediaTypeId}
  • GET POST
  • DELETE PUT
NotificationResource
  • /notifications
  • POST
OriginalPublisherLibraryRelationshipResource
  • /originalpublisherlibraryrelationships
  • /originalpublisherlibraryrelationships/{originalPublisherLibraryRelationshipId}
  • GET POST
  • DELETE PUT
OriginalPublisherResource
  • /originalpublishers
  • /originalpublishers/{originalPublisherId}
  • GET POST
  • DELETE PUT
PreparedDownloadResource
  • /prepareddownloads/{id}
  • /prepareddownloads/{id}/{partId}
  • GET
  • GET
SearchResource
  • /search/autocomplete
  • /search/health
  • /search/suggestions
  • GET
  • GET
  • GET
ShareResource
  • /shares
  • /shares/{oldShareIds}
  • /shares/{shareIds}
  • GET POST
  • PUT
  • DELETE
SocietyResource
  • /societies
  • /societies/{societyId}
  • GET POST
  • DELETE PUT
StakeholderResource
  • /stakeholders
  • /stakeholders/{stakeholderId}
  • GET POST
  • DELETE PUT
StakeholderSocietyRelationshipResource
  • /stakeholdersocietyrelationships
  • /stakeholdersocietyrelationships/{stakeholderSocietyRelationshipId}
  • GET POST
  • DELETE PUT
StatisticsResource
  • /statistics/onlineuseractivity
  • /statistics/stakeholder
  • /statistics/timeline
  • GET
  • GET
  • GET
SubPublisherResource
  • /subpublishers
  • /subpublishers/{subPublisherId}
  • GET POST
  • DELETE PUT
TaggingTaskResource
  • /taggingtasks
  • /taggingtasks/{taggingTaskId}
  • GET POST
  • DELETE PUT
TeaPot
  • /teapot/task
  • POST
TerritoryResource
  • /territories
  • /territories/{territoryId}
  • GET POST
  • DELETE PUT
TrackAgreementRelationshipResource
  • /trackagreementrelationships
  • /trackagreementrelationships/{oldTrackAgreementRelationshipIds}
  • /trackagreementrelationships/{trackAgreementRelationshipIds}
  • GET POST
  • PUT
  • DELETE
TrackGenreRelationshipResource
  • /trackgenrerelationships
  • /trackgenrerelationships/{trackGenreRelationshipIds}
  • /trackgenrerelationships/{trackGenreRelationshipId}
  • GET POST
  • DELETE
  • PUT
TrackKeywordRelationshipResource
  • /trackkeywordrelationships
  • /trackkeywordrelationships/{trackKeywordRelationshipIds}
  • /trackkeywordrelationships/{trackKeywordRelationshipId}
  • GET POST
  • DELETE
  • PUT
TrackResource
  • /tracks
  • /tracks/search
  • /tracks/{trackId}
  • /tracks/{trackId}/download
  • /tracks/{trackId}/stream
  • /tracks/{trackId}/streamed
  • /tracks/{trackId}/waveform
  • GET POST
  • GET
  • DELETE PUT
  • GET
  • GET
  • PUT
  • GET
UserResource
  • /users
  • /users/{userId}
  • /users/{userId}/password
  • GET POST
  • DELETE PUT
  • PUT