CdmPoliciesApi

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

Sie müssen über eine der folgenden Rollen verfügen, um auf die Endpunkte in dieser API zuzugreifen:

• Geskriptete REST-CDM-Ansichts-ACL
• Geskriptete REST CDM-Administrator-ACL

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

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

CdmPoliciesApi: LÖSCHEN SIE /sn_cdm/policies/Mppings

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

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

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 des Konfigurationsdaten-Management(CDM)-Anwendung, für die die Zuordnung zur Richtlinie entfernt werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das die Zuordnung zur Richtlinie entfernt werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
policyName	Erforderlich. Name der zugeordneten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]

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 REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Die policyNameÜbergebener Parameter 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" }
error.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'

Für eine erfolgreiche 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/input/Resolved

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

Weitere Informationen zu Richtlinienzuordnungen finden Sie unter Ordnen Sie Richtlinien einem bereitstellbaren Element zu Und Validieren und Korrigieren von Konfigurationsdaten .

Der Anrufer dieses Endpunkts muss über die Rolle „CDM-Viewer“ verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/policies/Zuordnungen/Eingaben/gelöst

Standard-URL: /api/sn_cdm/policies/Mappings/input/gelöst

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 des Konfigurationsdaten-Management(CDM)-Anwendung, die dem bereitstellbaren Element zugeordnet ist, für das die gelösten Richtlinieneingaben zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das die gelöste Richtlinie zurückgegeben werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
policyName	Erforderlich. Name der zugeordneten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]

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 REST API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Die policyNameÜbergebener Parameter 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-Paarliste aller gelösten Eingaben für die angegebene Richtlinienzuordnung. Beispiel: {"input_Name": "User_1", "input_password": "" } Datentyp: Objekt

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie diesen Endpunkt verwenden, um die gelösten Richtlinieneingaben abzurufen.

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/Mppings

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

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 des Konfigurationsdaten-Management(CDM)-Anwendung, für die die Richtlinie zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das die Richtlinie zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
policyName	Erforderlich. Name der zugeordneten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. 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 REST API-HTTP-Antwortcodes .

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	Aufrufsyntax zum Abfragen des bereitstellbaren Datensatzes, der der Richtlinie mit zugeordnet ist Tabelle REST-API. 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" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
exception	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: Wahr: Ausnahmen sind zulässig. Falsch: 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 Anwenders, der die Richtlinienzuordnung zuletzt aktualisiert hat. Datentyp: Objekt "last_updated_by": { "link": "String", "value": "String" }
Last_updated_by.Link	Aufrufsyntax zum Abfragen des Anwenderdatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Last_updated_by.sys_ID	Sys_id des Benutzerdatensatzes Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Nummer	Eindeutige Nummer, die die Zuordnung identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge
Richtlinie	Details des Richtliniendatensatzes, der der Zuordnung zugeordnet ist. Datentyp: Objekt "policy": { "link": "String", "value": "String" }
Richtlinie.Link	Aufrufsyntax zum Abfragen des Richtliniendatensatzes, der der Richtlinie mit zugeordnet ist Tabelle REST-API. Datentyp: Zeichenfolge
Richtlinie.sys_ID	SYS_ID des Richtliniendatensatzes. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]
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 Anwenders, 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. Datentyp: Zeichenfolge Tabelle: Richtlinienzuordnung [sn_PACE_Policy_Mapping]
sys_updated_by	Name des Anwenders, 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/input/additional-proviyables

Aktualisiert die Eingabevariable additionalDeployablesInput von Konfigurationsdaten-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 Ordnen Sie Richtlinien 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/input/additional-deployment

Standard-URL: /api/sn_cdm/policies/Mappings/input/additional-proviyables

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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ätzlich bereitstellbare Elemente	Erforderlich. Liste der bereitstellbaren Elemente, die der Eingabevariable additionalDeployablesInput hinzugefügt werden sollen. Datentyp: Array von Objekten "additionalDeployables": [ { "appName": "String", "deployableName": "String" } ]
AdditionalBereitstellbare Elemente.appName	Erforderlich. Name der CDM-Anwendung, der das bereitstellbare Element zugeordnet ist. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
additionalDeployables.deployableName	Erforderlich. Name des bereitstellbaren CDM-Elements, das der Eingabevariable „additionalDeployablesInput“ hinzugefügt werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
appName	Erforderlich. Name der CDM-Anwendung, für die die Eingabevariable additionalDeployablesInput aktualisiert werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das die Eingabevariable „additionalDeployablesInput“ aktualisiert werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
policyName	Erforderlich. Name der zugeordneten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. 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 REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Die policyNameÜbergebener Parameter 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. Für zusätzliche Informationen zu PaCE, Siehe Policy as Code Engine (PaCE). Datentyp: Objekt "io_definition": { "link": "String", "value": "String" }
io_Definition.Link	Ruft die Syntax zum Abfragen auf PaCE IO-Definitionsdatensatz mit Tabelle REST-API. Datentyp: Zeichenfolge
io_Definition.Wert	SYS_ID des PaCE IO-Definitionsdatensatz. Datentyp: Zeichenfolge Tabelle: IO-Zuordnung [sn_PACE_io_Mapping]
Ist_unbenutzt	Kennzeichnung, die angibt, ob die Zuordnungseingabevariable nicht verwendet wird. Mögliche Werte: Wahr: Die zugeordnete Eingabevariable für die Zuordnung wird derzeit nicht verwendet. Falsch: Die zugeordnete Eingabevariable für die Zuordnung wird derzeit verwendet. Datentyp: Boolesch
Zugeordneter_Wert	Aktueller Wert der Zuordnungseingabevariable. Datentyp: Array von Objekten oder Zeichenfolge
Policy_Mapping	Details zum PaCE Richtlinienzuordnungsdatensatz. Für zusätzliche Informationen zu PaCE, Siehe Policy as Code Engine (PaCE). Datentyp: Objekt "policy_mapping": { "link": "String", "value": "String" }
Policy_Mapping.Link	Aufrufsyntax zum Abfragen des Richtlinienzuordnungsdatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Policy_Mapping.value	SYS_ID des PaCE Richtlinienzuordnungsdatensatz. Datentyp: Zeichenfolge Tabelle: Richtlinienzuordnung [sn_PACE_Policy_Mapping]
sys_created_by	Name des Anwenders, der die Zuordnungseingabevariable erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung der Zuordnungseingabevariable. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
sys_id	SYS_ID des zugeordneten Zuordnungsdatensatzes. Datentyp: Zeichenfolge Tabelle: IO-Zuordnung [sn_PACE_io_Mapping]
sys_updated_by	Name des Anwenders, 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 Eingabevariable additionalDeployablesInput 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/input

Aktualisiert eine angegebene Eingabevariable für einen Konfigurationsdaten-Management(CDM) Richtlinienzuordnung.

Weitere Informationen zu Richtlinienzuordnungen finden Sie unter Ordnen Sie Richtlinien 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/input

Standard-URL: /api/sn_cdm/policies/Mappings/input

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 Richtlinienzuordnungseingaben aktualisiert werden sollen. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das die Richtlinienzuordnungseingaben aktualisiert werden sollen. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
Eingabename	Erforderlich. Name der zu aktualisierenden Eingabevariable. Datentyp: Zeichenfolge Tabelle: IO-Zuordnung [sn_PACE_io_Mapping]
InputValue	Erforderlich. Wert, der der Eingabevariable zugewiesen werden soll. Datentyp: Abhängig von der Eingabevariable. Sie finden den Datentyp in der Tabelle „IO-Zuordnung“ [sn_PACE_io_Mapping].
policyName	Erforderlich. Name der zugeordneten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinie [sn_PACE_Policy]
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. 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 REST API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Die policyNameÜbergebener Parameter 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. Für zusätzliche Informationen zu PaCE, Siehe Policy as Code Engine (PaCE). Datentyp: Objekt "io_definition": { "link": "String", "value": "String" }
io_Definition.Link	Ruft die Syntax zum Abfragen auf PaCE IO-Definitionsdatensatz mit Tabelle REST-API. Datentyp: Zeichenfolge
io_Definition.Wert	SYS_ID des PaCE IO-Definitionsdatensatz. Datentyp: Zeichenfolge Tabelle: IO-Zuordnung [sn_PACE_io_Mapping]
Ist_unbenutzt	Kennzeichnung, die angibt, ob die Zuordnungseingabevariable nicht verwendet wird. Mögliche Werte: Wahr: Die zugeordnete Eingabevariable für die Zuordnung wird derzeit nicht verwendet. Falsch: Die zugeordnete Eingabevariable für die Zuordnung wird derzeit verwendet. Datentyp: Boolesch
Zugeordneter_Wert	Aktueller Wert der Zuordnungseingabevariable. Datentyp: Array von Objekten oder Zeichenfolge
Policy_Mapping	Details zum PaCE Richtlinienzuordnungsdatensatz. Für zusätzliche Informationen zu PaCE, Siehe Policy as Code Engine (PaCE). Datentyp: Objekt "policy_mapping": { "link": "String", "value": "String" }
Policy_Mapping.Link	Aufrufsyntax zum Abfragen des Richtlinienzuordnungsdatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Policy_Mapping.value	SYS_ID des PaCE Richtlinienzuordnungsdatensatz. Datentyp: Zeichenfolge Tabelle: Richtlinienzuordnung [sn_PACE_Policy_Mapping]
sys_created_by	Name des Anwenders, der die Zuordnungseingabevariable erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung der Zuordnungseingabevariable. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
sys_id	SYS_ID des zugeordneten Zuordnungsdatensatzes. Datentyp: Zeichenfolge Tabelle: IO-Zuordnung [sn_PACE_io_Mapping]
sys_updated_by	Name des Anwenders, 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 Eingabevariable key1 aktualisiert wird, die der testALPolicy zugeordnet ist.

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 
  } 
}