REST Resource: matters

Recurso: Matter

Representa um caso.

Para trabalhar com 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 o caso, ter recebido o compartilhamento ou ter o privilégio Acessar todos os casos.

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

string

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

string

O nome do assunto.
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 uma matéria pode ter.
matterRegion

enum (MatterRegion)

Opcional. A região de dados solicitada para o caso.

Estado

O estado de um caso.

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

MatterPermission

Os usuários podem ser proprietários ou colaboradores da questão. Cada matéria tem apenas um proprietário. Todos os outros usuários que podem acessar a matéria são colaboradores. Quando uma conta é excluída, os recursos de MatterPermission correspondentes deixam de existir.

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

enum (AclRole)

A função do usuário no assunto.
accountId

string

O ID da conta, conforme fornecido pelo SDK Admin.

AclRole

As possíveis permissões do usuário para uma questão, em ordem de aumento das permissões.

Enums
ROLE_UNSPECIFIED Sem papel atribuído.
COLLABORATOR Um colaborador sobre o assunto.
OWNER O proprietário do caso.

MatterRegion

Região de dados do caso.

Enums
MATTER_REGION_UNSPECIFIED A região não foi especificada. O padrão é QUALQUER.
ANY Qualquer região.
US Região dos Estados Unidos.
EUROPE Região da Europa.

Métodos

addPermissions

 Adiciona uma conta como colaborador da questão.

close

 Encerrar o caso especificado.

count

 Conta as contas processadas pela consulta especificada.

create

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

delete

 Exclui o assunto especificado.

get

 Recebe a questão especificada.

list

 Lista os casos que o solicitante pode acessar.

removePermissions

 Remove uma conta como colaborador de uma questão.

reopen

 Reabre o caso especificado.

undelete

 Desfaz a exclusão da matéria especificada.

update

 Atualiza a questão especificada.