api

Datasets

class Datasets extends ApiController

Dataset API.

Annotations
@Singleton()
Linear Supertypes
ApiController, Controller, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, BodyParsers, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Datasets
  2. ApiController
  3. Controller
  4. Rendering
  5. RequestExtractors
  6. AcceptExtractors
  7. ContentTypes
  8. HeaderNames
  9. Status
  10. HttpProtocol
  11. BodyParsers
  12. Results
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Datasets(datasets: DatasetService, files: FileService, collections: CollectionService, sections: SectionService, comments: CommentService, previews: PreviewService, extractions: ExtractionService, metadataService: MetadataService, contextService: ContextLDService, rdfsparql: RdfSPARQLService, events: EventService, spaces: SpaceService, folders: FolderService, relations: RelationService, userService: UserService, thumbnailService: ThumbnailService, appConfig: AppConfigurationService, esqueue: ElasticsearchQueue)

    Annotations
    @Inject()

Type Members

  1. class Status extends SimpleResult

    Definition Classes
    Results
  2. class TagCheck extends AnyRef

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val ACCEPT: String

    Definition Classes
    HeaderNames
  7. val ACCEPTED: Int

    Definition Classes
    Status
  8. val ACCEPT_CHARSET: String

    Definition Classes
    HeaderNames
  9. val ACCEPT_ENCODING: String

    Definition Classes
    HeaderNames
  10. val ACCEPT_LANGUAGE: String

    Definition Classes
    HeaderNames
  11. val ACCEPT_RANGES: String

    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_ALLOW_METHODS: String

    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_MAX_AGE: String

    Definition Classes
    HeaderNames
  18. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Definition Classes
    HeaderNames
  19. val ACCESS_CONTROL_REQUEST_METHOD: String

    Definition Classes
    HeaderNames
  20. val AGE: String

    Definition Classes
    HeaderNames
  21. val ALLOW: String

    Definition Classes
    HeaderNames
  22. val AUTHORIZATION: String

    Definition Classes
    HeaderNames
  23. val Accepted: Status

    Definition Classes
    Results
  24. def AuthenticatedAction: ActionBuilder[UserRequest]

    call code iff user is logged in

    call code iff user is logged in

    Definition Classes
    ApiController
  25. val BAD_GATEWAY: Int

    Definition Classes
    Status
  26. val BAD_REQUEST: Int

    Definition Classes
    Status
  27. val BINARY: String

    Definition Classes
    ContentTypes
  28. val BadGateway: Status

    Definition Classes
    Results
  29. val BadRequest: Status

    Definition Classes
    Results
  30. val CACHE_CONTROL: String

    Definition Classes
    HeaderNames
  31. val CHUNKED: String

    Definition Classes
    HttpProtocol
  32. val CONFLICT: Int

    Definition Classes
    Status
  33. val CONNECTION: String

    Definition Classes
    HeaderNames
  34. val CONTENT_DISPOSITION: String

    Definition Classes
    HeaderNames
  35. val CONTENT_ENCODING: String

    Definition Classes
    HeaderNames
  36. val CONTENT_LANGUAGE: String

    Definition Classes
    HeaderNames
  37. val CONTENT_LENGTH: String

    Definition Classes
    HeaderNames
  38. val CONTENT_LOCATION: String

    Definition Classes
    HeaderNames
  39. val CONTENT_MD5: String

    Definition Classes
    HeaderNames
  40. val CONTENT_RANGE: String

    Definition Classes
    HeaderNames
  41. val CONTENT_TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  42. val CONTENT_TYPE: String

    Definition Classes
    HeaderNames
  43. val CONTINUE: Int

    Definition Classes
    Status
  44. val COOKIE: String

    Definition Classes
    HeaderNames
  45. val CREATED: Int

    Definition Classes
    Status
  46. def CSS(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  47. val Conflict: Status

    Definition Classes
    Results
  48. val Created: Status

    Definition Classes
    Results
  49. val DATE: String

    Definition Classes
    HeaderNames
  50. def DisabledAction: ActionBuilder[UserRequest]

    Disable a route without having to comment out the entry in the routes file.

    Disable a route without having to comment out the entry in the routes file. Useful for when we want to keep the code around but we don't want users to have access to it.

    Definition Classes
    ApiController
  51. val ETAG: String

    Definition Classes
    HeaderNames
  52. def EVENT_STREAM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  53. val EXPECT: String

    Definition Classes
    HeaderNames
  54. val EXPECTATION_FAILED: Int

    Definition Classes
    Status
  55. val EXPIRES: String

    Definition Classes
    HeaderNames
  56. val EntityTooLarge: Status

    Definition Classes
    Results
  57. val ExpectationFailed: Status

    Definition Classes
    Results
  58. val FAILED_DEPENDENCY: Int

    Definition Classes
    Status
  59. val FORBIDDEN: Int

    Definition Classes
    Status
  60. def FORM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  61. val FOUND: Int

    Definition Classes
    Status
  62. val FROM: String

    Definition Classes
    HeaderNames
  63. val FailedDependency: Status

    Definition Classes
    Results
  64. val Forbidden: Status

    Definition Classes
    Results
  65. def Found(url: String): SimpleResult

    Definition Classes
    Results
  66. val GATEWAY_TIMEOUT: Int

    Definition Classes
    Status
  67. val GONE: Int

    Definition Classes
    Status
  68. val GatewayTimeout: Status

    Definition Classes
    Results
  69. val Gone: Status

    Definition Classes
    Results
  70. val HOST: String

    Definition Classes
    HeaderNames
  71. def HTML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  72. val HTTP_1_0: String

    Definition Classes
    HttpProtocol
  73. val HTTP_1_1: String

    Definition Classes
    HttpProtocol
  74. val HTTP_VERSION_NOT_SUPPORTED: Int

    Definition Classes
    Status
  75. val HttpVersionNotSupported: Status

    Definition Classes
    Results
  76. val IF_MATCH: String

    Definition Classes
    HeaderNames
  77. val IF_MODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  78. val IF_NONE_MATCH: String

    Definition Classes
    HeaderNames
  79. val IF_RANGE: String

    Definition Classes
    HeaderNames
  80. val IF_UNMODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  81. val INSUFFICIENT_STORAGE: Int

    Definition Classes
    Status
  82. val INTERNAL_SERVER_ERROR: Int

    Definition Classes
    Status
  83. val InsufficientStorage: Status

    Definition Classes
    Results
  84. val InternalServerError: Status

    Definition Classes
    Results
  85. def JAVASCRIPT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  86. def JSON(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  87. val LAST_MODIFIED: String

    Definition Classes
    HeaderNames
  88. val LENGTH_REQUIRED: Int

    Definition Classes
    Status
  89. val LOCATION: String

    Definition Classes
    HeaderNames
  90. val LOCKED: Int

    Definition Classes
    Status
  91. val Locked: Status

    Definition Classes
    Results
  92. val MAX_FORWARDS: String

    Definition Classes
    HeaderNames
  93. val METHOD_NOT_ALLOWED: Int

    Definition Classes
    Status
  94. val MOVED_PERMANENTLY: Int

    Definition Classes
    Status
  95. val MULTIPLE_CHOICES: Int

    Definition Classes
    Status
  96. val MULTI_STATUS: Int

    Definition Classes
    Status
  97. val MethodNotAllowed: Status

    Definition Classes
    Results
  98. def MovedPermanently(url: String): SimpleResult

    Definition Classes
    Results
  99. val MultiStatus: Status

    Definition Classes
    Results
  100. val NON_AUTHORITATIVE_INFORMATION: Int

    Definition Classes
    Status
  101. val NOT_ACCEPTABLE: Int

    Definition Classes
    Status
  102. val NOT_FOUND: Int

    Definition Classes
    Status
  103. val NOT_IMPLEMENTED: Int

    Definition Classes
    Status
  104. val NOT_MODIFIED: Int

    Definition Classes
    Status
  105. val NO_CONTENT: Int

    Definition Classes
    Status
  106. val NoContent: SimpleResult

    Definition Classes
    Results
  107. val NonAuthoritativeInformation: Status

    Definition Classes
    Results
  108. val NotAcceptable: Status

    Definition Classes
    Results
  109. val NotFound: Status

    Definition Classes
    Results
  110. val NotImplemented: Status

    Definition Classes
    Results
  111. val NotModified: SimpleResult

    Definition Classes
    Results
  112. val OK: Int

    Definition Classes
    Status
  113. val ORIGIN: String

    Definition Classes
    HeaderNames
  114. val Ok: Status

    Definition Classes
    Results
  115. val PARTIAL_CONTENT: Int

    Definition Classes
    Status
  116. val PAYMENT_REQUIRED: Int

    Definition Classes
    Status
  117. val PRAGMA: String

    Definition Classes
    HeaderNames
  118. val PRECONDITION_FAILED: Int

    Definition Classes
    Status
  119. val PROXY_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  120. val PROXY_AUTHENTICATION_REQUIRED: Int

    Definition Classes
    Status
  121. val PROXY_AUTHORIZATION: String

    Definition Classes
    HeaderNames
  122. val PartialContent: Status

    Definition Classes
    Results
  123. def PermissionAction(permission: Permission, resourceRef: Option[ResourceRef] = None, affectedResource: Option[ResourceRef] = None): ActionBuilder[UserRequest]

    call code iff user has right permission for resource

    call code iff user has right permission for resource

    Definition Classes
    ApiController
  124. val PreconditionFailed: Status

    Definition Classes
    Results
  125. def PrivateServerAction: ActionBuilder[UserRequest]

    Use when you want to require the user to be logged in on a private server or the server is public.

    Use when you want to require the user to be logged in on a private server or the server is public.

    Definition Classes
    ApiController
  126. val RANGE: String

    Definition Classes
    HeaderNames
  127. val REFERER: String

    Definition Classes
    HeaderNames
  128. val REQUESTED_RANGE_NOT_SATISFIABLE: Int

    Definition Classes
    Status
  129. val REQUEST_ENTITY_TOO_LARGE: Int

    Definition Classes
    Status
  130. val REQUEST_TIMEOUT: Int

    Definition Classes
    Status
  131. val REQUEST_URI_TOO_LONG: Int

    Definition Classes
    Status
  132. val RESET_CONTENT: Int

    Definition Classes
    Status
  133. val RETRY_AFTER: String

    Definition Classes
    HeaderNames
  134. def Redirect(call: Call): SimpleResult

    Definition Classes
    Results
  135. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): SimpleResult

    Definition Classes
    Results
  136. def Redirect(url: String, status: Int): SimpleResult

    Definition Classes
    Results
  137. val RequestTimeout: Status

    Definition Classes
    Results
  138. val ResetContent: SimpleResult

    Definition Classes
    Results
  139. val SEE_OTHER: Int

    Definition Classes
    Status
  140. val SERVER: String

    Definition Classes
    HeaderNames
  141. val SERVICE_UNAVAILABLE: Int

    Definition Classes
    Status
  142. val SET_COOKIE: String

    Definition Classes
    HeaderNames
  143. val SET_COOKIE2: String

    Definition Classes
    HeaderNames
  144. val SWITCHING_PROTOCOLS: Int

    Definition Classes
    Status
  145. def SeeOther(url: String): SimpleResult

    Definition Classes
    Results
  146. def ServerAdminAction: ActionBuilder[UserRequest]

    call code iff user is a server admin

    call code iff user is a server admin

    Definition Classes
    ApiController
  147. val ServiceUnavailable: Status

    Definition Classes
    Results
  148. def Status(code: Int): Status

    Definition Classes
    Results
  149. val TE: String

    Definition Classes
    HeaderNames
  150. val TEMPORARY_REDIRECT: Int

    Definition Classes
    Status
  151. def TEXT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  152. val TODO: Action[AnyContent]

    Definition Classes
    Controller
  153. val TOO_MANY_REQUEST: Int

    Definition Classes
    Status
  154. val TRAILER: String

    Definition Classes
    HeaderNames
  155. val TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  156. def TemporaryRedirect(url: String): SimpleResult

    Definition Classes
    Results
  157. val TooManyRequest: Status

    Definition Classes
    Results
  158. val UNAUTHORIZED: Int

    Definition Classes
    Status
  159. val UNPROCESSABLE_ENTITY: Int

    Definition Classes
    Status
  160. val UNSUPPORTED_MEDIA_TYPE: Int

    Definition Classes
    Status
  161. val UPGRADE: String

    Definition Classes
    HeaderNames
  162. val USERID_ANONYMOUS: String

  163. val USER_AGENT: String

    Definition Classes
    HeaderNames
  164. val USE_PROXY: Int

    Definition Classes
    Status
  165. val Unauthorized: Status

    Definition Classes
    Results
  166. val UnprocessableEntity: Status

    Definition Classes
    Results
  167. val UnsupportedMediaType: Status

    Definition Classes
    Results
  168. val UriTooLong: Status

    Definition Classes
    Results
  169. def UserAction(needActive: Boolean): ActionBuilder[UserRequest]

    get user if logged in

    get user if logged in

    Definition Classes
    ApiController
  170. val VARY: String

    Definition Classes
    HeaderNames
  171. val VIA: String

    Definition Classes
    HeaderNames
  172. val WARNING: String

    Definition Classes
    HeaderNames
  173. val WWW_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  174. def XML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  175. val X_FORWARDED_FOR: String

    Definition Classes
    HeaderNames
  176. val X_FORWARDED_HOST: String

    Definition Classes
    HeaderNames
  177. val X_FORWARDED_PORT: String

    Definition Classes
    HeaderNames
  178. val X_FORWARDED_PROTO: String

    Definition Classes
    HeaderNames
  179. def addCreator(id: UUID): Action[JsValue]

  180. def addFileEvent(id: UUID, inFolder: Boolean, fileCount: Int): Action[AnyContent]

  181. def addMetadata(id: UUID): Action[JsValue]

  182. def addMetadataJsonLD(id: UUID): Action[JsValue]

    Add metadata in JSON-LD format.

  183. def addTags(id: UUID): Action[JsValue]

    REST endpoint: POST: Add tags to a dataset.

    REST endpoint: POST: Add tags to a dataset. Requires that the request body contains a "tags" field of List[String] type.

  184. def addTagsHelper(obj_type: TagCheckObjType, id: UUID, request: UserRequest[JsValue]): SimpleResult

  185. def addUserMetadata(id: UUID): Action[JsValue]

  186. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  187. def attachExistingFile(dsId: UUID, fileId: UUID): Action[AnyContent]

  188. def attachExistingFileHelper(dsId: UUID, fileId: UUID, dataset: Dataset, file: File, user: Option[User]): Unit

    Functionality broken out from attachExistingFile, in order to allow the core work of file attachment to be called from multiple API endpoints.

    Functionality broken out from attachExistingFile, in order to allow the core work of file attachment to be called from multiple API endpoints.

    dsId

    A UUID that specifies the dataset that will be modified

    fileId

    A UUID that specifies the file to attach to the dataset

    dataset

    Reference to the model of the dataset that is specified

    file

    Reference to the model of the file that is specified

  189. def attachMultipleFiles(): Action[JsValue]

    Create new dataset with no file required.

    Create new dataset with no file required. However if there are comma separated file IDs passed in, add all of those as existing files. This is to facilitate multi-file-uploader usage for new files, as well as to allow multiple existing files to be added as part of dataset creation.

    A JSON document is the payload for this endpoint. Required elements are name and description. Optional element is existingfiles, which will be a comma separated String of existing file IDs to be added to the new dataset.

  190. def checkErrorsForTag(obj_type: TagCheckObjType, id: UUID, request: UserRequest[JsValue]): TagCheck

  191. def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]]): Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  192. def chunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  193. def clearOldDatasetsTrash(days: Int): Action[AnyContent]

  194. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  195. def comment(id: UUID): Action[JsValue]

  196. def copyDatasetToSpace(datasetId: UUID, spaceId: UUID): Action[AnyContent]

  197. def createDataset(): Action[JsValue]

    Create new dataset.

    Create new dataset. name, file_id are required, description and space, are optional. If the space & file_id is wrong, refuse the request

  198. def createEmptyDataset(): Action[JsValue]

    Create new dataset with no file required.

    Create new dataset with no file required. However if there are comma separated file IDs passed in, add all of those as existing files. This is to facilitate multi-file-uploader usage for new files, as well as to allow multiple existing files to be added as part of dataset creation.

    A JSON document is the payload for this endpoint. Required elements are name, description, and space. Optional element is existingfiles, which will be a comma separated String of existing file IDs to be added to the new dataset.

  199. def datasetAllFilesList(id: UUID, max: Int = 1): Action[AnyContent]

    List all files withing a dataset and its nested folders.

    List all files withing a dataset and its nested folders.

    id

    dataset id

    max

    max number of files to return, default is

    returns

  200. def datasetFilesGetIdByDatasetAndFilename(datasetId: UUID, filename: String): Option[String]

  201. def datasetFilesList(id: UUID, count: Boolean = false): Action[AnyContent]

  202. def dechunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  203. def deleteDataset(id: UUID): Action[AnyContent]

  204. def deleteDatasetHelper(id: UUID, request: UserRequest[AnyContent]): SimpleResult

    Utility function to consolidate the utility portions of the delete dataset functionality so that it can be easily called from multiple API operations.

    Utility function to consolidate the utility portions of the delete dataset functionality so that it can be easily called from multiple API operations.

    id

    The id of the dataset that a file is being detached from

    request

    The implicit request parameter which is part of the REST API call

  205. def detachAndDeleteDataset(id: UUID): Action[AnyContent]

    REST endpoint: DELETE: detach all files from a dataset and then delete the dataset

    REST endpoint: DELETE: detach all files from a dataset and then delete the dataset

    Takes one arg, id:

  206. def detachFile(datasetId: UUID, fileId: UUID, ignoreNotFound: String): Action[AnyContent]

  207. def detachFileHelper(datasetId: UUID, fileId: UUID, dataset: Dataset, user: Option[User]): SimpleResult

    Utility function to consolidate the utility portions of the detach file functionality so that it can be easily called from multiple API operations.

    Utility function to consolidate the utility portions of the detach file functionality so that it can be easily called from multiple API operations.

    datasetId

    The id of the dataset that a file is being detached from

    fileId

    The id of the file to detach from the dataset

    dataset

    The reference to the model of the dataset being operated on

  208. def download(id: UUID, compression: Int, tracking: Boolean): Action[AnyContent]

  209. def dumpDatasetGroupings: Action[AnyContent]

  210. def dumpDatasetsMetadata: Action[AnyContent]

  211. def emptyTrash(): Action[AnyContent]

  212. def enumeratorFromDataset(dataset: Dataset, chunkSize: Int = 1024 * 8, compression: Int = Deflater.DEFAULT_COMPRESSION, bagit: Boolean, user: Option[User])(implicit ec: ExecutionContext): Enumerator[Array[Byte]]

    Enumerator to loop over all files in a dataset and return chunks for the result zip file that will be streamed to the client.

    Enumerator to loop over all files in a dataset and return chunks for the result zip file that will be streamed to the client. The zip files are streamed and not stored on disk.

    dataset

    dataset from which to get teh files

    chunkSize

    chunk size in memory in which to buffer the stream

    compression

    java built in compression value. Use 0 for no compression.

    returns

    Enumerator to produce array of bytes from a zipped stream containing the bytes of each file in the dataset

  213. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  214. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  215. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  216. implicit def flash(implicit request: RequestHeader): Flash

    Definition Classes
    Controller
  217. def follow(id: UUID): Action[AnyContent]

  218. def get(id: UUID): Action[AnyContent]

  219. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  220. def getMetadataDefinitions(id: UUID, currentSpace: Option[String]): Action[AnyContent]

  221. def getMetadataJsonLD(id: UUID, extFilter: Option[String]): Action[AnyContent]

  222. def getPreviews(id: UUID): Action[AnyContent]

  223. def getRDFURLsForDataset(id: UUID): Action[AnyContent]

  224. def getRDFUserMetadata(id: UUID, mappingNumber: String = "1"): Action[AnyContent]

  225. def getTags(id: UUID): Action[AnyContent]

    REST endpoint: GET: get the tag data associated with this section.

    REST endpoint: GET: get the tag data associated with this section. Returns a JSON object of multiple fields. One returned field is "tags", containing a list of string values.

  226. def getTechnicalMetadataJSON(id: UUID): Action[AnyContent]

  227. def getTopRecommendations(followeeUUID: UUID, follower: User): List[MiniEntity]

  228. def getUser[A](request: Request[A]): UserRequest[A]

    Return user based on request object

    Return user based on request object

    Definition Classes
    ApiController
  229. def getUserMetadataJSON(id: UUID): Action[AnyContent]

  230. def getXMLMetadataJSON(id: UUID): Action[AnyContent]

  231. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  232. def isBeingProcessed(id: UUID): Action[AnyContent]

    Return whether a dataset is currently being processed.

  233. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  234. def jsonFile(file: File, serverAdmin: Boolean = false): JsValue

  235. def jsonPreview(pvId: String, pId: String, pPath: String, pMain: String, pvRoute: String, pvContentType: String, pvLength: Long): JsValue

  236. def jsonPreviews(prvFile: File, prvs: List[(String, String, String, String, String, String, Long)]): JsValue

  237. def jsonPreviewsFiles(filesList: List[(File, List[(String, String, String, String, String, String, Long)])]): JsValue

  238. def jsonToXML(theJSON: String): File

  239. implicit def lang(implicit request: RequestHeader): Lang

    Definition Classes
    Controller
  240. def list(title: Option[String], date: Option[String], limit: Int, exact: Boolean): Action[AnyContent]

  241. def listCanEdit(title: Option[String], date: Option[String], limit: Int, exact: Boolean): Action[AnyContent]

  242. def listDatasetsInTrash(limit: Int): Action[AnyContent]

  243. def listFilesInFolder(fileids: List[UUID], folderids: List[UUID], parent: String, filenameMap: Map[UUID, String], inputFiles: ListBuffer[File]): Unit

    Create a mapping for each file to their unique location

  244. def listInCollection(collectionId: UUID): Action[AnyContent]

  245. def listMoveFileToDataset(file_id: UUID, title: Option[String], limit: Int, exact: Boolean): Action[AnyContent]

  246. def listOutsideCollection(collectionId: UUID): Action[AnyContent]

    List all datasets outside a collection.

  247. def moveCreator(id: UUID, creator: String, newPos: Int): Action[AnyContent]

  248. def moveFileBetweenDatasets(datasetId: UUID, toDatasetId: UUID, fileId: UUID): Action[AnyContent]

  249. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  250. final def notify(): Unit

    Definition Classes
    AnyRef
  251. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  252. object parse

    Definition Classes
    BodyParsers
  253. def reindex(id: UUID, recursive: Boolean): Action[AnyContent]

    Reindex the given dataset, if recursive is set to true it will also reindex all files in that dataset.

  254. def removeAllTags(id: UUID): Action[AnyContent]

    REST endpoint: POST: remove all tags.

  255. def removeCreator(id: UUID, creator: String): Action[AnyContent]

  256. def removeMetadataJsonLD(id: UUID, extractorId: Option[String]): Action[AnyContent]

  257. def removeTag(id: UUID): Action[JsValue]

  258. def removeTags(id: UUID): Action[JsValue]

    REST endpoint: POST: remove tags.

    REST endpoint: POST: remove tags. Requires that the request body contains a "tags" field of List[String] type.

  259. def removeTagsHelper(obj_type: TagCheckObjType, id: UUID, request: UserRequest[JsValue]): SimpleResult

  260. def restoreDataset(id: UUID): Action[AnyContent]

  261. def searchDatasetsGeneralMetadata: Action[JsValue]

    List datasets satisfying a general metadata search tree.

  262. def searchDatasetsUserMetadata: Action[JsValue]

    List datasets satisfying a user metadata search tree.

  263. implicit def session(implicit request: RequestHeader): Session

    Definition Classes
    Controller
  264. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  265. def toString(): String

    Definition Classes
    AnyRef → Any
  266. def unfollow(id: UUID): Action[AnyContent]

  267. def updateAccess(id: UUID, access: String): Action[AnyContent]

  268. def updateDescription(id: UUID): Action[JsValue]

  269. def updateInformation(id: UUID): Action[JsValue]

    REST endpoint: POST: update the administrative information associated with a specific Dataset

    REST endpoint: POST: update the administrative information associated with a specific Dataset

    Takes one arg, id:

    id, the UUID associated with this dataset

    The data contained in the request body will contain data to be updated associated by the following String key-value pairs:

    description -> The text for the updated description for the dataset name -> The text for the updated name for this dataset

    Currently description and owner are the only fields that can be modified, however this api is extensible enough to add other existing fields, or new fields, in the future.

  270. def updateLicense(id: UUID): Action[JsValue]

    REST endpoint: POST: update the license data associated with a specific Dataset

    REST endpoint: POST: update the license data associated with a specific Dataset

    Takes one arg, id:

    id, the UUID associated with this dataset

    The data contained in the request body will be containe the following key-value pairs:

    licenseType, currently: license1 - corresponds to Limited license2 - corresponds to Creative Commons license3 - corresponds to Public Domain

    rightsHolder, currently only required if licenseType is license1. Reflects the specific name of the organization or person that holds the rights

    licenseText, currently tied to the licenseType license1 - Free text that a user can enter to describe the license license2 - 1 of 6 options (or their abbreviations) that reflects the specific set of options associated with the Creative Commons license, these are: Attribution-NonCommercial-NoDerivs (by-nc-nd) Attribution-NoDerivs (by-nd) Attribution-NonCommercial (by-nc) Attribution-NonCommercial-ShareAlike (by-nc-sa) Attribution-ShareAlike (by-sa) Attribution (by) license3 - Public Domain Dedication

    licenseUrl, free text that a user can enter to go with the licenseText in the case of license1. Fixed URL's for the other 2 cases.

    allowDownload, true or false, whether the file or dataset can be downloaded. Only relevant for license1 type.

  271. def updateName(id: UUID): Action[JsValue]

  272. def uploadToDatasetFile(dataset_id: UUID): Action[MultipartFormData[TemporaryFile]]

  273. def uploadToDatasetJSON(dataset_id: UUID): Action[JsValue]

  274. def users(id: UUID): Action[AnyContent]

  275. val userservice: UserService

    Definition Classes
    ApiController
  276. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  277. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  278. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  279. def withCharset(mimeType: String)(implicit codec: Codec): String

    Definition Classes
    ContentTypes

Deprecated Value Members

  1. def Async(promise: Future[Result]): AsyncResult

    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.0) Use Action.async to build async actions instead

Inherited from ApiController

Inherited from Controller

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from play.api.http.Status

Inherited from HttpProtocol

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped