API de mise en production de produits digitaux

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 38 minutes de lecture
  • L’API de mise en production de produits digitaux fournit des points de terminaison pour gérer les mises en production et la conformité aux politiques.

    Cette API nécessite l’application Mise en production de produits digitaux (sn_dpr), qui est disponible sur le ServiceNow Store. Pour plus d'informations, consultez Digital Product Release.

    Mise en production de produits digitaux : GET /sn_dpr/digital_product_release/bundle/{sysId}

    Récupère les détails de l’ensemble de la mise en production.

    Ce point de terminaison peut être étendu pour personnaliser les champs et les données agrégées renvoyés dans le corps de la réponse. La fonctionnalité par défaut de ce point de terminaison est définie par la méthode getReleaseBundleDetails() dans l’include de script ReleaseBundleSNC . Pour personnaliser la fonctionnalité, remplacez la méthode getReleaseBundleDetails() dans l’include de script ReleaseBundle, qui étend ReleaseBundleSNC. Par défaut, les données agrégées concernant les améliorations, les politiques, les états de mise en production et le nombre de tâches peuvent être incluses dans le corps de la réponse.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin
    • sn_dpr_model.release_coordinator
    • sn_dpr_model.release_user

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/bundle/{sysId}

    URL par défaut : /api/sn_dpr/digital_product_release/bundle/{sysId}

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    sysId Sys_id de l’ensemble de mise en production.

    Table : ensemble de mise en production [sn_dpr_model_release_bundle]

    Type de données : chaîne

    Tableau 2. Paramètres de requête
    Nom Description
    sendAggregation Marqueur indiquant s’il faut inclure des données agrégées pour les améliorations, les politiques, les états de mise en production et les nombres de tâches dans le corps de la réponse.

    Type de données : booléennes

    Valeurs valides :
    • vrai : renvoie les agrégats pour les améliorations, les politiques, les états de mise en production et le nombre de tâches.
    • false : ne renvoie pas d’agrégats.

    Valeur par défaut : false

    Tableau 3. Paramètres du corps de la demande (JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Autorisation Jeton de base ou de porteur pour l’authentification.
    Tableau 5. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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

    Nom Description
    Agrégats Données agrégées pour les améliorations, les politiques, les états de mise en production et le nombre de tâches.

    Ce paramètre n’est inclus dans le corps de la réponse que si le paramètre de sendAggregation requête est défini sur vrai dans la demande.

    "aggregates": {
       "enhancementAggregate": {Object},
       "policyAggregate": {Object},
       "releaseAggregate": {Object},
       "taskAggregate": {Object}
    }

    Type de données : objet

    agrégats.agrégation.amélioration Répertorie le nombre d’améliorations dans chaque état.

    Type de données : objet

    "enhancementAggregate": {
       "Closed": Number,
       "Open": Number
    }
    agrégats.agrégat.politique Répertorie le nombre de politiques dans chaque état d’exécution.

    Type de données : objet

    "policyAggregate": {
       "Executed": Number,
       "Pending": Number
    }
    agrégats.agrégats.libérations Répertorie le nombre de versions dans chaque état. Les états ne sont inclus dans cet objet que si au moins une mise en production est dans cet état.

    Type de données : objet

    "releaseAggregate": {
       "Cancelled": Number,
       "Completed": Number,
       "Draft": Number,
       "In Progress": Number,
       "Pending": Number,
       "Restarting": Number,
       "Review": Number 
    }
    agrégats.agrégats.tâcheAgrégat Répertorie le nombre de tâches approuvées et non approuvées.

    Type de données : objet

    "taskAggregate": {
       "approval": Number,
       "nonApproval": Number
    }
    nom Nom de l’ensemble de mise en production.

    Type de données : chaîne

    propriétaire Propriétaire de l’ensemble de mise en production.

    Type de données : chaîne

    Versions Données sur les versions incluses dans l’ensemble.
    "releases": {
       "count": Number,
       "list": [Array]
    }

    Type de données : objet

    releases.count Nombre de versions incluses dans l’ensemble.

    Type de données : nombre

    Releases.List Liste des sys_ids de mises en production incluses dans l’ensemble.

    Table : version [sn_dpr_model_release]

    Type de données : tableau

    sysId Sys_id de l’ensemble de mise en production.

    Table : ensemble de mise en production [sn_dpr_model_release_bundle]

    Type de données : chaîne

    Demande cURL

    Cet exemple récupère les détails d’un ensemble de mises en production spécifié, y compris les données agrégées concernant les améliorations, les politiques, les états de mise en production et le nombre de tâches.

    curl -X GET \ "https://instance.service-now.com/api/sn_dpr/v1/digital_product_release/bundle/9d0d0b4c874b1110dba83d5ebf867de2?sendAggregation=true" \
    --header "Accept: application/json" \ 
    --header "Authorization: Basic <base64encoded-credentials>"

    Corps de la réponse.

    {
       "sysId": "9d0d0b4c874b1110dba83d5ebf867de2",
       "name": "Release Bundle Q4",
       "owner": "jane.doe",
       "releases": {
          "count": 2,
          "list": ["rel1", "rel2"]
       },
       "aggregates": {
          "releaseAggregate": {
             "In Progress": 1,
             "Completed": 1
          },
          "taskAggregate": {
             "approval": 3,
             "nonApproval": 5
          },
          "policyAggregate": {
             "Executed": 2,
             "Pending": 1
          },
          "enhancementAggregate": {
             "Open": 1,
             "Closed": 1
          }
       }
    }

    Mise en production de produits digitaux : GET /sn_dpr/digital_product_release/releases/{releaseId}/policies/status

    Obtient les détails d’exécution de la politique par produit pour la phase actuelle d’une mise en production.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin
    • sn_dpr_model.release_coordinator
    • sn_dpr_model.release_user

    Avant d’appeler ce point de terminaison, l’état de la mise en production doit être En cours et l’état de la phase actuelle doit également être En cours. Vous pouvez afficher les informations de mise en production dans l’onglet Mise en production de produits digitaux Espace de travailMises en production .

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/releases/{releaseId}/policies/status

    URL par défaut : /api/sn_dpr/digital_product_release/releases/{releaseId}/policies/status

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    releaseId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 8. Paramètres de requête
    Nom Description
    Néant
    Tableau 9. Paramètres du corps de la demande (JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Tableau 11. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Objet contenant un résumé de la conformité et des détails sur la politique du produit.

    Type de données : objet

    "result": {
       "overallSummary": {Object},
       "products": [Array]
    }
    résultat.globalSummary Résumé de la conformité de la politique pour la phase de mise en production actuelle.

    Type de données : objet

    "overallSummary": {
       "compliant": Boolean,
       "compliantCount": Number,
       "currentPhase": "String",
       "nonCompliantCount": Number,
       "timestamp": "String",
       "totalCount": Number
    }
    résultat.résuméglobal.conforme Marqueur indiquant si toutes les politiques évaluées pour la phase de mise en production actuelle sont conformes.
    Valeurs valides :
    • vrai : toutes les politiques évaluées sont conformes.
    • faux : toutes les politiques évaluées ne sont pas conformes.

    Type de données : booléennes

    résultat.globalSummary.compliantCount Nombre de politiques conformes.

    Type de données : nombre

    résultat.résuméglobal.phase actuelle Nom de la phase de mise en production actuelle.

    Type de données : chaîne

    résultat.globalSummary.nonCompliantCount Nombre de politiques non conformes.

    Type de données : nombre

    résultat.globalSummary.timestamp Date et heure de la dernière évaluation de la conformité à la politique.

    Type de données : chaîne

    résultat.globalSummary.totalCount Nombre total de politiques évaluées.

    Type de données : nombre

    résultat.produits Liste des résultats de conformité au niveau des produits.

    Chaque objet du tableau représente un produit.

    Type de données : tableau

    "products": [
       {
          "policyExecutionDetails": [Array],
          "productId": "String",
          "productName": "String",
          "productVersion": "String",
          "summary": {Object}      
       }
    ]
    résultat.produits.politiquesDétails de l’exécution Liste des politiques exécutées avec des résultats de conformité.

    Chaque objet du tableau représente une politique.

    Type de données : tableau

    "policyExecutionDetails": [
       {
          "executionOutput": "Check sum OK; 0 violations. Execution log id: e23-9a.",
          "lastRunAt": "2025-09-26T08:30:00Z",
          "name": "Policy Name 1",
          "policyId": "policyVersionSysId1",
          "reason": "All checks passed",
          "status": "compliant"  
       }
    ]
    résultat.produits.détailsexécutionpolitique.sortieexécution Message de sortie produit par l’exécution de la politique.

    Type de données : chaîne

    résultat.produits.policyExecutionDetails.lastRunAt Date et heure de la dernière évaluation de conformité de la politique.

    Type de données : chaîne

    result.products.policyExecutionDetails.name Nom d’affichage de la politique.

    Type de données : chaîne

    résultat.produits.policyExecutionDetails.policyId Sys_id de la politique.

    Table : Politique [sn_pace_policy]

    Type de données : chaîne

    résultat.produits.détailsexécutionpolitique.motif Message expliquant le motif de conformité ou de non-conformité de la politique.

    Type de données : chaîne

    résultat.produits.détailsd’exécutionpolitique.état État de conformité de la politique.
    Valeurs valides :
    • Conforme
    • non_compliant
    • not_run

    Type de données : chaîne

    résultat.produits.productId Sys_id du produit.

    Table : Modèle de produit [cmdb_model]

    Type de données : chaîne

    résultat.produits.nom du produit Nom d’affichage du produit.

    Type de données : chaîne

    résultat.produits.versionproduit Version associée au produit pour la version actuelle.

    Type de données : chaîne

    résultat.produits.résumé Résultats de conformité pour le produit.

    Type de données : objet

    "summary": {
       "compliant": Boolean,
       "compliantCount": Number,
       "nonCompliantCount": Number,
       "totalCount": Number
    }
    Résultat.Produits.Résumé.Conforme Marqueur indiquant si toutes les politiques du produit sont conformes.
    Valeurs valides :
    • vrai : toutes les politiques sont conformes.
    • faux : toutes les politiques ne sont pas conformes.

    Type de données : booléennes

    nombres de résultats.produits.résumés.conformes Nombre de politiques conformes.

    Type de données : nombre

    résultat.produits.synthèse.nonconformeNombres Nombre de politiques non conformes.

    Type de données : nombre

    résultat.produits.synthèse.totalnombre Nombre total de politiques évaluées pour le produit.

    Type de données : nombre

    Demande cURL

    Cet exemple obtient les détails d’exécution de la politique pour la phase actuelle de la mise en production spécifiée.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/releases/d4982eeb474b621027d48b41516d4385/policies/status" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    Corps de la réponse.

    {
       "result": {
          "overallSummary": {
             "compliant": false,
             "compliantCount": 3,
             "nonCompliantCount": 2,
             "totalCount": 5,
             "currentPhase": "Phase Name",
             "timestamp": "2025-09-26T09:15:00Z"
          },
          "products": [
             {
                "productId": "f8fe5fd40a0a0b9100f91d64df145295",
                "productName": "Payments Service",
                "productVersion": "v2.4.1",
                "summary": {
                   "compliant": false,
                   "compliantCount": 1,
                   "nonCompliantCount": 1,
                   "totalCount": 2
                },
                "policyExecutionDetails": [
                   {
                      "name": "Policy Name 1",
                      "policyId": "f6783cc843590210ab16fc4bbcb8f223",
                      "status": "compliant",
                      "lastRunAt": "2025-09-26T08:30:00Z",
                      "executionOutput": "Check sum OK; 0 violations. Execution log id: e23-9a.",
                      "reason": "All checks passed"
                   },
                   {
                      "name": "Policy Name 2",
                      "policyId": "152bb04c43590210ab16fc4bbcb8f2a7",
                      "status": "non_compliant",
                      "lastRunAt": "2025-09-26T08:32:00Z",
                      "executionOutput": "Validation failed at step 3: required configuration missing.",
                      "reason": "Missing required configuration 'payments.retry_limit'"
                   }
                ]
             }
          ]
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/product_enhancement

    Crée une amélioration pour un produit ou un service.

    Pour accéder à ce point de terminaison, l’appelant doit avoir le rôle sn_dpr_model.product_manager.

    Format d'URL

    URL avec version : /api/sn_dpr/{api_version}/digital_product_release/product_enhancement

    URL par défaut : /api/sn_dpr/digital_product_release/product_enhancement

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres du corps de la demande (JSON)
    Nom Description
    description Description de l’amélioration.

    Type de données : chaîne

    nom Requis. Nom de l’amélioration.

    Type de données : chaîne

    Priorité Priorité de l’amélioration.
    Valeurs valides :
    • élevé
    • moyen
    • faible

    Par défaut : moyen

    Type de données : chaîne

    productFeatureSysId Sys_id de la fonctionnalité du produit à associer à l’amélioration.

    Table : Fonctionnalité du produit [sn_dpr_model_product_feature]

    Type de données : chaîne

    productSysId Requis. Sys_id du produit ou du service à associer à l’amélioration.

    Table : modèle d’application [cmdb_application_product_model] ou modèle de service [cmdb_service_product_model]

    Type de données : chaîne

    releaseSysId Sys_id de la mise en production pour ajouter l’amélioration.

    La mise en production doit être associée à la version fournie dans le versionSysId paramètre.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    versionSysId Sys_id de la version du produit ou du service à associer à l’amélioration.

    La version doit correspondre au même produit ou service fourni dans le productSysId paramètre.

    Table : modèle logiciel [cmdb_software_product_model] ou modèle d’offre de service [cmdb_service_offering_model]

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. L’amélioration a été créée avec succès.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "sysId": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.sysId Sys_id de l’amélioration créée.

    Table : Amélioration du produit [sn_dpr_model_product_enhancement]

    Type de données : chaîne

    Demande cURL

    Cet exemple crée une amélioration du produit.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/product_enhancement" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"name\":\"Offline streaming\", 
       \"productSysId\":\"de8e9c0dfff8f2108289ffffffffff61\", 
       \"priority\":\"high\", 
       \"description\":\"Enhancement description\", 
       \"versionSysId\":\"da4b608dff7cf2108289ffffffffffc2\", 
       \"releaseSysId\":\"9a4b608dff7cf2108289ffffffffffc3\", 
       \"productFeatureSysId\":\"192d2905ff7436108289ffffffffff3f\" 
    }" \
    --user 'username':'password'

    Corps de la réponse.

    {
       "result": {
          "error": false,
          "sysId": "76417985ff7436108289ffffffffff5f"
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release

    Crée une version.

    Une mise en production peut être créée en tant que mise en production indépendante ou en tant que mise en production principale qui inclut des mises en production enfants. Ce point de terminaison peut également être utilisé pour faire passer une mise en production existante de l’état Brouillon à l’état En cours.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/release

    URL par défaut : /api/sn_dpr/digital_product_release/release

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    Tableau 20. Paramètres de requête
    Nom Description
    Néant
    Tableau 21. Paramètres du corps de la demande (JSON)
    Nom Description
    autoCreateIncludedVersions Liste des versions de mise en production enfants à créer automatiquement.

    Type de données : tableau

    "autoCreateIncludedVersions": [
       { 
          "product": "String", 
          "version": "String"
       } 
    ]
    autoCreateIncludedVersions.product Sys_id du produit à utiliser pour la version.

    Table : Modèle de produit [cmdb_model]

    Type de données : chaîne

    autoCreateIncludedVersions.version Nom de la version.

    Type de données : chaîne

    autoCreateVersionName Nom de la version à créer automatiquement.

    Type de données : chaîne

    draftReleaseId Sys_id du brouillon de la mise en production.

    Utilisez ce paramètre pour faire passer une mise en production de l’état Brouillon à l’état En cours.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Versions incluses Liste des sys_ids des versions de produits existantes à inclure dans la mise en production.

    Table : modèle de composant système [cmdb_sw_component_model]

    Type de données : tableau

    isDraftRelease

    Marqueur indiquant s’il faut créer la mise en production à l’état Brouillon.

    Valeurs valides :
    • vrai : la mise en production est créée avec l’état défini sur Brouillon.
    • faux : la mise en production est créée avec l’état En cours.

    Valeur par défaut : faux

    Type de données : booléennes

    nom Requis. Nom de la version.

    Type de données : chaîne

    productId Requis. Sys_id du produit.

    Table : Modèle de produit [cmdb_model]

    Type de données : chaîne

    Version du produit Sys_id de la version du produit.

    Table : modèle de composant système [cmdb_sw_component_model]

    Type de données : chaîne

    releaseCalendar Sys_id du calendrier de mise en production.

    Table : Calendrier de mise en production [sn_dpr_model_release_calendar]

    Type de données : chaîne

    Date de mise en production Date de mise en production au format aaaa-MM-jj.

    L’utilisation de ce paramètre crée un enregistrement dans la table Cible de préparation de la mise en production [sn_dpr_model_release_target].

    Type de données : chaîne

    description de mise en production Description de la mise en production.

    Type de données : chaîne

    Propriétaire de mise en production Requis. Sys_id du propriétaire de la mise en production.

    Table : Utilisateur [sys_user]

    Type de données : chaîne

    Cible de mise en production Sys_id de la cible de préparation de la mise en production.

    Table : Cible de préparation à la mise en production [sn_dpr_model_release_target]

    Type de données : chaîne

    ID de modèle Sys_id du modèle à utiliser pour la mise en production.

    Table : Modèle de mise en production [sn_dpr_model_release_template]

    Type de données : chaîne

    validatesVersion Marqueur indiquant si la mise en production valide une version.
    Valeurs valides :
    • vrai : la mise en production valide une version.
    • faux : la mise en production ne valide pas une version.

    Valeur par défaut : faux

    Type de données : booléennes

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 23. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. La mise en production a été créée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "message": "String",
       "progressId": "String",
       "releaseId": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    résultat.progressId ID système du suivi de la progression de la création des versions de mise en production enfants répertoriées dans le autoCreateIncludedVersions paramètre de demande.

    Table : agent d’avancement [sys_progress_worker]

    Type de données : chaîne

    résultat.releaseId Sys_id de la version principale créée.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Demande cURL

    Cet exemple crée une mise en production avec les versions incluses.

    curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{ 
      \"name\": \"Patch Q4\", 
      \"releaseTarget\": \"8071e5f8ff687a10509cffffffffffd9\", 
      \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", 
      \"releaseDescription\": \"Q4 release\", 
      \"productVersion\": \"\", 
      \"templateId\": \"c83134a4ff643a10509cffffffffffb5\", 
      \"releaseDate\": \"\", 
      \"releaseCalendar\": \"\", 
      \"includedVersions\": [ 
        \"39fd3f66ff503610509cffffffffff09\" 
      ], 
      \"productId\": \"c65c372bfb9d5610fdacfe7405efdcd7\", 
      \"autoCreateVersionName\": \"1.2\", 
      \"autoCreateIncludedVersions\": [ 
        { 
          \"product\": \"de66ea3833e966103e8361a9ed5c7b4e\", 
          \"version\": \"1.1\" 
        } 
      ] 
    }" \ 
    --user 'username':'password'

    Corps de la réponse.

    {
      "result": { 
        "error": false, 
        "message": "", 
        "releaseId": "af90e98dff3c3210509cffffffffffc9", 
        "progressId": "f7902d01ffbc3210509cffffffffff7b" 
      } 
    }

    Demande cURL

    Cet exemple fait passer une mise en production existante de l’état Brouillon à l’état En cours.

    curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{ 
      \"name\": \"Q4 2025 Product Release\", 
      \"releaseTarget\": \"077e1ffb97bc4e107bc2341de053afe2\", 
      \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", 
      \"releaseDescription\": \"\", 
      \"productVersion\": \"0ff12581ffbc3210509cffffffffff15\", 
      \"templateId\": \"648c6ca8ffe03a10509cffffffffff11\", 
      \"releaseDate\": \"\", 
      \"releaseCalendar\": \"\", 
      \"includedVersions\": [], 
      \"productId\": \"\", 
      \"autoCreateVersionName\": \"\", 
      \"autoCreateIncludedVersions\": [], 
      \"draftReleaseId\": \"83f12581ffbc3210509cffffffffff16\" 
    }" \ 
    --user 'username':'password'

    Corps de la réponse.

    { 
      "result": { 
        "error": false, 
        "message": "", 
        "releaseId": "83f12581ffbc3210509cffffffffff16" 
      } 
    }

    Demande cURL

    Cet exemple crée une mise en production indépendante.

    curl "http://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{ 
      \"name\": \"Q2 2026 patch\", 
      \"productVersion\": null, 
      \"releaseTarget\": \"008b84a1ffe4ba10509cffffffffff2c\", 
      \"releaseDescription\": \"\", 
      \"releaseOwner\": \"6816f79cc0a8016401c5a33be04be441\", 
      \"productId\": \"012c6d20ff203210229bffffffffff25\", 
      \"autoCreateVersionName\": \"2.4\", 
      \"templateId\": \"648c6ca8ffe03a10509cffffffffff11\", 
      \"releaseDate\": \"\", 
      \"releaseCalendar\": \"\", 
      \"isDraftRelease\": false, 
      \"validatesVersion\": true 
    }" \ 
    --user 'username':'password'

    Corps de la réponse.

    { 
      "result": { 
        "error": false, 
        "message": "", 
        "releaseId": "c6f52181ffbc3210509cffffffffffc0" 
      } 
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release/{releaseId}/key_date

    Crée une date clé pour une mise en production.

    Les dates clés sont utilisées pour suivre les échéances, les jalons et d’autres événements importants de la mise en production.

    Avant d’appeler ce point de terminaison, une mise en production orientée chronologie doit être créée. Une version axée sur la chronologie a des délais fixes et suit un calendrier strict, tandis qu’une version axée sur l’étape se concentre principalement sur l’achèvement des objectifs et des fonctionnalités plutôt que sur le respect des dates d’échéance.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin
    • sn_dpr_model.release_coordinator

    Format d'URL

    URL avec version : /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/key_date

    URL par défaut : /api/sn_dpr/digital_product_release/release/{releaseId}/key_date

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    releaseId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 26. Paramètres de requête
    Nom Description
    Néant
    Tableau 27. Paramètres du corps de la demande (JSON)
    Nom Description
    assignedTo Sys_id de l’utilisateur affecté à la date clé.
    L’utilisateur doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin
    • sn_dpr_model.release_coordinator
    • sn_dpr_model.release_user

    Table : Utilisateur [sys_user]

    Type de données : chaîne

    description Description de la date clé.

    Type de données : chaîne

    date d’échéance Requis. Date d’échéance à laquelle l’événement ou l’objectif doit être terminé.

    La date d’échéance doit figurer entre la date de début et la date de fin planifiées de la mise en production.

    Format : aaaa-MM-jj

    Type de données : chaîne

    nom Requis. Nom de la date clé.

    Type de données : chaîne

    État Requis. État de la date clé.
    Valeurs valides :
    • archivé
    • manqué
    • à venir

    Type de données : chaîne

    type Requis. Type de date clé.
    Valeurs valides :
    • Date limite
    • important_date
    • key_event
    • Jalon

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 29. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. La date clé a été créée avec succès.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "keyDateSysId": "String",
       "message": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.keyDateSysId Sys_id de la date clé de création.

    Tableau : date clé de mise en production [sn_dpr_model_release_key_date]

    Type de données : chaîne

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    Demande cURL

    Cet exemple crée une date de lancement de projet pour une mise en production spécifiée.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/eb7dd11d97b402107bc2341de053af34/key_date" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{ 
        \"name\": \"Project Launch\", 
        \"type\": \"milestone\", 
        \"dueDate\": \"2025-11-01\", 
        \"state\": \"upcoming\", 
        \"description\": \"Launching the new project phase.\", 
        \"assignedTo\": \"62826bf03710200044e0bfc8bcbe5df1\" 
    }" \
    --user 'username':'password'

    Corps de la réponse.

    {
       "result": {
          "error": false,
          "message": "Release key date created successfully",
          "keyDateSysId": "eb0b0905ff7036108289ffffffffff6d"
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release/{releaseId}/policies/run

    Exécute les politiques mappées pour la phase actuelle d’une mise en production.

    Pour accéder à ce point de terminaison, l’appelant doit avoir le rôle sn_dpr_model.product_manager.

    Avant d’appeler ce point de terminaison, l’état de la mise en production doit être En cours et l’état de la phase actuelle doit également être En cours. Vous pouvez afficher les informations de mise en production dans l’onglet Mise en production de produits digitaux Espace de travailMises en production .

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/policies/run

    URL par défaut : /api/sn_dpr/digital_product_release/release/{releaseId}/policies/run

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    releaseId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 32. Paramètres de requête
    Nom Description
    Néant
    Tableau 33. Paramètres du corps de la demande (JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Tableau 35. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. L’exécution des politiques de phase de mise en production est planifiée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "errorCode": "String",
       "message": "String",
       "policyExecutionScheduled": Boolean
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    result.errorCode Code d’état HTTP pour la demande.

    Type de données : chaîne

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    résultat.policyExecutionScheduled Marqueur indiquant si les politiques de phase de mise en production sont planifiées pour être exécutées.
    Valeurs valides :
    • vrai : l’exécution des politiques de phase de mise en production est prévue.
    • faux : l’exécution des politiques de phase de mise en production n’est pas planifiée.

    Type de données : booléennes

    Demande cURL

    Cet exemple exécute les stratégies mappées pour la phase actuelle de la mise en production spécifiée.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/d4982eeb474b621027d48b41516d4385/policies/run" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'

    Corps de la réponse.

    {
       "result": {
          "error": false,
          "errorCode": "",
          "message": "Policy execution scheduled.",
          "policyExecutionScheduled": true
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release/{releaseId}/related_task

    Ajoute des tâches connexes à une mise en production.

    Vous pouvez afficher les informations de mise en production dans l’espace de travail de mise en production de produits digitaux dans l’onglet Mises en production. Les tâches connexes d’une mise en production sont affichées dans la section Champ d’application de la mise en production d’un enregistrement de mise en production.

    Important :
    Avant d’appeler ce point de terminaison, il doit exister des enregistrements de tâches existants qui peuvent être ajoutés en tant que tâches connexes pour la mise en production. Les enregistrements doivent se trouver dans des tables qui étendent la table Tâche [task], mais pas dans la table Tâche elle-même. Dans la propriété système, répertoriez sn_dpr_model.release_related_task_types les tables qui contiennent vos enregistrements de tâche.
    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin

    Format d'URL

    URL avec version : /api/sn_dpr/{api_version}/digital_product_release/release/{releaseId}/related_task

    URL par défaut : /api/sn_dpr/digital_product_release/release/{releaseId}/related_task

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    releaseId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 38. Paramètres de requête
    Nom Description
    Néant
    Tableau 39. Paramètres du corps de la demande (JSON)
    Nom Description
    taskIds Requis. Liste des sys_ids de tâches à ajouter en tant que tâches connexes pour la mise en production.

    Les enregistrements de tâches doivent provenir de tables répertoriées dans la sn_dpr_model.release_related_task_types propriété système. Pour plus d'informations, consultez Digital Product Release properties.

    Type de données : tableau

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 41. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. Les tâches connexes ont été ajoutées avec succès à la mise en production.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "message": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    Demande cURL

    Cet exemple ajoute deux tâches connexes à une mise en production.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/eb7dd11d97b402107bc2341de053af34/related_task" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{\"taskIds\": [\"36836028532023004247ddeeff7b12f1\", \"bc84b11dff5c32108289ffffffffff12\"]}" \
    --user 'username':'password'

    Corps de la réponse.

    {
       "result": {
          "error": false,
          "message": "Successfully created the mappings between the release and all the tasks."
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release_calendar

    Crée un calendrier de mise en production.

    Pour accéder à ce point de terminaison, l’appelant doit avoir le rôle sn_dpr_model.release_calendar_admin.

    Format d'URL

    URL avec version : /api/sn_dpr/{api_version}/digital_product_release/release_calendar

    URL par défaut : /api/sn_dpr/digital_product_release/release_calendar

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    Tableau 44. Paramètres de requête
    Nom Description
    Néant
    Tableau 45. Paramètres du corps de la demande (JSON)
    Nom Description
    description Description du calendrier de mise en production.

    Type de données : chaîne

    nom Requis. Nom du calendrier de mise en production.

    Type de données : chaîne

    Administrateur de mise en production Requis. Sys_id du propriétaire du calendrier de mise en production.

    Table : Utilisateur [sys_user]

    Type de données : chaîne

    Calendriers Liste séparée par des virgules des sys_ids de calendrier à utiliser pour le calendrier de mise en production. Par exemple, « sysId1,sysId2,sysId3 ».

    Table : calendrier [cmn_schedule]

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Autorisation Jeton de base ou de porteur pour l’authentification.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 47. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. Le calendrier de mise en production a été créé avec succès.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.

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

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "message": "String",
       "releaseCalendarId": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    résultat.releaseCalendarId Sys_id du calendrier de mise en production créé.

    Table : Calendrier de mise en production [sn_dpr_model_release_calendar]

    Type de données : chaîne

    Demande cURL

    Cet exemple crée un calendrier de mise en production.

    curl 'https://instance.service-now.com/api/sn_dpr/v1/digital_product_release/release_calendar' \ 
    --request POST \
    --header 'Accept:application/json' \
    --header 'Content-Type: application/json' \ 
    --header 'Authorization: Basic <base64encoded-credentials>' \ 
    --data '{ 
        "name": "Q1 2025 Release Calendar123", 
        "releaseAdmin": "dc6770ae3b97a210532fb50f23e45a33", 
        "description": "Calendar for Q1 releases" 
    }'

    Corps de la réponse.

    {
       "result": {
          "error": false,
          "message": "",
          "releaseCalendarId": "5f6702c13bbc3a50532fb50f23e45a2b"
       }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release_id/{releaseId}/complete_phase

    Termine la phase actuelle d’une mise en production.

    Remarque :
    La phase actuelle n’est définie sur Terminée que si toutes les politiques de la phase sont conformes.
    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin
    • sn_dpr_model.release_coordinator

    Avant d’appeler ce point de terminaison, l’état de la mise en production doit être En cours et l’état de la phase actuelle doit également être En cours. Vous pouvez afficher les informations de mise en production dans l’onglet Mise en production de produits digitaux Espace de travailMises en production .

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/release_id/{releaseId}/complete_phase

    URL par défaut : /api/sn_dpr/digital_product_release/release_id/{releaseId}/complete_phase

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    releaseId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 50. Paramètres de requête
    Nom Description
    Néant
    Tableau 51. Paramètres du corps de la demande (JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Tableau 53. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. La phase de mise en production s’est terminée avec succès.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API. Les éléments inclus dans cet objet varient selon que la demande a réussi ou échoué.

    Type de données : objet

    Objet de réussite.

    "result": {
       "message": "String",
       "phaseSysId": "String",
       "status": "String",
    }

    Objet d’erreur.

    "result": {
       "error": Boolean,
       "message": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.

    Ce paramètre n’est renvoyé que si la demande a échoué, de sorte que la seule valeur possible est vrai.

    Type de données : booléennes

    résultat.message Message contenant des détails sur la réussite ou l’échec de la demande d’API.

    Type de données : chaîne

    résultat.phaseSysId Sys_id de la phase de mise en production.

    Table : Phase de mise en production [sn_dpr_model_release_phase]

    Type de données : chaîne

    résultat.état Statut de la demande d’API.

    Ce paramètre n’est renvoyé que si la demande a abouti, de sorte que la seule valeur possible est réussite.

    Type de données : chaîne

    Demande cURL

    Cet exemple complète la phase actuelle de la mise en production spécifiée.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release_id/d4982eeb474b621027d48b41516d4385/complete_phase" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'

    Corps de la réponse.

    {
      "result": {
        "status": "success",
        "message": "Release phase is marked as complete",
        "phaseSysId": "2498222f474b621027d48b41516d4342"
      }
    }

    Demande cURL

    Cet exemple montre une réponse d’erreur lorsqu’un sys_id de mise en production non valide est fourni.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release_id/a/complete_phase" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'

    Réponse d’erreur.

    {
      "result": {
        "error": true,
        "message": "Release ID is invalid"
      }
    }

    Mise en production de produits digitaux : POST /sn_dpr/digital_product_release/release_target

    Crée une cible de préparation de la mise en production ou un ensemble de cibles récurrentes de préparation de la mise en production.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin

    Format d'URL

    URL avec version : /api/sn_dpr/{api_version}/digital_product_release/release_target

    URL par défaut : /api/sn_dpr/digital_product_release/release_target

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    Tableau 56. Paramètres de requête
    Nom Description
    Néant
    Tableau 57. Paramètres du corps de la demande (JSON)
    Nom Description
    description Description de la cible de préparation.

    Type de données : chaîne

    endDate Date de fin d’une cible de préparation récurrente. Requis si isRecurringa la valeur vrai.

    Type de données : chaîne

    isRecurring Requis. Marqueur indiquant si la cible de préparation est récurrente.
    Valeurs valides :
    • vrai : la cible est récurrente.
    • faux : la cible est une date unique.

    Type de données : booléennes

    nom Requis. Nom de la cible de préparation à la mise en production.

    Type de données : chaîne

    Administrateur de mise en production Requis. Sys_id du propriétaire de la cible de préparation.

    Table : Utilisateur [sys_user]

    Type de données : chaîne

    releaseCalendar Requis. Sys_id du calendrier de mise en production de la cible de préparation.

    Table : Calendrier de mise en production [sn_dpr_model_release_calendar]

    Type de données : chaîne

    Repeats (Répétitions) Définit le calendrier d’une cible de préparation récurrente. Requis si isRecurringa la valeur vrai.

    Type de données : objet

    "repeats": {
       "daysOfWeek": Number,
       "every": Number,
       "type": "String"
    }
    repeats.daysOfWeek Nombre de jours ouvrables dans une semaine.

    Type de données : nombre

    répétitions.tous les Nombre d’intervalles entre chaque date. Utilisé avec repeats.type pour définir la fréquence de la récurrence de la cible.
    Dans cet exemple, la cible revient toutes les deux semaines.
    "repeats": {
       "every": 2,
       "type": "weekly"
    }

    Type de données : nombre

    répétitions.type Type d’intervalle entre chaque date. Utilisé avec repeats.every pour définir la fréquence de la récurrence de la cible.
    Valeurs valides :
    • hebdomadaire
    • mensuel

    Type de données : chaîne

    scheduleSysId Sys_id du calendrier à utiliser pour la cible de la mise en production.

    Table : calendrier [cmn_schedule]

    Type de données : chaîne

    startDate Requis. Date de la cible de préparation, ou première date d’une cible de préparation récurrente.

    Type de données : chaîne

    targetWithOverlappingScheduleDetails Liste des dates pour une cible de préparation récurrente.

    Type de données : tableau

    "targetsWithOverlappingScheduleDetails": [ 
       { 
          "active": Boolean, 
          "date": "String" 
       }
    ]
    targetWithOverlappingScheduleDetails.active Marqueur indiquant si la récurrence de la cible de préparation est active.
    Valeurs valides :
    • vrai : actif.
    • faux : inactif.

    Type de données : booléennes

    targetWithOverlappingScheduleDetails.date Date de récurrence de la cible de préparation.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 59. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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
    201 Créé. Cible(s) de mise en production créée(s) avec succès.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "count": Number,
       "error": Boolean,
       "message": "String"
    }
    nombre.résultat Nombre de cibles de mise en production créées par la demande d’API.

    Type de données : nombre

    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.message Message d’erreur. Ce paramètre est vide pour les demandes réussies.

    Type de données : chaîne

    Demande cURL

    Cet exemple crée un ensemble de quatre cibles de préparation de la mise en production, avec une cible récurrente chaque semaine, le vendredi.

    curl "http://instance.service-now.com/api/sn_dpr/digital_product_release/release_target" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{ 
      \"name\": \"Weekly Friday patch\", 
      \"releaseAdmin\": \"6816f79cc0a8016401c5a33be04be441\", 
      \"isRecurring\": true, 
      \"description\": \"\", 
      \"startDate\": \"2025-10-24\", 
      \"releaseCalendar\": \"d3d1f3b4ff60ba10509cffffffffffa8\", 
      \"endDate\": \"2025-11-19\", 
      \"repeats\": { 
        \"type\": \"weekly\", 
        \"every\": 1, 
        \"daysOfWeek\": 5 
      }, 
      \"scheduleSysId\": \"b862d589ff3c3210509cffffffffff97\", 
      \"targetsWithOverlappingScheduleDetails\": [ 
        { 
          \"active\": true, 
          \"date\": \"2025-10-24\" 
        }, 
        { 
          \"active\": true, 
          \"date\": \"2025-10-31\" 
        }, 
        { 
          \"active\": true, 
          \"date\": \"2025-11-07\" 
        }, 
        { 
          \"active\": true, 
          \"date\": \"2025-11-14\" 
        } 
      ] 
    }" \ 
    --user 'username':'password'

    Corps de la réponse.

    {
      "result": {
        "error": false,
        "message": "",
        "count": 4
      }
    }

    Demande cURL

    Cet exemple crée une cible de préparation de la mise en production pour une date spécifiée.

    curl "http://instance.service-now.com/api/sn_dpr/digital_product_release/release_target" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{ 
      \"name\": \"Fourth Thursday patch\", 
      \"releaseAdmin\": \"6816f79cc0a8016401c5a33be04be441\", 
      \"isRecurring\": false, 
      \"description\": \"Last Thursday of October\", 
      \"startDate\": \"2025-10-30\", 
      \"releaseCalendar\": \"d3d1f3b4ff60ba10509cffffffffffa8\" 
    }" \ 
    --user 'username':'password' 

    Corps de la réponse.

    {
      "result": {
        "error": false,
        "message": "",
        "count": 1
      }
    }

    Mise en production de produits digitaux : PUT /sn_dpr/digital_product_release/release/{sysId}/retarget

    Modifie la cible de préparation d’une mise en production.

    La nouvelle cible de préparation peut être une cible de préparation existante déjà définie ou une date hors bande (une cible de préparation ponctuelle non liée au calendrier de mise en production standard). Pour définir une date hors plage, la sn_dpr.out_of_band_release_allowed propriété système doit être définie sur true.

    La durée de la phase de mise en production est ajustée pour refléter la nouvelle cible de préparation.

    Avant d’appeler ce point de terminaison, l’état de la mise en production doit être En cours ou En attente.

    Pour accéder à ce point de terminaison, l’appelant doit avoir l’un des rôles suivants.
    • sn_dpr_model.product_manager
    • sn_dpr_model.release_admin

    Format d'URL

    URL versionnée : /api/sn_dpr/{api_version}/digital_product_release/release/{sysId}/retarget

    URL par défaut : /api/sn_dpr/digital_product_release/release/{sysId}/retarget

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente.

    Type de données : chaîne

    sysId Sys_id de la mise en production.

    Table : version [sn_dpr_model_release]

    Type de données : chaîne

    Tableau 62. Paramètres de requête
    Nom Description
    Néant
    Tableau 63. Paramètres du corps de la demande (JSON)
    Nom Description
    outOfBand Marqueur indiquant si la cible de préparation est une date hors bande (une cible de préparation ponctuelle non liée au calendrier de mise en production standard).

    Ce paramètre est requis s’il releaseTarget  n’est pas utilisé.

    Valeurs valides :
    • vrai : la cible de préparation est hors bande.
    • faux : la cible de préparation est déjà définie et liée au calendrier de mise en production standard.

    Valeur par défaut : faux

    Type de données : booléennes

    releaseCalendar Sys_id du calendrier de mise en production à utiliser pour la cible de préparation. Requis si vous utilisez .outOfBand

    Table : Calendrier de mise en production [sn_dpr_model_release_calendar]

    Type de données : chaîne

    Date de mise en production Date de la cible de préparation. Requis si vous utilisez .outOfBand

    Type de données : chaîne

    Cible de mise en production Sys_id de la cible de préparation de la mise en production.

    Utilisez ce paramètre pour sélectionner une cible de préparation existante. Ce paramètre est outOfBand requis pour définir la nouvelle cible.

    Table : Cible de préparation à la mise en production [sn_dpr_model_release_target]

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la 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. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 65. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la 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.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    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)

    Nom Description
    résultat Détails sur la demande d’API.

    Type de données : objet

    "result": {
       "error": Boolean,
       "message": "String"
    }
    résultat.erreur Marqueur indiquant si une erreur s’est produite avec la demande d’API.
    Valeurs possibles :
    • vrai : erreur.
    • faux : pas d’erreur.

    Type de données : booléennes

    résultat.message Message d’erreur. Ce paramètre est vide pour les demandes réussies.

    Type de données : chaîne

    Demande cURL

    Cet exemple met à jour la cible de préparation de la mise en production à l’aide d’une cible de préparation existante.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/9b2e7ec9476c8e105b8e0dcfe16d43d4/retarget" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"releaseTarget\": \"3f6668e95427fd10f877ac7ac399daa6\"
    }" \
    --user 'username':'password'

    Corps de la réponse.

    {
      "result": {
        "error": false,
        "message": ""
      }
    }

    Demande cURL

    Cet exemple met à jour la cible de préparation de la mise en production à l’aide d’une cible de préparation hors bande.

    curl "https://instance.service-now.com/api/sn_dpr/digital_product_release/release/9b2e7ec9476c8e105b8e0dcfe16d43d4/retarget" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"outOfBand\": true,
       \"releaseCalendar\": \"fcb2eaa09f4302105c534d837a0a1c2b\",
       \"releaseDate\": \"2026-10-23\"
    }" \
    --user 'username':'password'

    Corps de la réponse.

    {
      "result": {
        "error": false,
        "message": ""
      }
    }