REST Resource: matters

Resource: Matter

Represents a matter.

JSON representation
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum(State),
  "matterPermissions": [
    {
      object(MatterPermission)
    }
  ]
}
Fields
matterId

string

The matter ID which is generated by the server. Should be blank when creating a new matter.

name

string

The name of the matter.

description

string

The description of the matter.

state

enum(State)

The state of the matter.

matterPermissions[]

object(MatterPermission)

List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.

State

The possible states of a matter.

Enums
STATE_UNSPECIFIED The matter has no specified state.
OPEN This matter is open.
CLOSED This matter is closed.
DELETED This matter is deleted.

MatterPermission

Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.

JSON representation
{
  "role": enum(AclRole),
  "accountId": string
}
Fields
role

enum(AclRole)

The user's role in this matter.

accountId

string

The account id, as provided by Admin SDK.

AclRole

The possible ACL roles, in order of increasing permissions.

Enums
ROLE_UNSPECIFIED No role assigned.
COLLABORATOR A collaborator to the matter.
OWNER The owner of the matter.

Methods

addPermissions

Adds an account as a matter collaborator.

close

Closes the specified matter.

create

Creates a new matter with the given name and description.

delete

Deletes the specified matter.

get

Gets the specified matter.

list

Lists matters the user has access to.

removePermissions

Removes an account as a matter collaborator.

reopen

Reopens the specified matter.

undelete

Undeletes the specified matter.

update

Updates the specified matter.