Metodi operativi

Questa sezione descrive i parametri operativi comuni gestiti dall'API del servizio Web IPS.

Per una descrizione completa di ciascun parametro dell'operazione, vedere Parametri operazione.

Handle: informazioni

Gestisce gli oggetti IPS di riferimento restituiti da determinate operazioni API. Puoi anche trasmettere gli handle come parametri alle chiamate di operazione successive. Gli handle sono tipi di dati stringa ( xsd:string).

Gli handle devono essere utilizzati solo durante una singola sessione dell'applicazione. Inoltre, è necessario rendere gli handle persistenti perché il loro formato può cambiare tra le versioni IPS. Quando si scrivono applicazioni interattive, si implementano timeout di sessione e si eliminano tutti gli handle tra sessioni, in particolare dopo un aggiornamento IPS. Quando scrivi applicazioni non interattive, chiama le operazioni appropriate per recuperare gli handle ogni volta che l’applicazione viene eseguita. I seguenti esempi di codice Java/Axis2 mostrano un’esecuzione del codice errata e corretta:

Codice handle errato

Questo esempio di codice non è corretto perché contiene un valore hardcoded (555) per l’handle aziendale.

SearchAssetsParam searchParam = new SearchAssetsParam(); searchParam.setCompanyHandle("555");// INCORRECT
searchParam.setFolder("myFolder");
SearchAssetsReturn retVal = ipsApi.searchAssets(searchParam, authHeader);

Correggi codice handle

Questo esempio di codice è corretto perché chiama getCompanyInfo per restituire un handle valido. Non si basa su un valore hardcoded. Utilizza questo metodo o un’altra API IPS equivalente per restituire l’handle richiesto.

GetCompanyInfoParam companyInfoParam = new GetCompanyInfoParam();
companyInfoParam.setCompanyName("My Company"); GetCompanyInfoReturn companyInfoReturn = ipsApi.getCompanyInfo(companyInfoParam, authHeader);
String companyHandle = companyInfoReturn.getCompanyInfo().getCompanyHandle();
SearchAssetsParam searchParam = new SearchAssetsParam(); searchParam.setCompanyHandle(companyHandle); //CORRECT
searchParam.setFolder("myFolder");
SearchAssetsReturn retVal = ipsApi.searchAssets(searchParam, authHeader);

Tipi di handle comuni

companyHandle

La maggior parte delle operazioni richiede di impostare un contesto aziendale passando un companyHandle parametro. L’handle aziendale è un puntatore restituito da alcune operazioni, ad esempio getCompanyInfo, addCompany, e getCompanyMembership.

userHandle

Il userHandle Il parametro è facoltativo per le operazioni destinate a un utente specifico. Per impostazione predefinita, queste operazioni sono indirizzate all’utente chiamante (l’utente le cui credenziali vengono passate per l’autenticazione). Tuttavia, gli utenti amministratori con le autorizzazioni appropriate possono specificare un utente diverso. Ad esempio, il setPassword L'operazione di in genere imposta la password dell'utente autenticato, ma un amministratore può utilizzare userHandle per impostare la password per un altro utente.

Per le operazioni che richiedono un contesto aziendale (utilizzando companyHandle ), sia gli utenti autenticati che quelli di destinazione devono essere membri della società specificata. Per le operazioni che non richiedono un contesto aziendale, gli utenti autenticati e di destinazione devono essere membri di almeno una società comune.

Le operazioni seguenti possono recuperare gli handle utente:

  • getUsers
  • getAllUsers
  • getUserInfo
  • getCompanyMembers
  • getGroupMembers
  • addUser

accessUserHandle e accessGroupHandle

Per impostazione predefinita, le operazioni che richiedono autorizzazioni di accesso (lettura, scrittura, eliminazione) funzionano nel contesto delle autorizzazioni dell'utente chiamante. Alcune operazioni ti consentono di modificare questo contesto con accessUserHandle o accessGroupHandle parametro. Il accessUserHandle Questo parametro consente a un amministratore di rappresentare un altro utente. Il accessGroupHandle consente al chiamante di operare nel contesto di un gruppo di utenti specifico.

responseFieldArray ed excludeFieldArray

Alcune operazioni consentono al chiamante di limitare quali campi sono inclusi nella risposta. Limitare i campi può contribuire a ridurre il tempo e la memoria necessari per elaborare la richiesta e la dimensione dei dati di risposta. Il chiamante può richiedere un elenco specifico di campi trasmettendo un responseFieldArray o con un elenco enumerato di campi esclusi tramite il excludeFieldArray parametro.

Entrambi responseFieldArray e excludeFieldArray specificare i campi utilizzando un percorso di nodo separato da /. Ad esempio, per specificare che searchAssets restituisce solo il nome, la data dell’ultima modifica e i metadati di ciascuna risorsa per i seguenti elementi:

<responseFieldArray>
   <items>assetArray/items/name</items>
   <items>assetArray/items/lastModified</items>
   <items>assetArray/items/metadataArray</items>
</responseFieldArray>

Allo stesso modo, per restituire tutti i campi (ad eccezione delle autorizzazioni):

<excludeFieldArray>
   <items>assetArray/items/permissions</items>
</excludeFieldArray>

I percorsi dei nodi sono relativi alla radice del nodo restituito. Se si specifica un campo di tipo complesso senza i relativi sottoelementi (ad esempio, assetArray/items/imageInfo), quindi sono inclusi tutti i relativi sottoelementi. Se si specificano uno o più elementi secondari in un campo di tipo complesso (ad esempio, assetArray/items/imageInfo/originalPath), vengono inclusi solo i sottoelementi.

Se non includi responseFieldArray o excludeFieldArray in una richiesta, vengono restituiti tutti i campi.

Lingua

A partire da IPS 4.0, l'API IPS supporta l'impostazione del contesto locale di un'operazione trasmettendo authHeader parametro locale. Se il parametro locale non è presente, l'intestazione HTTP Accept-Language viene utilizzato. Se anche questa intestazione non è presente, viene utilizzata la lingua predefinita per il server IPS.

Alcune operazioni utilizzano inoltre parametri internazionali espliciti, che possono essere diversi dal contesto locale dell'operazione. Ad esempio, il submitJob l'operazione richiede locale parametro che imposta le impostazioni locali utilizzate per la registrazione dei processi e la notifica e-mail.

I parametri delle impostazioni internazionali utilizzano il formato <language_code>[-<country_code>]

Se il codice lingua è un codice a due lettere minuscole specificato dalla norma ISO-639 e il codice paese facoltativo è un codice a due lettere maiuscole specificato dalla norma ISO-3266. Ad esempio, la stringa delle impostazioni internazionali per l'inglese americano è en-US.

In questa pagina