Type Members

1.  case class AuthenticatedUser(id: Int, identifier: String, displayName: String, firstName: Option[String] = None, lastName: Option[String] = None, email: String, superuser: Boolean, affiliation: Option[String] = None, position: Option[String] = None, persistentUserId: Option[String] = None, createdTime: String, lastLoginTime: Option[String] = None, lastApiUseTime: Option[String] = None, authenticationProviderId: Option[String] = None) extends Product with Serializable
2.  case class BuiltinUser(firstName: String, lastName: String, userName: String, affiliation: String, position: String, email: String) extends Product with Serializable
3.  case class DataMessage(message: String) extends Product with Serializable
4.  type DatabaseSetting = (String, String)
5.  case class DatasetPublicationResult(id: Int, identifier: String = null, persistentUrl: String = null, protocol: String = null, authority: String = null, publisher: String = null, publicationDate: String = null, storageIdentifier: String = null) extends Product with Serializable
6.  case class Dataverse(id: Option[Int] = None, ownerId: Option[Int] = None, name: String, alias: String, dataverseContacts: List[DataverseContact], permissionRoot: Boolean = true, affiliation: Option[String] = None, description: Option[String] = None, dataverseType: String, storageDriverLabel: Option[String] = None, creationDate: Option[String] = None) extends Product with Serializable
7.  case class DataverseContact(displayOrder: Option[Int] = None, contactEmail: String) extends Product with Serializable
8.  case class DataverseItem(type: String, id: Int, title: Option[String], identifier: Option[String], persistentUrl: Option[String], protocol: Option[String], authority: Option[String], publisher: Option[String], publicationDate: Option[String], storageIdentifier: Option[String]) extends Product with Serializable
9.  case class DataverseMessage[D](status: String, data: Option[D], message: Option[String]) extends Product with Serializable

   A JSON response message sent by Dataverse.

   A JSON response message sent by Dataverse. The message may contain payload object (for example dataset information when this was requested). This can be retrieved from the data field. It may also contain an informational message. That can be retrieved from the message field. Sometimes the informational message is packaged in the data field. In these cases the payload type will be DataMessage.

   D

   the expected type of payload data

   status

   current status, usually OK or ERROR

   data

   payload of the response; in case of an ERROR: the error message

   message

   a message from Dataverse, maybe informational or a warning

10.  case class Group(description: String, displayName: String, aliasInOwner: Option[String] = None, groupAliasInOwner: Option[String] = None, identifier: Option[String] = None, containedRoleAssignees: List[Any] = List.empty) extends Product with Serializable
11.  case class Lock(lockType: String, date: String, user: String, dataset: String, message: Option[String] = None) extends Product with Serializable
12.  case class MetadataBlockSummary(id: Int, name: String, displayName: String) extends Product with Serializable
13.  case class ResumeMessage(Status: String, Reason: String, Message: String) extends Product with Serializable
14.  case class Role(id: Option[Int] = None, ownerId: Option[Int] = None, alias: String, name: String, description: Option[String] = None, permissions: List[String]) extends Product with Serializable
15.  case class RoleAssignment(assignee: String, role: String) extends Product with Serializable

    Note: user IDs must be prefixed with an @ sign (e.g., @myuser)

    Note: user IDs must be prefixed with an @ sign (e.g., @myuser)

    assignee

    user or group to assign the role to

    role

    the role to assign

16.  case class RoleAssignmentReadOnly extends Product with Serializable
17.  case class Workflow(id: Option[Int] = None, name: String, steps: List[WorkflowStep] = List.empty) extends Product with Serializable
18.  case class WorkflowStep(stepType: String, provider: String, parameters: Map[String, String]) extends Product with Serializable