REST Resource: matters

Recurso: Matter

Representa um caso.

Para usar os recursos do Vault, a conta precisa ter os privilégios necessários e acesso ao caso. Para acessar um caso, a conta precisa ter criado ou compartilhado o caso ou ter o privilégio Ver todos os casos.

Representação JSON
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
Campos
matterId

string

O ID do caso, que é gerado pelo servidor. Deixe em branco ao criar um caso.

name

string

É o nome do caso.

description

string

Uma descrição opcional para o caso.

state

enum (State)

O estado da questão.

matterPermissions[]

object (MatterPermission)

Lista os usuários e as permissões deles para o caso. No momento, não há um limite definido pelo programador para o número de permissões que um caso pode ter.

Estado

O estado de um caso.

Enums
STATE_UNSPECIFIED O caso não tem um estado especificado.
OPEN O caso está aberto.
CLOSED O caso foi encerrado.
DELETED O caso foi excluído.

MatterPermission

Os usuários podem ser proprietários ou colaboradores de casos. Cada caso tem apenas um proprietário. Os outros usuários com acesso ao caso são colaboradores. Quando uma conta é limpa, os recursos MatterPermission correspondentes deixam de existir.

Representação JSON
{
  "role": enum (AclRole),
  "accountId": string
}
Campos
role

enum (AclRole)

É a função do usuário no caso.

accountId

string

O ID da conta, conforme fornecido pelo SDK Admin.

AclRole

São as possíveis permissões do usuário para um caso, em ordem crescente de permissões.

Enums
ROLE_UNSPECIFIED Sem papel atribuído.
COLLABORATOR um colaborador no caso;
OWNER O proprietário do caso.

Métodos

addPermissions

Adiciona uma conta como colaborador do caso.

close

Fecha o caso especificado.

count

Conta as contas processadas pela consulta especificada.

create

Cria um caso com o nome e a descrição fornecidos.

delete

Exclui o caso especificado.

get

Recebe o caso especificado.

list

Lista os casos a que o solicitante tem acesso.

removePermissions

Remove uma conta como colaborador do caso.

reopen

Reabre o caso especificado.

undelete

Cancela a exclusão do caso especificado.

update

Atualiza o caso especificado.