Extraire l'API

Editer en ligne

Vous pouvez utiliser l'API Extract pour récupérer des données de Maximo Inventory Optimization en vue d'une analyse plus approfondie, d'un stockage ou d'une intégration dans d'autres systèmes tels que des lacs de données ou des systèmes ERP. Cette API prend en charge l'extraction de données pour différentes périodes, la pagination et le filtrage, ce qui offre une certaine souplesse dans la manière dont vous récupérez et gérez un grand ensemble de données.

Aperçu

L'API d'extraction permet d'accéder aux types de données suivants.

Exportations
Données exportées vers le système ERP du client.
Instantanés
Données représentant l'état du système à des moments précis, par exemple à la fin du mois ou lors de l'actualisation des deltas.
Données principales
L'état actuel des données, par exemple, les données sur les articles, les données sur les articles du point de vente, les problèmes, les reçus.

Noeuds finaux

L'API d'extraction offre plusieurs points d'accès pour récupérer des métadonnées et des données pour les catégories d'informations suivantes.
Exportations
Les exportations représentent les données exportées de Maximo Inventory Optimization vers le système ERP du client.
  • Le point de terminaison " GET /dataapi/extract/meta/exports renvoie des métadonnées sur tous les profils d'exportation, y compris des détails tels que les clés de profil, les noms de colonnes et les descriptions.
  • Le point de terminaison " GET /dataapi/extract/meta/exports/{profile} renvoie des métadonnées pour un profil d'exportation spécifique. Les métadonnées comprennent les noms des colonnes, les types de données et les descriptions.
  • Le GET /dataapi/extract/data/exports/{profile} point de terminaison renvoie un fichier CSV contenant les données exportées pour un profil spécifique. Par défaut, toutes les données exportées depuis la dernière actualisation de fin de mois (EOM) sont renvoyées.
Instantanés
Les instantanés capturent l'état des données à des moments précis, généralement à la fin de chaque mois.
  • Le " GET /dataapi/extract/meta/snapshot/items renvoie des métadonnées pour les instantanés d'éléments. Ces métadonnées comprennent les champs disponibles dans l'instantané de l'élément.
  • Le " GET|POST /dataapi/extract/data/snapshot/items renvoie les données de l'instantané de l'article pour la plage de dates spécifiée. Une demande POST peut être faite pour limiter le nombre de colonnes renvoyées.
  • Le " POST /dataapi/extract/data/snapshot/items/filter renvoie les données de l'instantané de l'article avec les filtres avancés appliqués. Des filtres sont appliqués au tableau " SET_ITEM.
  • Le " GET /dataapi/extract/meta/snapshot/storeitems renvoie des métadonnées pour les instantanés d'articles de magasin.
  • Le " GET|POST /dataapi/extract/data/snapshot/storeitems renvoie les données de l'instantané de l'article du magasin pour la plage de dates spécifiée. Une requête " POST peut limiter le nombre de colonnes renvoyées.
  • Le point d'accès " POST /dataapi/extract/data/snapshot/storeitems/filter renvoie des données instantanées sur les articles du magasin avec des filtres appliqués, vérifiés par rapport à la table " SET_ITEM
  • Le point de terminaison " GET /dataapi/extract/meta/snapshot/deltaitems renvoie des métadonnées pour les instantanés d'éléments delta.
  • Le point de terminaison " GET|POST /dataapi/extract/data/snapshot/deltaitems renvoie les données de l'instantané de l'élément delta pour la plage de dates spécifiée. Une requête " POST peut limiter le nombre de colonnes renvoyées.
  • Le point de terminaison " POST /dataapi/extract/data/snapshot/deltaitems/filter renvoie les données de l'instantané de l'élément delta avec les filtres appliqués, vérifiés par rapport à la table " SET_ITEM.
Données principales
Les données principales représentent l'état actuel des articles, des articles de magasin, des problèmes et des entrées.
  • Le point de terminaison " GET /dataapi/extract/meta/items renvoie des métadonnées pour les données de l'élément, y compris les colonnes disponibles et les descriptions.
  • Renvoie GET|POST /dataapi/extract/data/items les données de l'élément au format CSV. Une demande de " POST peut être faite pour limiter le nombre de colonnes renvoyées.
  • Le point de terminaison " POST /dataapi/extract/data/items/filter renvoie les données des articles avec des filtres avancés, vérifiés par rapport à la table " SET_ITEM
  • Le point d'accès " GET /dataapi/extract/meta/storeitems renvoie des métadonnées pour les données des articles du magasin.
  • Le GET|POST /dataapi/extract/data/storeitems point de terminaison renvoie les données relatives aux articles du magasin au format CSV. Une demande de " POST peut être faite pour limiter le nombre de colonnes renvoyées.
  • Le point de terminaison " POST /dataapi/extract/data/storeitems/filter renvoie les données des articles du magasin avec des filtres avancés, vérifiés par rapport à la table " SET_ITEM
  • Le point de terminaison " GET /dataapi/extract/meta/issues renvoie des métadonnées pour les données relatives aux émissions.
  • Le GET|POST /dataapi/extract/data/issues point de terminaison renvoie les données d'émission au format CSV. Une demande de " POST peut être faite pour limiter le nombre de colonnes renvoyées.
  • Le point de terminaison " POST /dataapi/extract/data/issues/filter renvoie les données de la question avec des filtres avancés appliqués, vérifiés par rapport au tableau " BASE_ISSUE.
  • Le point de terminaison " GET /dataapi/extract/meta/receipts renvoie des métadonnées pour les données de réception.
  • Le GET|POST /dataapi/extract/data/receipts point de terminaison renvoie les données de reçu au format CSV. Une demande POST peut être faite pour limiter le nombre de colonnes renvoyées.
  • Le point de terminaison " POST /dataapi/extract/data/receipts/filter renvoie les données de réception avec des filtres avancés appliqués, vérifiés par rapport au tableau " BASE_RECEIPT.

Paramètres clés

Paramètres de la plage de dates
  • à partir de Spécifie le début de la période d'extraction des données (inclus). Il utilise le format ISO 8601, qui est YYYY-MM-DDTHH:mm:ss.sss.
  • Spécifie la fin de la période d'extraction des données (exclusive). Si elle n'est pas fournie, la date et l'heure actuelles sont utilisées.
Type et période de rafraîchissement
  • refreshType Définit le type d'actualisation des données.
  • eom Renvoie une actualisation de fin de mois.
  • delta Renvoie delta, ou des actualisations incrémentielles.
Période
  • Le nombre indique le nombre de périodes à inclure.
  • Chaîne prédéfinie
    • current Renvoie les données depuis la dernière actualisation.
    • last Renvoie les données de la période précédente.
    • all Renvoie toutes les données disponibles. A utiliser avec précaution car il peut renvoyer un grand ensemble de données.
Filtre avancé
Applique des conditions complexes aux données. des filtres codés plain text ou " base64peuvent être utilisés. Le drapeau " filterEncoded indique si le filtre est codé en " base64

Formats de données

Format de réponse
Par défaut, l'API renvoie les données au format " .csv Le fichier " .CSV peut être compressé en option en fixant l'en-tête Accept-Encoding à " GZIP.
Format des métadonnées
Les métadonnées sont renvoyées dans le format " .json, qui comprend les noms des colonnes, les types et les descriptions.

En-têtes de requête

Lorsque vous faites des demandes à l'API, en particulier lorsque vous téléchargez un grand ensemble de données, incluez l'en-tête suivant.

Accept-Encoding: gzip

Ce paramètre compresse le contenu pour réduire la quantité de données transférées, ce qui peut accélérer le téléchargement.

Exemple de cas d'utilisation

Aperçu mensuel des données
Vous pouvez utiliser l'API pour extraire les données du dernier mois, par exemple du 1er juillet 2021 au 1er août 2021. En utilisant les paramètres " refreshType=eom et " period=1, l'API renvoie un instantané des données du mois précédent.
Changements en temps réel
Pour extraire uniquement les changements survenus depuis la dernière actualisation, utilisez " refreshType=delta et " period=0. Ces paramètres peuvent être utiles pour les applications qui doivent suivre des changements incrémentaux.
Exportations filtrées
En utilisant la méthode " POST, vous pouvez spécifier uniquement les colonnes dont vous avez besoin, ce qui réduit la quantité de données transférées et peut rendre le processus plus efficace.

Traitement des erreurs

HTTP 429 - Too Many Requests

Cette erreur se produit si plusieurs demandes d'extraction sont effectuées simultanément. Une seule demande d'extraction peut être en cours à la fois.