TaskList

Resumo do método

GET /scr/api/TaskList

Descrição

Use esse método para obter uma lista de tarefas abertas designadas ao usuário atual e uma lista de tarefas concluídas do usuário.

Informações de recurso

Requisitos	Descrição
Formato de resposta	JSON
Requer autenticação	True
Suporta credenciais do cliente OAuth 2	Sim usando um ID de Serviço do Usuário contendo Categoria de Gerenciamento de Trabalho
Taxa limitada	Ainda não

Parâmetros

Nome	Local	Descrição	Necessário	Tipo
X-On-Behalf-Of	Cabeçalho	O contexto do usuário. O valor deve ser um nome do usuário na conta. O usuário deve ter permissão para executar a ação na conta e no espaço pai especificado, se houver.	Necessário se forem utilizadas credenciais de ID de serviço OAuth. Não é necessário ao usar a credencial de ID de serviço do usuário OAuth.	Sequência
type	Consultar	O tipo de lista a ser retornado. Os seguintes valores são suportados: assigned ou completed. Se o valor não for suportado, o código de resposta 400 será retornado.	True	Sequência
version	Consultar	A versão da API solicitada. O único valor permitido é 20110917.	True	Sequência
limit	Consultar	O número máximo de tarefas para retornar. Se esse parâmetro não for fornecido, o valor padrão de 100 será utilizado.	Não	Número Inteiro
startFrom	Consultar	Se esse parâmetro for fornecido, então a lista retornada será iniciada com a tarefa neste índice na lista (baseado em zero). Utilize este parâmetro se o número de tarefas disponíveis for superior ao número de tarefas retornadas em um limite de chamada anterior.	Não	Número Inteiro

Resposta

Exemplo de entrada

• Usando as credenciais do cliente do ID de serviço do usuário OAuth 2:

  curl -i -H "Authorization: Bearer access_token"
  "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

• Usando o ID do serviço OAuth 2 credenciais do cliente com contexto do usuário:

  curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com"
      "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

Exemplo de saída

{
      "work":[
         {           
            "name":"ProcessApp 1 - Multiple process apps.",        
            "id":"5f501e1345eda"
         },
         {           
            "name":"ProcessApp 2 - Multiple process apps.",        
            "id":"5f500e134a57f"
         },
     ]
}

Propriedades de resposta

version

A versão da API que foi usada para criar uma resposta.

more

Contém um dos seguintes valores possíveis:

• true, se houver mais tarefas no servidor
• false, se a entrada de tarefa incluir todas as tarefas disponíveis

type

O tipo de tarefas na lista. Os valores possíveis são assigned ou completed. Esses valores correspondem ao que pode ser transmitido para o parâmetro de tipo.

tasks

A matriz de tarefas. As tarefas são listadas em ordem cronológica reversa de dueDate. Os itens com o mesmo dueDate são classificados por ID de instância e ID de tarefa.

task.name

O nome da tarefa.

task.id

O ID da tarefa.

task.workId

O ID do trabalho associado. Esta propriedade corresponde à propriedade de ID de uma das entradas na matriz de trabalho. Mais de uma tarefa pode fazer referência à mesma entrada de trabalho.

task.dueDate

Parâmetro opcional. A data de vencimento da tarefa. Se a tarefa não tiver data de vencimento, este campo não estará presente. A data de vencimento é listada em milissegundos desde a época, que é 1º de janeiro de 1970 à meia noite na Hora Universal Coordenada (UTC).

work

A matriz de itens de trabalho. Os itens de trabalho não estão em nenhuma ordem específica. Há uma entrada na matriz para cada valor exclusivo de workId na matriz de tarefas.

work.name

O nome que foi fornecido para a instância de trabalho quando ela foi iniciada.

work.id

O ID da instância de trabalho.

Mensagens de resposta

Código de HTTP	Razão
200	A solicitação foi concluída com sucesso.
400	Há um erro ao processar a solicitação. Os parâmetros necessários estavam ausentes ou continham valores inválidos.
401	O usuário não está autorizado a fazer a solicitação.