DocumentaçãoWorkfrontGuia do Workfront

Novidades da API versão 12

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined

O Workfront lançou a API versão 12 em 12 de novembro de 2020. A API versão 12 apresenta as seguintes alterações da versão 11

Recursos adicionados

Os seguintes recursos são novos na API do Workfront versão 12.

Um objeto BreadCrumb representa um elemento na hierarquia pai/filho de um item de trabalho do Adobe Workfront. As navegações estruturais indicam como um item de trabalho se encaixa na estrutura maior de Portfolio, Projetos, Projetos e Tarefas.

Para obter mais informações sobre navegações estruturais no Workfront, consulte Visão geral sobre navegações estruturais na nova experiência do Adobe Workfront

  • getObjectHierarchy

RichTextParameterValue richtextparametervalue

Os campos de rich text agora estão disponíveis em mais objetos. O objeto RichTextParameterValue foi adicionado ao Workfront para oferecer suporte a essa disponibilidade.

Para obter mais informações, consulte Campos de rich text na API do Adobe Workfront.

  • ID
  • ID
  • objCode

Recursos removidos

Nenhum recurso foi removido para a API versão 12.

Recursos modificados

Os recursos a seguir foram modificados para a API do Workfront versão 12.

NívelDeAcesso accesslevel

Um objeto AccessLevel está associado a usuários e descreve o conjunto de AccessLevelPermissions que determinam o que o usuário pode acessar.

Para obter mais informações sobre níveis de acesso, consulte Como os níveis de acesso funcionam.

PermissõesDeNívelDeAcesso accesslevelpermissions

Um objeto AccessLevelPermissions representa uma permissão específica para acessar, criar ou modificar um objeto Workfront. Essas permissões podem ser associadas a um Nível de acesso.

Campos diretos

  • coreAction

    Foram adicionados os seguintes valores possíveis:

  • açõesProibidas

    Foram adicionados os seguintes valores possíveis:

    • PLANNED_HOURS_CONTORNING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

  • açõesSecundárias

    Foram adicionados os seguintes valores possíveis:

    • PLANNED_HOURS_CONTORNING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

Solicitação de acesso accessrequest

Se um usuário não tiver acesso a um objeto no Workfront necessário, ele poderá solicitar acesso a esse objeto. O objeto AccessRequest representa essa solicitação.

Campos diretos

Regra de acesso accessrule

Um objeto AccessRule representa um conjunto de regras em níveis de acesso personalizados que determina como os usuários podem compartilhar projetos criados por eles.

Campos diretos

  • coreAction

    Foram adicionados os seguintes valores possíveis:

  • açõesProibidas

    Foram adicionados os seguintes valores possíveis:

    • PLANNED_HOURS_CONTORNING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

  • açõesSecundárias

    Foram adicionados os seguintes valores possíveis:

    • PLANNED_HOURS_CONTORNING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

ActivityLog activitylog

Um objeto ActivityLog é uma lista completa de todas as atividades que ocorreram em uma determinada conta do Workfront Proof.

Operações

A operação a seguir foi removida do objeto ActivityLog:

  • ADICIONAR

AnúncioAnexo announcementattachment

Um objeto AnnouncementAttachment representa um arquivo que foi anexado a um anúncio do Workfront.

Para obter mais informações sobre anexos de comunicado, consulte Enviar avisos

Campos diretos

  • fileExtension

    Valores possíveis adicionados:

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

Aprovação approval

Um determinado item de trabalho, como uma tarefa, um documento ou uma folha de horas, pode exigir que um supervisor ou outro usuário faça logoff no item de trabalho. Um objeto de Aprovação representa a ação de desconectar em um item de trabalho.

Campos diretos

  • ordemListaDePendências

    Os seguintes sinalizadores foram removidos:

    • DINÂMICO,

    • LAZY_READ,

    • NOT_GROUPABLE

  • groupID

    Adição dos seguintes sinalizadores

    • AUTO_LOAD,

    • DINÂMICO,

    • READ_ONLY

  • esforçoTrabalho

    Este campo foi adicionado e representa se um usuário precisa de uma pequena, média ou grande quantidade de esforço diário para concluir uma tarefa. Os valores possíveis são:

    • 1 (Pequeno)

    • 2 (Medium)

    • 3 (Grande)

    Para obter mais informações sobre o Esforço de trabalho no Workfront, consulte Visão geral do Esforço de trabalho.

SeçãoCalendário calendarsection

Uma Seção de calendário é um relatório de calendário.

Para obter mais informações sobre relatórios de calendário, consulte Visão geral dos relatórios de calendário.

Campos diretos

Os campos a seguir foram adicionados ao objeto CalendarSection para oferecer suporte à nova funcionalidade de usar datas personalizadas nos relatórios de calendário.

Para obter mais informações, consulte Usar campos de data personalizados em um relatório de calendário.

  • customDate

  • customEndDateParameterID

  • customStartDateParameterID

  • ignoreAtualDates

Empresa company

Um objeto Company representa uma organização que consiste em uma coleção de pessoas.

Para obter mais informações, consulte Criar e editar empresas.

Campos diretos

  • groupID

    A ID do grupo ao qual a empresa está associada.

Campos de referência

  • grupo

    O grupo ao qual a empresa está associada. Associar uma empresa a um grupo permite que o administrador do grupo estenda o acesso e as permissões do grupo à empresa.

Cliente customer

Um objeto Customer representa uma organização que usa uma instância do Workfront.

Ações

  • productEnabled

    Essa ação usa um argumento CustomerProductTypeEnum e retorna um booleano que informa se esse cliente tem uma conta para esse produto.

PreferênciasDoCliente customerpreferences

Um objeto CustomerPreferences representa o conjunto de preferências que um cliente definiu para sua instância do Workfront.

Campos diretos

  • name

    Valores possíveis adicionados:

    • password:zoomIntegrationEnabled (Habilita a integração do Zoom no fluxo de atualizações)
    • senha:quipIntegrationEnabled (config.general.quip.enabled)

Documento document

Um objeto Documento representa um arquivo (como material escrito, imagens ou outras formas de informação).

Ações

  • createLinkedProofVersion

    Adicionado

VersãoDocumento documentversion

Um objeto DocumentVersion representa uma versão específica de um arquivo (como material escrito, imagens ou outras formas de informação).

Para obter mais informações sobre versões de documentos, consulte Carregar uma nova versão de um documento.

Campos diretos

  • externalIntegrationType

    Valor possível removido:

    • QUIP (Quip)

  • proofDecision

    Adicionado

Ações

As ações a seguir foram adicionadas ao objeto Documento.

  • getDocumentReviewerDecision

    Essa ação pega o argumento documentVersionID (string) e retorna um mapa que indica a decisão do revisor.

  • setDocumentReviewerDecision

    Essa ação aceita os seguintes argumentos:

    • documentVersionID (sequência de caracteres)

    • reviewerDecision (sequência de caracteres)

    • comentário (sequência de caracteres)

Grupo group

Um objeto Grupo representa um conjunto de usuários e equipes. Os grupos geralmente representam a estrutura departamental.

Campos diretos

  • businessLeaderID

    A ID do Líder de negócios atribuído ao grupo.

Campos de referência

  • líder de negócios

    O Líder de negócios atribuído ao grupo. Um Líder de negócios é alguém que toma decisões de negócios para o grupo.

    Para obter mais informações sobre líderes de negócios, consulte Visão geral sobre Líderes de negócios.

Ações

  • atribuirMúltiplo

    Essa ação aceita os seguintes argumentos:

    • userIDs (string[])

    • roleIDs (string[])

    • teamID (string)

  • getGroupMembers

  • updateMembersList

    Essa ação aceita os seguintes argumentos:

    • newMemberIDs (string[])

    • removedMemberDs (string[])

LinkedFolder linkedfolder

Um objeto LinkedFolder representa uma pasta vinculada de um provedor de documentos externo, como Google Drive ou Dropbox.

Para obter mais informações sobre Pastas Vinculadas, consulte Vincular documentos de aplicativos externos.

Campos diretos

  • externalIntegrationType

    Valor possível removido:

    • QUIP (Quip)

OpTask optask

Um objeto OpTask é comumente conhecido como um Problema. Um problema é um item de trabalho que geralmente indica que há um problema que impede a conclusão de uma tarefa ou projeto. Um problema também pode ser uma solicitação de Help Desk. Pedidos de alteração, solicitações e bugs também são problemas.

Campos diretos

  • ordemListaDePendências

    A ordem indica a posição de uma tarefa ou história no backlog Agile.

    Esse campo removeu os seguintes sinalizadores:

    • DINÂMICO,
    • LAZY_READ,
    • NOT_GROUPABLE:
Ações

Essas ações adicionaram o status do argumento para suportar a nova funcionalidade do botão Iniciar, que altera o status de um item de trabalho quando um usuário clica no botão para indicar que começou a trabalhar no item.

Para obter mais informações, consulte Substituir o botão Trabalhar na tarefa por um botão Iniciar.

  • acceptWork

  • cancelarTrabalho

Parâmetro parameter

Um objeto Parameter é um campo personalizado.

O recurso Parameter adicionou o sinalizador SHARABLE.

Para obter mais informações sobre campos personalizados, consulte Criar ou editar um formulário personalizado em Criar ou editar um formulário personalizado.

Campos diretos
Campos de coleção

  • accessRules

    Adicionado

Campos padrão

  • rótulo

    Adicionado

Portfólio portfolio

Um objeto Portfolio é uma coleção de projetos que competem pelos mesmos recursos, normalmente dinheiro ou pessoas para concluí-los.

Para obter mais informações sobre portfólios, consulte visão geral de Portfolio no Adobe Workfront.

Campos diretos

  • groupID

    A ID do grupo ao qual o portfólio está associado.

Campos de referência

  • grupo

    O grupo ao qual o portfólio está associado.

Programa program

Um objeto Programa é um subconjunto de projetos em um portfólio, em que projetos semelhantes podem ser agrupados.

Campos diretos

  • groupID

    A ID do grupo ao qual o programa está associado.

Campos de referência

  • grupo

    O grupo ao qual o programa está associado.

QueueDef queuedef

Um objeto QueueDef representa uma Fila, que é um Projeto publicado na área Help Desk para permitir que os usuários enviem Problemas a ele.

Para obter mais informações sobre Filas de solicitações, consulte Criar uma fila de solicitações.

Campos diretos

RelatórioAgendado scheduledreport

Um objeto ScheduledReport representa um relatório que foi configurado para ser agendado para entrega.

Campos diretos

  • formato

    Valores possíveis adicionados:

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

ScoreCardQuestion scorecardquestion

Um objeto ScoreCardQuestion representa uma pergunta que foi adicionada a um Scorecard. Essas perguntas geralmente são determinadas pelo gerente de Portfolio, e suas respostas permitem que o gerente entenda como um projeto se alinha com as metas do portfólio.

Para obter mais informações sobre Perguntas do Scorecard, consulte Criar um scorecard.

Campos diretos

Tarefa task

Um objeto Tarefa representa um item de trabalho que deve ser executado como uma etapa para atingir uma meta final (concluir um Projeto).

Campos diretos

  • esforçoTrabalho

    Este campo foi adicionado e representa se um usuário precisa de uma pequena, média ou grande quantidade de esforço diário para concluir uma tarefa. Os valores possíveis são:

    • 1 (Pequeno)

    • 2 (Medium)

    • 3 (Grande)

    Para obter mais informações sobre o Esforço de trabalho no Workfront, consulte Visão geral do Esforço de trabalho.

Ações

Essas ações adicionaram o status do argumento para suportar a nova funcionalidade do botão Iniciar, que altera o status de um item de trabalho quando um usuário clica no botão para indicar que começou a trabalhar no item.

Para obter mais informações, consulte Substituir o botão Trabalhar na tarefa por um botão Iniciar.

  • acceptWork

  • cancelarTrabalho

Equipe team

Um objeto Equipe é uma coleção de Usuários que pode ser atribuída a um item de trabalho.

Campos diretos

Os seguintes campos foram adicionados ao recurso Equipe:

  • groupID

    Este campo associa uma equipe a um grupo. Isso identifica a equipe como parte do grupo e permite que o Administrador do grupo gerencie as equipes.

  • workOnItStatusChange

    Este é um parâmetro booleano que indica se o botão Trabalhar na equipe foi configurado como um botão Iniciar. Quando um membro da equipe clica em um botão Iniciar para começar a trabalhar em um item de trabalho, o status do item muda de Novo para um status configurado nas configurações da equipe.

  • Os campos a seguir permitem especificar status personalizados para o botão Iniciar nos itens de trabalho individuais.

    • workOnItOpTaskBugReportStatuses

    • workOnItOpTaskChangeOrderStatuses

    • workOnItOpTaskIssueStatuses

    • workOnItOpTaskRequestStatuses

      workOnItTaskStatuses

    Para obter mais informações sobre o botão Iniciar, consulte Substituir o botão Trabalhar na tarefa por um botão Iniciar.

Campos de referência

O seguinte campo foi adicionado ao recurso Equipe:

  • grupo

TarefaModelo templatetask

Um objeto TemplateTask representa uma Tarefa que faz parte de um Template. Modelos de Tarefa se tornam Tarefas no Projeto onde o Modelo é usado.

Para obter mais informações sobre Modelos de Tarefa, consulte Editar uma tarefa de modelo.

Campos diretos

  • esforçoTrabalho

    Este campo foi adicionado e representa se um usuário precisa de uma pequena, média ou grande quantidade de esforço diário para concluir uma tarefa. Os valores possíveis são:

    • 1 (Pequeno)

    • 2 (Medium)

    • 3 (Grande)

    Para obter mais informações sobre o Esforço de trabalho no Workfront, consulte Visão geral do Esforço de trabalho.

Planilha de horas timesheet

Um objeto de Planilha de Horas representa um cartão de ponto virtual que permite aos Usuários inserir as horas reais trabalhadas para Tarefas, Projetos e Tipos de Horas Gerais.

Para obter mais informações sobre Folhas de horas, consulte Visão geral sobre Folhas de horas

Campos principais

O campo a seguir foi removido do recurso Quadro de horários:

  • objcode

Atualizar

Campos diretos

  • updateType

    Foram adicionados os seguintes valores possíveis:

    • initiativeAdd (enum.updatetypeenum.initiativeadd)

    • initiativeEdit (enum.updatetypeenum.initiativeedit)

    Para obter mais informações sobre iniciativas, consulte Visão geral das iniciativas no Planejador de cenários.

Usuário user

Um objeto Usuário representa uma pessoa com uma conta no Workfront que pode fazer logon e interagir com o sistema.

Campos diretos

Os seguintes campos foram adicionados ao recurso Usuário:

  • atualDeactivationDate

    Representa a data e a hora em que um usuário foi desativado.

    Para obter mais informações sobre Usuários desativados, consulte Desativar ou reativar um usuário.

  • alignAccessType

    Este campo mostra o acesso do usuário às Metas do Workfront. Os valores possíveis são:

    • Sem acesso

    • Exibir

    • Editar

Ações

A seguinte ação foi adicionada ao recurso Usuário:

  • getUserAccessPermissionsByObjCode

    Esta ação aceita os seguintes argumentos

    • ids (sequência de caracteres)

    • objCode (string)

Trabalho work

Um objeto Trabalho é uma interface comum que tanto Tarefa quanto OpTask herdam e compartilha código comum entre os dois.

Campos diretos

  • ordemListaDePendências

    A ordem indica a posição de uma tarefa ou história no backlog Agile.

    Esse campo removeu os seguintes sinalizadores:

    • DINÂMICO,

    • LAZY_READ,

    • NOT_GROUPABLE

  • groupID

    Esse campo adicionou os seguintes sinalizadores:

    • AUTO_LOAD,

    • DINÂMICO,

    • READ_ONLY

  • esforçoTrabalho

    Este campo foi adicionado e representa se um usuário precisa de uma pequena, média ou grande quantidade de esforço diário para concluir uma tarefa. Os valores possíveis são:

    • 1 (Pequeno)

    • 2 (Medium)

    • 3 (Grande)

    Para obter mais informações sobre o Esforço de trabalho no Workfront, consulte Visão geral do Esforço de trabalho.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43