Utilizzo di API Explorer

Ultimo aggiornamento: 7 febbraio 2025
  • Argomenti:

Creato per:

  • Sviluppatore

Quando utilizzi l’API core di Adobe Workfront, API Explorer è uno strumento di riferimento legacy che cataloga le relazioni tra risorse, parametri e variabili supportati.

Accedi a API Explorer:

  1. Utilizza un browser Web per passare a API Explorer
    Passare a API Explorer

  2. In alto a destra in API Explorer, seleziona la versione API di Workfront desiderata; per impostazione predefinita, viene selezionata automaticamente la versione più recente

  3. Il campo Filtro, può essere utilizzato per filtrare gli oggetti elencati per nome e tronca l'elenco di oggetti visualizzato di conseguenza:

    Campi API Explorer

    • Campi: campi disponibili nell'oggetto specificato.
    • Riferimenti: variabili di riferimento disponibili per l'oggetto specificato. Un riferimento è un alias per una variabile. Una volta inizializzato, un riferimento può essere utilizzato in modo intercambiabile con il nome della variabile. Un riferimento utilizza la memoria inizializzata.
    • Raccolte: raccolte disponibili per l'oggetto. Le raccolte sono variabili che rappresentano una relazione uno-a-molti tra l’oggetto e la risorsa.
    • Ricerca: risorse di ricerca disponibili per l'oggetto. I risultati di una ricerca si basano sui parametri di query specificati dalla risorsa di ricerca nella richiesta API.
    • Azioni: azioni supportate per l'oggetto. Le azioni possono essere procedure semplici o complesse che vengono eseguite su una risorsa o un set di risorse. Una determinata azione può influire anche sulle risorse correlate.

  4. Apri una scheda, quindi fai clic sull’ID oggetto per visualizzare le variabili applicabili.
    Visualizza variabili
    A seconda dell’oggetto selezionato, possono essere applicate le seguenti variabili:

    VariabileDefinizione
    Nome CampoNome di un campo utilizzato in un’operazione all’interno dell’API Workfront.
    Tipo di campoTipo di valori che è possibile immettere in un campo specifico di una tabella dati. I possibili valori del tipo di campo includono string, double, int, dateTime.
    Tipo enumeratoIl tipo di valori che possono essere utilizzati per identificare un tipo di dati.
    Valori possibiliValori accettabili per l'oggetto.
    Tipo di attributo ObjCodeAttributi che possono essere utilizzati per modificare la classe oggetto.
    URLPercorso di ingresso che consente all’app di comunicare con l’API Workfront.
    ArgomentiLe variabili dell'oggetto che possono essere passate tra l'applicazione e Workfront.
    Tipo di risultatoTipi di dati consentiti che possono essere restituiti da un metodo.
Pagina precedenteAPI Explorer
Pagina successivaCampi Rich Text nell’API di Adobe Workfront

Workfront