Vue d'ensemble des services REST de géotraitement

Le service Web REST d'ArcGis est fondé sur deux principes simples :

1. Chaque service SIG publié sur un serveur ArcGIS est considéré comme une ressource ; il est possible d'y accéder via une URL, telle que http://<nom d’hôte>/arcgis/rest/<NomService>. Cette URL est également appelée point d'extrémité REST.

2. Chaque ressource dispose :
   • de propriétés qui la décrivent,
   • d'opérations pouvant être effectuées sur les ressources (facultatif),
   • de ressources enfant (facultatif).

Une opération est une action sur une ressource qui déclenche le transfert de l'état de la ressource et/ou crée de nouvelles ressources. Une ressource enfant est une ressource qui fonctionne dans le contexte de sa ressource parent et hérite de ses propriétés. Une ressource enfant peut également avoir des propriétés propres et prendre en charge des opérations qui lui sont appliquées. Une ressource crée une hiérarchie d'extrémités pour ses ressources enfant et ses opérations accessibles via une URL.

Services REST de géotraitement

Un service de géotraitement est une ressource accessible via une URL. Le format d'URL d'un service de géotraitement est http://<nom du serveur>/<nom de l'instance>/rest/services/<nom du service>/GPServer, par exemple, http://myServer/ArcGIS/rest/services/BufferPoints/GPServer. Un service de géotraitement est doté de propriétés comme Description du service, Tâches, Type d'exécution ou Serveur de carte des résultats. Les tâches de géotraitement qui sont publiées dans un service de géotraitement constituent ses ressources enfant. Le service de géotraitement, en lui-même, ne dispose d'aucune opérations, mais les tâches prennent en charge les opérations submitJob et execute. Les tâches comprises dans un service de géotraitement héritent des propriétés de type d'exécution et de serveur de carte de résultats. Elles ont également d'autres propriétés relatives à la description de la tâche ou aux paramètres de tâche. Les propriétés du service et des tâches sont déterminées par l'éditeur du service et ne peuvent pas être modifiées par les clients.

La figure ci-dessous illustre la hiérarchie des ressources REST de géotraitement. Notez que chaque tâche de géotraitement hérite des propriétés du service de géotraitement qui apparaissent en orange ci-dessous : Type d'exécution, Nombre maximal d'enregistrements (Nb max. enregistrements dans l'illustration), et Serveur de carte de résultats.

Remarque :

les propriétés du service de géotraitement et des tâches sont déterminées par l'éditeur du service et ne peuvent pas être modifiées par les clients.

Tâches de géotraitement

Une tâche de géotraitement est une ressource enfant du service de géotraitement. Un service de géotraitement peut contenir une ou plusieurs tâches. Une tâche de géotraitement peut être considérée comme un outil de géotraitement géré par le serveur. L'outil est exécuté sur le serveur quand un client envoie une requête comportant les paramètres en entrée appropriés. Lorsque l'outil s'exécute avec succès, les valeurs de paramètre en sortie sont renvoyées au client. Le format d'URL d'accès à une tâche de géotraitement est http://<url-serviceGéotraitement>/<nomDeLaTâche>, par exemple, http://myserver/ArcGIS/rest/services/BufferPoints/GPServer/BufferPoints.

Pour en savoir plus sur les tâches REST de géotraitement

Type d'exécution

La fonctionnalité de géotraitement d'une tâche de géotraitement peut être relativement simple et ne prendre que quelques secondes pour s'exécuter sur le serveur ; elle peut également être plus complexe, traiter des jeux de données volumineux et s'exécuter plus lentement. En conséquence, l'API REST offre deux options d'exécution de tâche sur le serveur.

1. Synchrone : ce mode d'exécution convient aux tâches qui s'exécutent rapidement. Avec les tâches synchrones, le client envoie une requête d'exécution de la tâche et les résultats sont renvoyés au client sous forme de réponse.
2. Asynchrone : ce mode d'exécution convient aux tâches qui s'exécutent plus lentement. Avec les tâches asynchrones, le serveur renvoie un identifiant de tâche que le client utilise pour interroger le serveur sur l'état de la tâche. Lorsque l'état est Terminé, les résultats sont créés en tant que ressources enfant de la tâche. Le client peut alors y accéder à l'aide de l'identifiant de tâche.

Serveur de carte de résultats

Un serveur de carte de résultats est un service de carte dynamique qui accompagne un service de géotraitement, et qui est destiné à visualiser les résultats de géotraitement. Chaque paramètre en sortie de jeu de données géographiques d'une tâche de géotraitement est ajouté au service de carte en tant que couche. La visualisation des couches est déterminée par la symbologie définie au moment de la publication. Comme il s'agit d'un service de carte dynamique, les clients peuvent ajouter le service de carte, ou les couches du service de carte, à des applications Web. Ils peuvent également effectuer des opérations, telles que Identifier, Rechercher ou Exporter la carte dans le service de carte et effectuer des requêtes, générer des moteurs de rendu et accéder aux entités dans les couches du service.

Nombre maximal d'enregistrements

La propriété Nombre maximal d'enregistrements détermine le nombre d'entités ou d'enregistrements en sortie renvoyés par le service. Si le nombre maximal d'entités ou d'enregistrements en sortie créés par une tâche de géotraitement dépasse la valeur du paramètre Nombre maximal d'enregistrements, le service ne renvoie rien. L'examen de la propriété Limite de transfert dépassée du jeu d'entités ou du jeu d'enregistrements renvoyée par la tâche permet d'identifier de telles situations. La propriété Limite de transfert dépassée est définie sur "true" quand le nombre d'enregistrements et d'entités du paramètre en sortie dépasse le nombre maximal d'enregistrements spécifié par le service.

Affichage de la page du service dans un navigateur Web

Chaque serveur ArcGis dispose d'un répertoire de services, accessible via une URL, et chaque service hébergé sur le serveur est doté de sa propre page, également accessible via une URL. Les propriétés du service REST de géotraitement décrites plus haut peuvent être consultées sur la page du service, dans un navigateur Web. La page du service est principalement utilisée par les développeurs Web pour prendre connaissance des fonctionnalités du service. Même si vous n'êtes pas développeur Web, la page d'un service peut vous aider à comprendre comment les décisions que vous prenez, quand vous publiez un service, affectent la façon dont les développeurs Web utilisent votre service et les tâches associées.

Après avoir publié un service de géotraitement avec succès dans ArcGIS for Desktop, un nouveau service de géotraitement est ajouté à votre connexion au serveur ArcGIS, dans la fenêtre Catalogue. Pour accéder à la page de votre service, cliquez avec le bouton droit de la souris et sélectionnez Propriétés du service. L'Editeur de services s'ouvre. Dans l'Editeur de services, cliquez sur l'onglet Géotraitement, sous Fonctionnalités. La valeur URL REST, illustrée ci-dessous, est l'URL qui mène à la page du service.

Copiez et collez l'URL REST dans la barre d'adresses de votre navigateur pour afficher la page du service. Les informations contenues sur la page de l'URL REST sont liées aux propriétés que vous avez définies quand vous avez publié le service de géotraitement. L'illustration ci-dessous contient les propriétés qui ont été spécifiées dans l'Editeur de services, lors de la publication, et les propriétés correspondantes, telles qu'affichées sur la page du service.

Notez que, dans le navigateur Web, les tâches de géotraitement du service sont répertoriées sous forme de liens HTML. Chaque lien conduit à une page de tâche, sur laquelle vous trouverez des informations relatives aux propriétés de la tâche et aux opérations qu'elle prend en charge.

Pour en savoir plus sur les pages de tâche dans le répertoire du service