Utilização do API Explorer

Última atualização: 7 de fevereiro de 2025
  • Tópicos:

Criado para:

  • Desenvolvedor

Ao usar a API principal do Adobe Workfront, o API Explorer é uma ferramenta de referência herdada que cataloga os relacionamentos entre recursos, parâmetros e variáveis compatíveis.

Acesse o API Explorer:

  1. Use um navegador da Web para navegar até o API Explorer
    Navegar até o API Explorer

  2. No canto superior direito do API Explorer, selecione a Versão da API desejada do Workfront. Por padrão, a versão mais atual é selecionada automaticamente

  3. O campo Filtro pode ser usado para filtrar os objetos listados por nome e truncará a lista de objetos exibidos de acordo:

    Campos do API Explorer

    • Campos: campos disponíveis dentro do objeto especificado.
    • Referências: variáveis de referência disponíveis para o objeto especificado. Uma referência é um alias para uma variável. Depois de inicializada, uma referência pode ser usada alternadamente com o nome da variável. Uma referência usa memória inicializada.
    • Coleções: coleções disponíveis para o objeto. Coleções são variáveis que representam uma relação um para muitos entre o objeto e o recurso.
    • Pesquisa: recursos disponíveis para o objeto. Os resultados de uma pesquisa se baseiam nos parâmetros de consulta especificados pelo recurso de pesquisa na solicitação de API.
    • Ações: ações com suporte para o objeto. As ações podem ser procedimentos simples ou complexos executados em relação a um recurso ou conjunto de recursos. Uma determinada ação também pode afetar os recursos relacionados.

  4. Abra uma guia e, em seguida, clique no ID do Objeto para exibir as variáveis aplicáveis.
    Exibir variáveis
    Dependendo do objeto selecionado, as seguintes variáveis podem ser aplicadas:

    VariávelDefinição
    Nome do CampoO nome de um campo usado em uma operação na API do Workfront.
    Tipo de campoO tipo de valores que podem ser inseridos em um campo específico em uma tabela de dados. Os possíveis valores de tipo de campo incluem string, double, int, dateTime.
    Tipo EnumeradoOs tipos de valores que podem ser usados para identificar um tipo de dados.
    Valores possíveisValores aceitáveis para o objeto.
    Tipo de atributo ObjCodeAtributos que podem ser usados para modificar a classe de objeto.
    URLO caminho de entrada que permite ao aplicativo se comunicar com a API do Workfront.
    ArgumentosAs variáveis do objeto que podem ser transmitidas entre seu aplicativo e o Workfront.
    Tipo de resultadoTipos de dados permitidos que podem ser retornados por um método.
Página anteriorAPI Explorer
Próxima páginaCampos de rich text na API do Adobe Workfront

Workfront