Trigger evento

Quando si crea un webhook, si può scegliere di sottoscrivere specifici trigger di evento legati a operazioni API che richiameranno il webhook e forniranno le informazioni dell'evento attraverso il payload. Le sezioni seguenti elencano i trigger di evento disponibili e i relativi URI o valori del tipo di modifica per i webhook dei servizi di organizzazione e di feature.

Nota:

A differenza dei webhook di organizzazione e dei feature service, i webhook di servizio di geoprocessing non hanno trigger di evento definiti dall'utente. I webhook del servizio di geoprocessing consegnano i payload una volta completato il processo di geoprocessing. Per ulteriori informazioni sui payload consegnati per i servizi di geoprocessing, vedere l'argomento Payload.

Eventi di organizzazione elemento

La tabella seguente elenca i trigger di evento per gli elementi dell'organizzazione, che comprendono mappe web, applicazioni web, layer, pacchetti e PDF:

Attivazione evento	URI
Tutti gli eventi scatenanti per tutti gli elementi	/items
Un elemento viene aggiunto al portale	/items/add
Un elemento qualsiasi viene eliminato	/items/delete
Un elemento qualsiasi viene aggiornato	/items/update
Un elemento qualsiasi viene spostato o se ne cambia la proprietà	/items/move
Un elemento qualsiasi viene pubblicato	/items/publish
Un elemento qualsiasi viene condiviso	/items/share
Si annulla la condivisione di un elemento qualsiasi	/items/unshare
La proprietà di qualsiasi articolo viene riassegnata	/items/reassign
Tutti gli eventi scatenanti per un elemento specifico	/items/<itemID>
Un elemento specifico viene eliminato	/items/<itemID>/delete
Si aggiornano le proprietà di un elemento specifico Nota: Le proprietà degli elementi che possono essere aggiornate variano a seconda dei tipi di elementi e ci sono azioni univoche che attivano l'operazione di Update. Ad esempio, se l'elemento è una mappa web, l'aggiornamento del tag, la configurazione di un pop-up o la modifica della mappa di base sono tutti eventi di aggiornamento che attivano il webhook.	/items/<itemID>/update
Si modifica la proprietà di un elemento specifico o lo si sposta	/items/<itemID>/move
Un elemento specifico viene pubblicato	/items/<itemID>/publish
Un elemento specifico viene condiviso	/items/<itemID>/share
Si annulla la condivisione di un elemento specifico	/items/<itemID>/unshare
La proprietà di un elemento specifico viene riassegnata	/items/<itemID>/reassign

Proprietà di trigger di evento dell'elemento

Alcuni dei trigger di evento per gli elementi dell'organizzazione restituiscono proprietà aggiuntive nei loro payload. Le sezioni seguenti illustrano le proprietà aggiuntive del payload per questi trigger.

Un elemento specifico viene condiviso

I webhook che si sottoscrivono al trigger evento /items/<itemID>/share hanno la proprietà sharedToGroups inclusa nel loro payload. La proprietà sharedToGroups specifica in che modo l'elemento viene condiviso. Se l'elemento è stato condiviso con un gruppo, l'oggetto JSON properties include l'ID di ciascun gruppo con cui l'elemento è stato condiviso. Se l'elemento è stato condiviso dall'organizzazione nella sua totalità, l'oggetto include Organization. Se l'elemento è stato condiviso pubblicamente, l'oggetto include Everyone. L'esempio seguente mostra la condivisione di un elemento a gruppi specifici, nonché la condivisione di un elemento sia pubblicamente che a gruppi specifici.

Esempi

//groupIDs
"properties": {
  "sharedToGroups": [
    "ecd6646698b24180904e4888d5eaede3",
    "2dff15c514ad4f04b291e304e24a524b"
  ]
}

//Everyone and groupIDs
"properties": {
  "sharedToGroups": [
    "Everyone",
    "4adc30bb03054812a846fa592de105de",
    "a4e6e37e2f7d4bb5b64d587c91d39a2c"
  ]
}

La proprietà di qualsiasi articolo viene riassegnata

I webhook che si sottoscrivono al trigger evento /items/reassign hanno la proprietà reassignedTo inclusa nel loro payload. La proprietà reassignedTo specifica il nuovo utente a cui viene riassegnato un elemento o un gruppo, restituendo il nome utente del nuovo proprietario nell'oggetto JSON properties.

Esempio

"properties": {
  "reassignedTo": ["newOwner"]
}

Si annulla la condivisione di un elemento specifico

I webhook che si sottoscrivono al trigger evento /items/<itemID>/unshare hanno la proprietà unsharedFromGroups inclusa nel loro payload. La proprietà unsharedFromGroups specifica in che modo l'elemento non viene condiviso. Se l'elemento non è stato condiviso da un gruppo, l'oggetto JSON properties includerà gli ID di ciascun gruppo da cui non è stato condiviso l'elemento. Se l'elemento non è stato condiviso dall'organizzazione nella sua totalità, l'oggetto include Organization. Se l'oggetto non è stato condiviso dal pubblico, l'oggetto include Everyone. Le proprietà di esempio riportate di seguito illustrano la rimozione di un elemento dal pubblico e la rimozione di un elemento da un gruppo specifico.

Esempi

//Everyone
"properties": {
  "unsharedFromGroups": ["Everyone"]
}

//groupID
"properties": {
  "unsharedFromGroups": [
    "4adc30bb03054812a846fa592de105de"
  ]
}

La proprietà di un elemento specifico viene riassegnata

I webhook che si sottoscrivono al trigger evento /items/<itemID>/reassign hanno la proprietà reassignedTo inclusa nel loro payload. La proprietà reassignedTo specifica il nuovo utente a cui viene assegnato un elemento o un gruppo, restituendo il nome utente del nuovo proprietario nell'oggetto JSON properties.

Esempio

"properties": {
  "reassignedTo": ["newOwner"]
}

Eventi di gruppo dell'organizzazione

La tabella seguente elenca i trigger di evento per i gruppi dell'organizzazione:

Attivazione evento	URI
Tutti gli eventi scatenanti per tutti i gruppi	/groups
Un gruppo viene aggiunto	/groups/add
Un gruppo qualsiasi viene aggiornato	/groups/update
Un gruppo qualsiasi viene eliminato	/groups/delete
Eliminare protezione è abilitato per qualunque gruppo	/groups/protect
Eliminare protezione è disabilitato per qualunque gruppo	/groups/unprotect
Un utente viene invitato a un gruppo qualsiasi	/groups/invite
Un utente viene aggiunto a un gruppo qualsiasi	/groups/addUsers
Un utente viene rimosso da un gruppo qualsiasi	/groups/removeUsers
Il ruolo di un utente viene aggiornato in un gruppo qualsiasi	/groups/updateUsers
La proprietà di qualsiasi gruppo viene riassegnata	/groups/reassign
Tutti gli eventi scatenanti per un gruppo specifico	/groups/<groupID>
Un gruppo specifico viene aggiornato Nota: Qualunque modifica generale apportata alle impostazioni del gruppo costituisce un aggiornamento. Ad esempio, modificare l'accesso di un gruppo attiverà un evento di aggiornamento.	/groups/<groupID>/update
Un gruppo specifico viene eliminato	/groups/<groupID>/delete
Eliminare protezione è abilitato per un gruppo specifico	/groups/<groupID>/protect
Eliminare protezione è disabilitato per un gruppo specifico	/groups/<groupID>/unprotect
Un utente viene invitato a un gruppo specifico	/groups/<groupID>/invite
Un utente viene aggiunto a un gruppo specifico	/groups/<groupID>/addUsers
Un utente viene rimosso da un gruppo specifico	/groups/<groupID>/removeUsers
Il ruolo di un utente viene aggiornato in un gruppo specifico	/groups/<groupID>/updateUsers
La proprietà di un gruppo specifico viene riassegnata	/groups/<groupID>/reassign
Un elemento viene condiviso con un gruppo	/groups/<groupID>/itemShare
La condivisione di un elemento è terminata per un gruppo specifico	/groups/<groupID>/itemUnshare

Proprietà di trigger evento del gruppo

Alcuni dei trigger evento per i gruppi dell'organizzazione restituiscono proprietà aggiuntive nel payload. Le sezioni seguenti illustrano le proprietà aggiuntive del payload per questi trigger.

Un utente viene invitato a un gruppo specifico

I webhook che si sottoscrivono al trigger evento /groups/<groupID>/invite hanno la proprietà invitedUserNames inclusa nel loro payload. La proprietà invitedUserNames specifica i nomi degli utenti invitati a un gruppo, restituendo un elenco di nomi nell'oggetto JSON properties.

Esempio

"properties": {
  "invitedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Un utente viene aggiunto a un gruppo specifico

I webhook che si sottoscrivono al trigger evento /groups/<groupID>/addUsers hanno la proprietà addedUserNames inclusa nel loro payload. La proprietà addedUserNames specifica i nomi utente degli utenti che sono stati aggiunti a un gruppo, restituendo un elenco di nomi utente nell'oggetto JSON properties.

Esempio

"properties": {
  "addedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Un utente viene rimosso da un gruppo specifico

I webhook che si sottoscrivono al /groups/<groupID>/removeUsers hanno la proprietà removeUserNames inclusa nel loro payload. La proprietà removeUserNames specifica i nomi utente degli utenti rimossi da un gruppo, restituendo un elenco di nomi utente nell'oggetto JSON properties.

Esempio

"properties": {
  "removedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Il ruolo di un utente viene aggiornato in un gruppo specifico

I webhook che si sottoscrivono al /groups/<groupID>/updateUsers hanno la proprietà updateUserNames inclusa nel loro payload. La proprietà updateUserNames specifica i nomi utente degli utenti i cui ruoli di gruppo sono stati aggiornati, restituendo un elenco di nomi utente nell'oggetto JSON properties.

Esempio

"properties": {
  "updatedUserNames": [
    "u1TestUser",
    "u2TestUser"
  ]
}

Un elemento viene condiviso con un gruppo

I webhook che si sottoscrivono al /groups/<groupID>/itemShare hanno la proprietà sharedItems inclusa nel loro payload. La proprietà sharedItems specifica il itemID e il tipo di elemento condiviso in un gruppo, restituendo questa informazione nell'oggetto JSON properties.

Esempio

"properties": {
  "sharedItems": [
    {
      "itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
      "itemType": "Map Package"
    }
  ]
}

La condivisione di un elemento è terminata per un gruppo specifico

I webhook che si sottoscrivono al /groups/<groupID>/itemUnshare hanno la proprietà unsharedItems inclusa nel loro payload. La proprietà unsharedItems specifica il itemID e il tipo di elemento non condiviso in un gruppo, restituendo questa informazione nell'oggetto JSON properties.

Esempio

"properties": {
  "unsharedItems": [
    {
      "itemId": "7dd95fadaec84859ab8ed1059e675e0c",
      "itemType": "Image"
    }
  ]
}

Eventi dell'utente dell'organizzazione

La tabella seguente elenca i trigger di evento per gli utenti dell'organizzazione:

Attivazione evento	URI
Tutti gli eventi scatenanti per tutti gli utenti nel portale	/users
Un utente viene aggiunto all'organizzazione	/users/add
Un utente qualsiasi ha eseguito l'accesso al portale	/users/signin
Un utente qualsiasi si è disconnesso dal portale	/users/signout
Un utente qualsiasi viene eliminato	/users/delete
Il profilo di un utente qualsiasi viene aggiornato Nota: Un evento di aggiornamento viene attivato ogni volta che si apporta una modifica al profilo utente. Tuttavia, le modifiche apportate al ruolo di un utente, al tipo di utente o alla licenza non vengono considerate un aggiornamento del profilo utente.	/users/update
L'account di un utente qualsiasi viene disabilitato	/users/disable
L'account di un utente qualsiasi viene abilitato	/users/enable
A qualsiasi utente viene assegnato un nuovo ruolo	/users/updateUserRole
A qualsiasi utente viene assegnato un nuovo tipo di utente	/users/updateUserLicenseType
Tutti gli eventi scatenanti associati a un utente specifico	/users/<username>
Un utente specificato ha eseguito l'accesso al portale	/users/<username>/signIn
Un utente specificato si è disconnesso dal portale	/users/<username>/signOut
Un utente specifico viene eliminato	/users/<username>/delete
Il profilo di un utente specifico viene aggiornato Nota: Un evento di aggiornamento viene attivato ogni volta che si apporta una modifica al profilo utente. Tuttavia, le modifiche apportate al ruolo di un utente, al tipo di utente o alla licenza non vengono considerate un aggiornamento del profilo utente.	/users/<username>/update
L'account di un utente specifico viene disabilitato	/users/<username>/disable
L'account di un utente specifico viene abilitato	/users/<username>/enable
A un utente specifico viene assegnato un nuovo ruolo	/users/<username>/updateUserRole
A un utente specifico viene assegnato un nuovo tipo di utente	/users/<username>/updateUserLicenseType

Proprietà del trigger evento dell'utente

Alcuni dei trigger evento per gli utenti dell'organizzazione restituiscono proprietà aggiuntive nel payload. Le sezioni seguenti illustrano le proprietà aggiuntive del payload per questi trigger.

A un utente specifico viene assegnato un nuovo ruolo

I webhook che si sottoscrivono al /users/<username>/updateUserRole hanno la proprietà userRoleUpdatedTo inclusa nel loro payload. La proprietà userRoleUpdatedTo specifica il nuovo ruolo assegnato all'utente, restituendolo nell'oggetto JSON properties.

"properties": {
  "userRoleUpdatedTo": ["New role"]
}

A un utente specifico viene assegnato un nuovo tipo di utente

I webhook che si sottoscrivono al /users/<username>/updateUserLicenseType hanno la proprietà userLicenseTypeUpdatedTo inclusa nel loro payload. La proprietà userLicenseTypeUpdatedTo specifica il nuovo tipo di utente assegnato a un utente, restituendolo nell'oggetto JSON properties.

"properties": {
  "userLicenseTypeUpdatedTo": ["Editor"]
}

Eventi del ruolo dell'organizzazione

La tabella seguente elenca i trigger evento per i ruoli utente dell'organizzazione:

Attivazione evento	URI
Tutti gli eventi scatenanti per tutti i ruoli nel portale	/roles
Viene creato un nuovo ruolo	/roles/add
Viene aggiornato un ruolo esistente Nota: Un evento di aggiornamento viene attivato ogni volta che si apporta una modifica ai ruoli dell'organizzazione.	/roles/updated
Viene eliminato un ruolo esistente	/roles/delete

Proprietà del trigger di vento del ruolo

Alcuni dei trigger evento per i ruoli dell'organizzazione restituiscono proprietà aggiuntive nel payload. La sezione seguente illustra le proprietà aggiuntive del payload per questi trigger.

Viene creato un nuovo ruolo

I webhook che si sottoscrivono al trigger evento /roles/add hanno la proprietà name inclusa nel loro payload. La proprietà name specifica il nome del ruolo che è stato creato, restituendo nell'oggetto JSON properties.

Esempio

"properties": {
  "name": ["New role"]
}

Eventi del feature service

Nota:

In questa release, i webhook del servizio sono funzioni in versione beta. Le funzioni beta potrebbero non essere complete per cui potrebbero presentare problemi di prestazioni o qualità noti e non sono coperte dal Supporto tecnico Esri. La documentazione API beta per i webhook dei servizi è disponibile nella Guida API amministratore dei webhook dei servizi PDF. Per ulteriori informazioni sulle funzioni in versione beta in ArcGIS Enterprise, vedi Funzionalità beta.

La tabella seguente elenca i trigger evento per i webhook dei feature service:

Attivazione evento	Valore
Qualsiasi evento viene attivato	*
Viene creato un nuovo feature service	FeaturesCreated
Un feature service viene aggiornato	FeaturesUpdated
Un feature service viene eliminato	FeaturesDeleted
Un feature service viene modificato	FeaturesEdited
Viene aggiunto un nuovo allegato a un feature service	AttachmentsCreated
L'allegato di un feature service viene aggiornato	AttachmentsUpdated
L'allegato di un feature service viene eliminato	AttachmentsDeleted
Lo schema di un feature layer viene modificato	LayerSchemaChanged
La definizione di un feature layer viene modificata	LayerDefinitionChanged
La definizione di un feature service viene modificata	FeatureServiceDefinitionChanged