API de gestion du cycle de vie des CI

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 34 minutes de lecture

    • L’API de gestion du cycle de vie des CI fournit des points de terminaison pour manipuler les états opérationnels des éléments de configuration (CI) et appliquer des actions de CI.

    Les interfaces d’API respectent les restrictions et les autorisations spécifiées par les actions de CI non autorisées, les actions de CI compatibles et les transitions opérationnelles non autorisées. Si une interface tente une opération restreinte, l’opération est bloquée, une erreur est consignée et une tâche est créée le cas échéant.

    Gestion du cycle de vie des CI : SUPPRIMER /now/cilifecyclemgmt/actions

    Supprime une action d’élément de configuration (CI) pour une liste de CI.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/actions

    URL par défaut : /api/now/cilifecyclemgmt/actions

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de l’élément de configuration.

    Type de données : chaîne
    ID du demandeur Requis. Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    sysIds Requis. Liste des sys_ids de CI séparées par des virgules.

    Type de données : chaîne
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’action de CI a été supprimée avec succès.
    Valeurs possibles :
    • vrai : l’action du CI a été supprimée.
    • faux : l’action de CI n’a pas été supprimée.

    Type de données : chaîne

    Demande cURL

    Supprimer une action de CI de deux CI.

    curl --request DELETE \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
--header 'Accept: application/json' \
--user "username":"password"

    Le corps de réponse confirme que l’action de CI a été supprimée des CI.

    {
  "result": {
    "result": true
  }
}

    Gestion du cycle de vie des CI : SUPPRIMER /now/cilifecyclemgmt/operators/{req_id}

    Annule l’inscription d’un opérateur pour les utilisateurs qui ne font pas partie d’un workflow.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

    URL par défaut : /api/now/cilifecyclemgmt/operators/{req_id}

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Paramètre Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    req_id Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    Néant
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’opérateur a été désinscrit avec succès.
    Valeurs possibles :
    • true : l’inscription de l’opérateur a bien été annulée.
    • false : l’opérateur n’a pas été désinscrit.

    Type de données : chaîne

    Demande cURL

    Annuler l’inscription d’un opérateur par ID d’utilisateur.

    curl --request DELETE \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
--header "Accept: application/json" \
--user "username":"password"

    L’organisme de réponse vérifie que l’opérateur n’était pas enregistré.

    {
  "result": {
    "result": true
  }
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/actions/{sys_id}

    Renvoie une liste d’actions d’élément de configuration (CI) actives pour le CI spécifié.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

    URL par défaut : /api/now/cilifecyclemgmt/actions/{sys_id}

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id du CI dont les actions CI associées doivent être renvoyées.

    Type de données : chaîne
    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 16. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 18. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.ciActions de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.ciActions Liste séparée par des virgules des actions de CI actives pour le CI, ou no_active_action si aucune n’a été trouvée.

    Type de données : chaîne
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si la liste des actions de CI actives a été renvoyée pour tous les CI spécifiés.
    Valeurs possibles :
    • vrai : la liste des actions de CI actives a été renvoyée.
    • faux : la liste des actions de CI actives n’a pas été renvoyée.

    Type de données : chaîne

    Demande cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
--header 'Accept: application/json' \
--user "username":"password"

    Le corps de la réponse indique qu’aucune action de CI n’est active pour le CI spécifié.

    {
  "result": {
    "ciActions": [
      "no_active_action"
    ],
    "result": true
  }
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/compatActions

    Détermine si deux actions d’élément de configuration (CI) spécifiées sont compatibles.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/compatActions

    URL par défaut : /api/now/cilifecyclemgmt/compatActions

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 20. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de CI à comparer.

    Type de données : chaîne
    otherActionName Requis. Nom de l’action de CI à comparer.

    Type de données : chaîne
    Tableau 21. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 22. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 23. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 24. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Marqueur indiquant si les deux actions de CI spécifiées sont compatibles.
    Valeurs possibles :
    • vrai : les actions de CI sont compatibles.
    • faux : les actions de CI ne sont pas compatibles.

    Type de données : chaîne

    Demande cURL

    Vérifiez la compatibilité des actions de CI d’application de correctif et de mise en service.

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
--header 'Accept: application/json' \
--user "username":"password"

    Le corps de la réponse confirme que les deux actions de CI sont compatibles.

    {
  "result": true
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/leases/{sys_id}/expired

    Détermine si le bail a expiré pour le demandeur d’une action d’élément de configuration (CI) appliquée au CI spécifié.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

    URL par défaut : /api/now/cilifecyclemgmt/leases/{sys_id}/expired

    Paramètres de demande pris en charge

    Tableau 25. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id du CI qui est la cible de l’action de CI appliquée.

    Type de données : chaîne
    Tableau 26. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de CI appliquée au CI spécifié.

    Type de données : chaîne
    ID du demandeur Requis. Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    Tableau 27. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 28. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 29. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 30. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si le bail du demandeur de l’action de CI appliquée a expiré.
    Valeurs possibles :
    • true : le bail du demandeur a expiré.
    • false : le bail du demandeur n’a pas expiré.

    Type de données : chaîne

    Demande cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
--header 'Accept: application/json' \
--user "username":"password"

    Le corps de la réponse indique que le bail du demandeur de l’action de CI appliquée n’a pas expiré.

    {
  "result": {
    "result": false
  }
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/notAllowedAction

    Détermine si une action d’élément de configuration (CI) spécifiée n’est pas autorisée pour un CI d’une classe spécifiée lorsqu’il se trouve dans un état opérationnel spécifié.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/notAllowedAction

    URL par défaut : /api/now/cilifecyclemgmt/notAllowedAction

    Paramètres de demande pris en charge

    Tableau 31. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 32. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de CI à vérifier.

    Type de données : chaîne
    ciClass Requis. Classe CI.

    Type de données : chaîne
    Étiquette op Requis. État opérationnel à vérifier.

    Type de données : chaîne
    Tableau 33. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 34. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 35. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 36. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Marqueur indiquant si l’action de CI est restreinte (non autorisée) pour les CI du type spécifié lorsqu’ils sont dans l’état opérationnel spécifié.
    Valeurs possibles :
    • vrai : l’action de CI est restreinte (non autorisée).
    • faux : l’action de CI n’est pas restreinte (autorisée).

    Type de données : chaîne

    Demande cURL

    Vérifiez si l’action Appliquer un correctif au CI est restreinte (non autorisée) pour les ordinateurs dont l’état opérationnel est Récupération d’urgence en veille.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    Le corps de réponse confirme que cette action est restreinte (non autorisée) pour la classe CI spécifiée lorsqu’elle se trouve dans l’état opérationnel spécifié.

    {
  "result": true
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/notAllowedOpsTransition

    Détermine si un élément de configuration (CI) d’une classe spécifiée peut passer d’un état opérationnel spécifié à un deuxième état opérationnel spécifié.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

    URL par défaut : /api/now/cilifecyclemgmt/notAllowedOpsTransition

    Paramètres de demande pris en charge

    Tableau 37. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 38. Paramètres de requête
    Nom Description
    ciClass Requis. Classe CI pour laquelle vérifier les restrictions de transition.

    Type de données : chaîne
    Étiquette op Requis. Étiquette de l’état opérationnel du CI actuel.

    Type de données : chaîne
    transitionOpsLabel (en anglais seulement) Requis. Étiquette de l’état opérationnel qui est la cible de la transition.

    Type de données : chaîne
    Tableau 39. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 40. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 41. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 42. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Marqueur indiquant si la transition d’état opérationnel spécifiée est restreinte (non autorisée) pour la classe CI spécifiée.
    Valeurs possibles :
    • true : la transition d’état opérationnel est restreinte (non autorisée).
    • false : la transition d’état opérationnel est illimitée (autorisée).

    Type de données : chaîne

    Demande cURL

    Vérifiez si la transition de l’état opérationnel Mis hors service à l’état opérationnel Récupération d’urgence en veille est restreinte (non autorisée) pour les CI de serveur Linux.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    Le corps de la réponse montre que la transition d’état opérationnel spécifiée n’est pas restreinte (autorisée) pour cette classe CI.

    {
  "result": false
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/requestors/{req_id}/valid

    Détermine si l’utilisateur de workflow actif spécifié ou l’utilisateur inscrit est un demandeur valide.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

    URL par défaut : /api/now/cilifecyclemgmt/requestors/{req_id}/valid

    Paramètres de demande pris en charge

    Tableau 43. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    req_id Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    Tableau 44. Paramètres de requête
    Nom Description
    Néant
    Tableau 45. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 46. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 47. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 48. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’utilisateur de workflow actif spécifié ou l’utilisateur inscrit est un demandeur valide.
    Valeurs possibles :
    • true : demandeur valide.
    • false : demandeur non valide.

    Type de données : chaîne

    Demande cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestion du cycle de vie des CI : GET /now/cilifecyclemgmt/statuses/{sys_id}

    Renvoie l’état opérationnel actuel de l’élément de configuration (CI) spécifié.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

    URL par défaut : /api/now/cilifecyclemgmt/statuses/{sys_id}

    Paramètres de demande pris en charge

    Tableau 49. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id du CI.

    Type de données : chaîne
    Tableau 50. Paramètres de requête
    Nom Description
    Néant
    Tableau 51. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 52. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 53. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 54. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    result.operationalStates État opérationnel pour le CI spécifié ou inconnu si aucun état n’est spécifié.

    Type de données : chaîne

    Demande cURL

    curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "operationalState": "Repair in Progress",
    "result": true
  }
}

    Gestion du cycle de vie des CI : PATCH /now/cilifecyclemgmt/leases/{sys_id}

    Prolonge le délai d’expiration du bail de l’action d’élément de configuration (CI) spécifiée pour l’utilisateur spécifié.

    Si le bail précédent a expiré, la nouvelle période de bail commence immédiatement.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

    URL par défaut : /api/now/cilifecyclemgmt/leases/{sys_id}

    Paramètres de demande pris en charge

    Tableau 55. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id du CI pour lequel étendre le bail.

    Type de données : chaîne
    Tableau 56. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de CI associée.

    Type de données : chaîne
    leaseTime Requis. Durée pendant laquelle le bail est valide pour l’action de CI spécifiée dans actionName.

    Type de données : chaîne

    Format : HH :MM :SS
    ID du demandeur Requis. Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    Tableau 57. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 58. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 59. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 60. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si la durée du bail a été prolongée.
    Valeurs possibles :
    • true : la durée du bail a été prolongée.
    • false : la durée du bail n’a pas été prolongée.

    Type de données : chaîne

    Demande cURL

    Prolongez de 24 heures la durée du bail d’un demandeur d’action de correctif de CI.

    curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/actions

    Ajoute une action d’élément de configuration (CI) spécifiée à une liste spécifiée de CI.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/actions

    URL par défaut : /api/now/cilifecyclemgmt/actions

    Paramètres de demande pris en charge

    Tableau 61. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 62. Paramètres de requête
    Nom Description
    actionName Requis. Nom de l’action de CI à ajouter à la liste.

    Type de données : chaîne
    leaseTime Durée pendant laquelle le bail est valide pour une action de CI spécifiée.

    Type de données : chaîne

    Format : HH :MM :SS
    oldActionNames Liste séparée par des virgules des anciennes actions de CI dans laquelle tous les CI doivent figurer.

    Type de données : chaîne
    ID du demandeur Requis. Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    sysIds Requis. Liste séparée par des virgules des sys_ids CI auxquels ajouter l’action de CI.

    Type de données : chaîne
    Tableau 63. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 64. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 65. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 66. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’action de CI a été définie pour tous les CI de la liste.
    Valeurs possibles :
    • vrai : des actions de CI ont été définies.
    • faux : les actions de CI n’ont pas été définies.

    Type de données : chaîne

    Demande cURL

    Ajoutez une action de CI d’application de correctif à deux CI.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators

    Enregistre un opérateur pour un utilisateur qui n’est pas un workflow.

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/operators

    URL par défaut : /api/now/cilifecyclemgmt/operators

    Paramètres de demande pris en charge

    Tableau 67. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 68. Paramètres de requête
    Nom Description
    Néant
    Tableau 69. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 70. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 71. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 72. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    result.requestorId GUID pour l’opérateur enregistré. Utilisez cette valeur pour définir les actions du CI et les états opérationnels.

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’opérateur a été enregistré avec succès.
    Valeurs possibles :
    • true : l’opérateur a été enregistré avec succès.
    • false : l’opérateur n’a pas été correctement enregistré.

    Type de données : chaîne

    Demande cURL

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true,
    "requestorId": "6f992b8430121010f877773aa7167c42"
  }
}

    Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/statuses

    Définit l’état opérationnel d’une liste spécifiée d’éléments de configuration (CI).

    Format d'URL

    URL versionnée : /api/now/{api_version}/cilifecyclemgmt/statuses

    URL par défaut : /api/now/cilifecyclemgmt/statuses

    Paramètres de demande pris en charge

    Tableau 73. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 74. Paramètres de requête
    Nom Description
    Étiquettes oldOpsÉtiquettes Liste séparée par des virgules des anciens états opérationnels de CI dans lesquels tous les CI doivent être inclus.

    Type de données : chaîne
    Étiquette op Requis. Étiquette de l’état opérationnel à définir pour les CI spécifiés.

    Type de données : chaîne
    ID du demandeur Requis. Sys_id d’un contexte de workflow ou d’un ID utilisateur d’opérateur renvoyé par le Gestion du cycle de vie des CI : POST /now/cilifecyclemgmt/operators point de terminaison.

    Les ID utilisateur des opérateurs se trouvent dans la table Utilisateurs avec état de CI [statemgmt_register_users].

    Type de données : chaîne
    sysIds Requis. Liste séparée par des virgules des sys_ids de CI dont l’état opérationnel doit être défini.

    Type de données : chaîne
    Tableau 75. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 76. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 77. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 78. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès par le point de terminaison.

    Examinez le paramètre du corps result.result de la réponse pour vérifier le résultat de l’opération.

    Si le point de terminaison rencontre des erreurs lors du traitement de la demande, des codes et messages d’erreur s’affichent dans le paramètre du corps result.errors de la réponse.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Objet encapsulant le résultat de la demande.

    Type de données : objet

    "result": {
  "errors": [Array],
  "result": "String"
}
    erreur.résultats Liste des objets dans lesquels chaque objet représente une erreur rencontrée lors du traitement de la demande.

    Type de données : tableau

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    résultat.erreurs.erreur Identificateur d’une erreur de gestion des états survenue lors du traitement de la demande.
    Valeurs possibles :
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBLE_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Type de données : chaîne
    result.errors.message Message fournissant des détails sur le fichier .error

    Type de données : chaîne
    résultat.résultat Marqueur indiquant si l’état souhaité a été défini pour tous les CI inclus dans la demande.
    Valeurs possibles :
    • true : état opérationnel défini.
    • false : état opérationnel non défini.

    Type de données : chaîne

    Demande cURL

    Définissez l’état opérationnel Réparation en cours pour deux CI.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

    Le corps de la réponse indique que l’état opérationnel souhaité a été défini pour les deux CI spécifiés dans la demande.

    {
  "result": {
    "result": true
  }
}