API REST pour la gestion des contrats

Avec l'API /api/sam/v2/contracts.json, vous pouvez importer et exporter des données de contrat avec des informations d'achat. Cette opération est utilisée pour automatiser l'intégration à des systèmes d'achat externes. Vous pouvez également gérer les contrats à l'aide des éléments suivants : importation de CSV de contrats, interface utilisateur - Panneau Tous les contrats et migration des contrats obsolètes.

Vérifiez les limitations liées à l'ajout et la mise à jour de contrats avant d'utiliser l'API.

Permissions

Utilisateur Vous devez disposer du droit Gérer les contrats, ainsi que de l'accès au groupe d'ordinateurs du contrat.

URL de la ressource

https://hostname:port/api/sam/v2/contracts?token=<token>

Syntaxe

GET /api/sam/v2/contracts.json

Description de schéma

/api/sam/v2/schemas/contract.json

Association

Colonnes disponibles


Nom de colonne	Description	Importance
contract_id	Identificateur du contrat. Un contrat est mis à jour uniquement lorsqu'un ID de contrat est disponible. L'ID de contrat doit être unique parmi tous les contrats. Sur l'interface utilisateur, il est généré automatiquement. Type : chaîne	Obligatoire
nom	Nom du contrat. Type : chaîne	Facultatif
type	Type du contrat : 1 - Licence, 2 - Support, 3 - Service, 4 - Matériel, 5 - Autre. Type : entier	Facultatif
threshold	Seuil pour la valeur mesurée par le contrat. Le mot clé est facultatif. Type : entier	Facultatif
computer_group	Objet de groupe d'ordinateurs du contrat. Pour vérifier la liste des colonnes de groupe d'ordinateurs, voir computer_group.	Facultatif
metric	Objet de groupe de métriques du contrat. Pour vérifier la liste des colonnes de métriques, voir métrique.	Facultatif
purchase_order	Tableau de bons de commande affectés au contrat. Pour consulter la liste des colonnes de bons de commande, voir purchase_orders.	Facultatif
software_products	Tableau de produits logiciels affectés au contrat. Pour consulter la liste des colonnes de produits logiciel, voir software_product.	Facultatif

Remarque : Toutes les associations, computer_group, métriques, purchase_order et software_product sont facultatives. Si une association computer_group n'est pas fournie et que le contrat est en cours de création, le groupe Tous les ordinateurs est utilisé.

Indicateurs disponibles

Pour obtenir la liste des métriques disponibles, voir ID et noms de code de métrique et 10.0.4 API REST pour la gestion des métriques de licence. Les métriques non applicables aux contrats sont les suivantes : INTERNAL_PVU, INTERNAL_RVU_MAPC.

Si aucune colonne n'est fournie dans la demande de contrat, les données du contrat associé ne sont pas modifiées.
Pour effacer une zone, utilisez une valeur null, telle que "contract_custom_field_1" : null, "threshold" null.
Si une demande n'est pas valide ou qu'une erreur se produit lors du traitement, aucun contrat ou aucune donnée associée n'est mis à jour et, dans la réponse, une explication détaillée est fournie pour chaque contrat non valide sous "rowErrors". La numérotation des entrées commence à 1.

{
   "incorrectRows":7,
   "allRows":7,
   "message":{"code":"CODUI4099E","text":"Contract processing failed. The contracts have not been imported."},
   "rowErrors":{"1":["|CODUI4047E|Required field contract_id is empty",
   "|CODUI4057E|Custom field with ID 2 is required"],"2":
   [
     "|CODUI4057E|Custom field with ID 2 is required"],
    "3":
     [
      "|CODUI4042E|A contract with the specified contract ID already exists",
      "|CODUI4057E|Custom field with ID 2 is required"],"4":["|CODUI4057E|Custom field with ID 2 is required"],
      "5":["|CODUI4057E|Custom field with ID 2 is required"],"6":["|CODUI4057E|Custom field with ID 2 is required"],
      "7":["|CODUI4040E|A contract with the specified name and type already exists"
    ]
  }
}