CdmPoliciesApi

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 13 Minuten Lesedauer

    • CdmPoliciesApi bietet Endpunkte, mit denen Sie Richtlinienzuordnungen von bereitstellbaren Elementen in Configuration Data Management (CDM) verwalten können. Richtlinien, die ordnungsgemäß einem bereitstellbaren Element zugeordnet sind, werden ausgeführt, wenn ein Snapshot des bereitstellbaren Elements validiert wird.

    Sie müssen eine der folgenden Rollen innehaben, um auf die Endpunkte in dieser API zugreifen zu können:
    • Scripted REST CDM-Ansichts-ACL
    • Geskriptete REST-CDM-Administrator-ACL

    Darüber hinaus muss das Plugin Configuration Data Management (CDM) aktiviert sein, damit diese API in einer -Instanz verfügbar ist.

    Weitere Informationen zu Richtlinienzuordnungen finden Sie unter Richtlinien zu einem bereitstellbaren Element zuordnen.

    CdmPoliciesApi – /sn_cdm/policies/mappings löschen

    Löscht die Zuordnung einer angegebenen Richtlinie zu einem bereitstellbaren Element.

    Der Anrufer dieses Endpunkts muss über die CDM-Administratorrolle verfügen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/policies/mappings

    Standard-URL: /api/sn_cdm/policies/mappings

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    appName Erforderlich. Name der Anwendung Configuration Data Management (CDM), für die die Zuordnung zur Richtlinie entfernt werden soll. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    bereitstellbarerName Erforderlich. Name des bereitstellbaren CDM, für den die Zuordnung zur Richtlinie entfernt werden soll. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    policyName Erforderlich. Name der zugeordneten Richtlinie. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Der übergebene Parameter policyName ist ungültig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie eine Richtlinienzuordnung entfernt wird.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?deployableName=Development_1&policyName=testALPolicy1&appName=testApp" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Bei erfolgreicher Löschung der Zuordnung wird keine andere Antwort als der HTTP-Statuscode zurückgegeben.

    None - results defined by the HTTP status code

    CdmPoliciesApi – GET /sn_cdm/policies/mappings/inputs/resolved

    Gibt die aufgelösten Eingaben für eine angegebene Richtlinienzuordnung eines bereitstellbaren Elements zurück.

    Weitere Informationen zu Richtlinienzuordnungen finden Sie unter Richtlinien einem bereitstellbaren Elementzuordnen und Konfigurationsdaten validieren und korrigieren.

    Der Aufrufer dieses Endpunkts muss über die Rolle „CDM-Betrachter“ verfügen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/policies/mappings/inputs/resolved

    Standard-URL: /api/sn_cdm/policies/mappings/inputs/resolved

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    appName Erforderlich. Name der Configuration Data Management (CDM)-Anwendung, die dem bereitstellbaren Element zugeordnet ist, für das die aufgelösten Richtlinieneingaben zurückgegeben werden sollen. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    bereitstellbarerName Erforderlich. Name des bereitstellbaren CDM, für den die aufgelöste Richtlinie zurückgegeben werden soll. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    policyName Erforderlich. Name der zugeordneten Richtlinie. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Der übergebene Parameter policyName ist ungültig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Ergebnis Name-Wert-Paar-Liste aller aufgelösten Eingaben für die angegebene Richtlinienzuordnung.

    Beispiel: {"input_name": "user_1", "input_password": "" }

    Datentyp: Objekt

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie dieser Endpunkt verwendet wird, um die aufgelösten Richtlinieneingaben zu erhalten.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/resolved?policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnis zurückgeben:

    { 
  "result": { 
    "key1": "someVal", 
    "additionalDeployablesInput": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]" 
  } 
}

    CdmPoliciesApi – POST /sn_cdm/policies/mappings

    Ordnet eine angegebene Richtlinie einem bereitstellbaren Element zu.

    Der Aufrufer dieses Endpunkts muss über die CDM-Administratorrolle verfügen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/policies/mappings

    Standard-URL: /api/sn_cdm/policies/mappings

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    appName Erforderlich. Name der Anwendung Configuration Data Management (CDM), für die die Richtlinie zugeordnet werden soll. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    bereitstellbarerName Erforderlich. Name des bereitstellbaren CDM, für den die Richtlinie zugeordnet werden soll. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    policyName Erforderlich. Name der zugeordneten Richtlinie. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 15. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    Beschreibung Beschreibung der Zuordnung.

    Datentyp: Zeichenfolge
    Dokument Sys_id des Dokuments.

    Datentyp: Zeichenfolge
    document_ref Details des document_ref-Datensatzes, der dem Knoten zugeordnet ist.

    Datentyp: Objekt

    "document_ref": {
  "link": "String",
  "value": "String"
}
    document_ref.link Ruft die Syntax für die Abfrage des bereitstellbaren Datensatzes auf, der der Richtlinie mithilfe der Tabellen -REST-API zugeordnet ist.

    PaCE verwendet dieses Feld, um den Verweis auf das bereitstellbare Element zu speichern, das einer Richtlinie zugeordnet ist.

    Datentyp: Zeichenfolge
    document_ref.sys_id Sys_id des bereitstellbaren Datensatzes, der der Richtlinie zugeordnet ist.

    Datentyp: Zeichenfolge
    Fehler Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde.

    Datentyp: Zeichenfolge
    Ausnahme Wenn beim Versuch, die Zuordnung durchzuführen, eine Ausnahme auftritt, der Link zum Ausnahmedatensatz.

    Datentyp: Zeichenfolge
    „exception_allowed“ Kennzeichnung, die angibt, ob Ausnahmen für die Richtlinie zulässig sind.
    Mögliche Werte:
    • true: Ausnahmen sind zulässig.
    • false: Ausnahmen sind nicht zulässig.

    Datentyp: Boolesch
    input_status Status der Eingaben.
    Mögliche Werte:
    • ungültig
    • gültig

    Datentyp: Zeichenfolge
    last_updated_by Details des Benutzers, der die Richtlinienzuordnung zuletzt aktualisiert hat.

    Datentyp: Objekt

    "last_updated_by": {
  "link": "String",
  "value": "String"
}
    last_updated_by.link Ruft die Syntax für die Abfrage des Benutzerdatensatzes mit der Tabellen -REST-API auf.

    Datentyp: Zeichenfolge
    last_updated_by.sys_id Sys_id des Benutzerdatensatzes Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Nummer Eindeutige Nummer, die die Zuordnung identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit.

    Datentyp: Zeichenfolge
    policy Details des Richtliniendatensatzes, der der Zuordnung zugeordnet ist.

    Datentyp: Objekt

    "policy": {
  "link": "String",
  "value": "String"
}
    policy.link Ruft die Syntax für die Abfrage des Richtliniendatensatzes auf, der der Richtlinie mithilfe der Tabellen -REST-API zugeordnet ist.

    Datentyp: Zeichenfolge
    policy.sys_id Sys_id des Richtliniendatensatzes. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    Grund Beschreibung des Grunds für den aktuellen Status.

    Datentyp: Zeichenfolge
    Status Aktueller Status der Zuordnung.
    Mögliche Werte:
    • aktiv
    • Inaktiv

    Datentyp: Zeichenfolge
    sys_class_name Tabellenname der Richtlinienzuordnung.

    Datentyp: Zeichenfolge
    sys_created_by Name des Benutzers, der die Zuordnung erstellt hat.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung der Zuordnung.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss
    sys_id Sys_id der Zuordnung. Befindet sich in der Tabelle „Richtlinienzuordnung“ [sn_pace_policy_mapping].

    Datentyp: Zeichenfolge
    sys_updated_by Name des Benutzers, der die Zuordnung aktualisiert hat.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Zuordnung.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss

    cURL-Anforderung

    Dieses Codebeispiel zeigt, wie eine bestimmte Richtlinie einem bereitstellbaren Element zugeordnet wird.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?appName=testApp&deployableName=Development_1&policyName=testALPolicy1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": { 
    "exception": null, 
    "reason": null, 
    "exception_allowed": "--", 
    "document": "0be34a531b501110636e0fe0604bcb21", 
    "input_status": "valid", 
    "description": null, 
    "sys_updated_on": "2022-06-30 14:07:37", 
    "sys_class_name": "sn_cdm_pace_policy_mapping", 
    "sys_id": "ea24469f1b101110636e0fe0604bcbed", 
    "number": "MAP0001001", 
    "last_updated_by": { 
      "value": "48630e131b501110636e0fe0604bcb53", 
      "link": "https://instance.servicenow.com/api/now/table/sys_user/48630e131b501110636e0fe0604bcb53" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:07:37", 
    "document_ref": { 
      "value": "0be34a531b501110636e0fe0604bcb21", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_deployable/0be34a531b501110636e0fe0604bcb21" 
    }, 
    "state": "active", 
    "sys_created_by": "admin", 
    "policy": { 
      "value": "12a3c2531b501110636e0fe0604bcb9b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_policy/12a3c2531b501110636e0fe0604bcb9b" 
    } 
  } 
}

    CdmPoliciesApi – PUT /sn_cdm/policies/mappings/inputs/additional-deployables

    Aktualisiert die Eingabevariable „additionalDeployablesInput“ einer Configuration Data Management (CDM)-Richtlinienzuordnung.

    Die Eingabevariable „additionalDeployablesInput“ enthält die zusätzlichen bereitstellbaren Elemente, die Sie einer vorhandenen Richtlinienzuordnung zuweisen können. Sie ähneln Zuordnungseingaben, haben jedoch eine bestimmte Array-Struktur.

    Weitere Informationen zu Richtlinienzuordnungen finden Sie unter Richtlinien zu einem bereitstellbaren Element zuordnen.

    Der Aufrufer dieses Endpunkts muss über die CDM-Administratorrolle verfügen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/policies/mappings/inputs/additional-deployables

    Standard-URL: /api/sn_cdm/policies/mappings/inputs/additional-deployables

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    zusätzlicheBereitstellbare Elemente Erforderlich. Liste der bereitstellbaren Elemente, die der Eingabevariablen „additionalDeployablesInput“ hinzugefügt werden sollen.

    Datentyp: Array von Objekten

    "additionalDeployables": [
  {
    "appName": "String", 
    "deployableName": "String"
  }
]
    AdditionalDeployables.appName Erforderlich. Name der CDM-Anwendung, der das bereitstellbare Element zugeordnet ist. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    AdditionalDeployables.deployableName Erforderlich. Name des bereitstellbaren CDM, das der Eingabevariablen „additionalDeployablesInput“ hinzugefügt werden soll. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    appName Erforderlich. Name der CDM-Anwendung, für die die Eingabevariable „additionalDeployablesInput“ aktualisiert werden soll. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    bereitstellbarerName Erforderlich. Name des bereitstellbaren CDM, für den die Eingabevariable „additionalDeployablesInput“ aktualisiert werden soll. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    policyName Erforderlich. Name der zugeordneten Richtlinie. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 21. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Der übergebene Parameter policyName ist ungültig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    io_definition Details zum zugeordneten PaCE IO-Definitionsdatensatz.

    Weitere Informationen zu PaCE finden Sie unter Richtlinien in DevOps Config verwalten.

    Datentyp: Objekt

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Aufrufsyntax zum Abfragen dieses PaCE IO-Definitionsdatensatzes mit der Tabellen -REST-API.

    Datentyp: Zeichenfolge
    io_definition.value Sys_id des PaCE IO-Definitionsdatensatzes. Befindet sich in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping].

    Datentyp: Zeichenfolge
    is_unused Kennzeichnung, die angibt, ob die Zuordnungseingabevariable nicht verwendet wird.
    Mögliche Werte:
    • true: Die zugeordnete Zuordnungseingabevariable wird derzeit nicht verwendet.
    • false: Zugeordnete Zuordnungseingabevariable wird derzeit verwendet.

    Datentyp: Boolesch
    mapped_value Aktueller Wert der Zuordnungseingabevariablen.

    Datentyp: Array von Objekten oder Zeichenfolge
    policy_mapping Details zum PaCE-Richtlinienzuordnungsdatensatz.

    Weitere Informationen zu PaCE finden Sie unter Richtlinien in DevOps Config verwalten.

    Datentyp: Objekt

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link Ruft die Syntax für die Abfrage des Richtlinienzuordnungsdatensatzes mit der Tabellen -REST-API auf.

    Datentyp: Zeichenfolge
    policy_mapping.value Sys_id des PaCE-Richtlinienzuordnungsdatensatzes. Befindet sich in der Tabelle „Richtlinienzuordnung“ [sn_pace_policy_mapping].

    Datentyp: Zeichenfolge
    sys_created_by Name des Benutzers, der die Zuordnungseingabevariable erstellt hat.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung der Zuordnungseingabevariablen.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss
    sys_id Sys_id des zugeordneten Zuordnungsdatensatzes. Befindet sich in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping].

    Datentyp: Zeichenfolge
    sys_updated_by Name des Benutzers, der die Zuordnungseingabevariable aktualisiert hat.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Zuordnungseingabevariablen.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie bereitstellbare Elemente zu einer zusätzlichen EingabevariablenDeployablesInput hinzugefügt werden.

    curl "https://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/additional-deployables?additionalDeployables=%5B%7B%22appName%22%3A%20%22testApp%22%2C%20%22deployableName%22%3A%22Development_2%22%7D%5D&policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'admin':'admin

    Ergebnis zurückgeben:

    { 
  "result": { 
    "sys_id": "6bb746171b501110636e0fe0604bcb1c", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "ameya", 
    "sys_created_on": "2022-06-30 14:23:15", 
    "io_definition": { 
      "value": "4d0b061b1b501110636e0fe0604bcb2f", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_io_definition/4d0b061b1b501110636e0fe0604bcb2f" 
    }, 
    "mapped_value": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]", 
    "sys_updated_on": "2022-06-30 14:53:21", 
    "sys_created_by": "ameya", 
    "is_unused": false 
  } 
}

    CdmPoliciesApi – PUT /sn_cdm/policies/mappings/inputs

    Aktualisiert eine angegebene Eingabevariable für eine Configuration Data Management (CDM)-Richtlinienzuordnung.

    Weitere Informationen zu p-Richtlinienzuordnungen finden Sie unter Richtlinien einembereitstellbaren Element zuordnen.

    Der Aufrufer dieses Endpunkts muss über die CDM-Administratorrolle verfügen.

    URL-Format

    Versionierte URL: /api/sn_cdm/{api_version}/policies/mappings/inputs

    Standard-URL: /api/sn_cdm/policies/mappings/inputs

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    appName Erforderlich. Name der CDM-Anwendung, für die die Eingaben für die Richtlinienzuordnung aktualisiert werden sollen. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application].

    Datentyp: Zeichenfolge
    bereitstellbarerName Erforderlich. Name des bereitstellbaren CDM, für den die Eingaben für die Richtlinienzuordnung aktualisiert werden sollen. Befindet sich in der Tabelle „Bereitstellbares CDM“ [sn_cdm_deployable].

    Datentyp: Zeichenfolge
    inputName Erforderlich. Name der zu aktualisierenden Eingabevariablen. Die verfügbaren Eingabevariablen sind in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping] definiert.

    Datentyp: Zeichenfolge
    inputValue Erforderlich. Wert, der der Eingabevariablen zugewiesen werden soll.

    Datentyp: Abhängig von der Eingabevariablen. Sie finden den Datentyp in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping].
    policyName Erforderlich. Name der zugeordneten Richtlinie. Befindet sich in der Richtlinientabelle [sn_space_policy].

    Datentyp: Zeichenfolge
    returnFields Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state.

    Datentyp: Array

    Standard: Alle Felder, wie vom Endpunkt bestimmt
    Tabelle : 27. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Der übergebene Parameter policyName ist ungültig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts

    Name Beschreibung
    io_definition Details zum zugeordneten PaCE IO-Definitionsdatensatz.

    Weitere Informationen zu PaCE finden Sie unter Richtlinien in DevOps Config verwalten.

    Datentyp: Objekt

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Aufrufsyntax zum Abfragen dieses PaCE IO-Definitionsdatensatzes mit der Tabellen -REST-API.

    Datentyp: Zeichenfolge
    io_definition.value Sys_id des PaCE IO-Definitionsdatensatzes. Befindet sich in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping].

    Datentyp: Zeichenfolge
    is_unused Kennzeichnung, die angibt, ob die Zuordnungseingabevariable nicht verwendet wird.
    Mögliche Werte:
    • true: Die zugeordnete Zuordnungseingabevariable wird derzeit nicht verwendet.
    • false: Zugeordnete Zuordnungseingabevariable wird derzeit verwendet.

    Datentyp: Boolesch
    mapped_value Aktueller Wert der Zuordnungseingabevariablen.

    Datentyp: Array von Objekten oder Zeichenfolge
    policy_mapping Details zum PaCE-Richtlinienzuordnungsdatensatz.

    Weitere Informationen zu PaCE finden Sie unter Richtlinien in DevOps Config verwalten.

    Datentyp: Objekt

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link Ruft die Syntax für die Abfrage des Richtlinienzuordnungsdatensatzes mit der Tabellen -REST-API auf.

    Datentyp: Zeichenfolge
    policy_mapping.value Sys_id des PaCE-Richtlinienzuordnungsdatensatzes. Befindet sich in der Tabelle „Richtlinienzuordnung“ [sn_pace_policy_mapping].

    Datentyp: Zeichenfolge
    sys_created_by Name des Benutzers, der die Zuordnungseingabevariable erstellt hat.

    Datentyp: Zeichenfolge
    sys_created_on Datum und Uhrzeit der Erstellung der Zuordnungseingabevariablen.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss
    sys_id Sys_id des zugeordneten Zuordnungsdatensatzes. Befindet sich in der Tabelle „E/A-Zuordnung“ [sn_pace_io_mapping].

    Datentyp: Zeichenfolge
    sys_updated_by Name des Benutzers, der die Zuordnungseingabevariable aktualisiert hat.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Zuordnungseingabevariablen.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-tt hh:mm:ss

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die der testALPolicy zugeordnete Eingabevariable key1 aktualisiert wird.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs?policyName=testALPolicy1&appName=testApp&inputValue=value1&inputName=key1&deployableName=Development_1" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Ergebnisse zurückgeben:

    { 
  "result": { 
    "sys_id": "631b861b1b501110636e0fe0604bcb6f", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:38:00", 
    "io_definition": { 
      "value": "fe1b061b1b501110636e0fe0604bcb90", 
      "link": "https://instance.servicenow.comm/api/now/table/sn_pace_io_definition/fe1b061b1b501110636e0fe0604bcb90" 
    }, 
    "mapped_value": "someVal", 
    "sys_updated_on": "2022-06-30 14:39:21", 
    "sys_created_by": "admin", 
    "is_unused": false 
  } 
}