Uso del Explorador de API

Última actualización: 7 de febrero de 2025
  • Temas:

Creado para:

  • Desarrollador

Al utilizar la API principal de Adobe Workfront, el Explorador de API es una herramienta de referencia heredada que cataloga las relaciones entre los recursos compatibles, los parámetros y las variables.

Acceso al Explorador de API:

  1. Use un explorador web para navegar hasta Explorador de API
    Vaya al Explorador de API

  2. En la parte superior derecha del Explorador de API, seleccione la Versión de API de Workfront que desee; de manera predeterminada, se selecciona automáticamente la versión más actual

  3. El campo Filtrar se puede usar para filtrar los objetos enumerados por nombre y truncará en consencuencia la lista de objetos mostrados:

    Campos del Explorador de API

    • Campos: campos disponibles dentro del objeto especificado.
    • Referencias: variables de referencia disponibles para el objeto especificado. Una referencia es un alias para una variable. Una vez inicializada, se puede utilizar una referencia indistintamente con el nombre de la variable. Una referencia utiliza memoria inicializada.
    • Colecciones: colecciones disponibles para el objeto. Las colecciones son variables que representan una relación "uno a varios" entre el objeto y el recurso.
    • Buscar: recursos de búsqueda disponibles para el objeto. Los resultados de una búsqueda se basan en los parámetros de consulta especificados por el recurso de búsqueda en la solicitud de API.
    • Acciones: acciones compatibles con el objeto. Las acciones pueden ser procedimientos simples o complejos que se ejecutan con un recurso o un conjunto de recursos. Una acción determinada también puede afectar a los recursos relacionados.

  4. Abra una pestaña y, a continuación, haga clic en el ID de objeto para ver las variables aplicables.
    Ver variables
    Según el objeto seleccionado, pueden aplicarse las siguientes variables:

    VariableDefinición
    Nombre de campoNombre de un campo utilizado en una operación dentro de la API de Workfront.
    Tipo de campoTipo de valores que se pueden introducir en un campo específico de una tabla de datos. Los posibles valores de tipo de campo incluyen string, double, int y dateTime.
    Tipo enumeradoEl tipo de valores que se pueden utilizar para identificar un tipo de datos.
    Valores posiblesValores aceptables para el objeto.
    Tipo de atributo ObjCodeAtributos que se pueden utilizar para modificar la clase de objeto.
    URLRuta de entrada que permite a la aplicación comunicarse con la API de Workfront.
    ArgumentosLas variables del objeto que se pueden pasar entre la aplicación y Workfront.
    Tipo de resultadoTipos de datos permitidos que se pueden devolver desde un método.
Página anteriorExplorador de API
Página siguienteCampos de texto enriquecido en la API de Adobe Workfront

Workfront