REST Resource: matters

Recurso: Matter

Representa um caso.

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

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

string

O ID da questão, 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.
matter_region

enum (MatterRegion)

A região de dados do 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 o caso 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 caso.
accountId

string

O ID da conta, conforme fornecido pelo SDK Admin.

AclRole

As possíveis permissões do usuário em 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.

Região do Matter

A região de dados de um caso.

Enums
MATTER_REGION_UNSPECIFIED O caso não tem uma região de dados especificada.
ANY O caso não tem uma região de dados especificada.
US O caso tem uma região de dados dos EUA.
EU O caso tem uma região de dados da UE.

Métodos

addPermissions

 Adiciona uma conta como colaborador da questão.

close

 Fecha 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 aos quais o solicitante tem acesso.

removePermissions

 Remove uma conta como colaboradora do caso.

reopen

 Reabre o caso especificado.

undelete

 Cancela a exclusão do caso especificado.

update

 Atualiza a questão especificada.