CSM-Anhang-API

Die CSM -Anhang-API bietet Endpunkte, mit denen interne und externe Anwender Anhänge, die einer Tabelle zugeordnet sind, hochladen, herunterladen und entfernen sowie Anhangmetadaten abrufen können.

Nur Anhänge, die Tabellen zugeordnet sind, die in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables angegeben sind, sind in allen zugeordneten Endpunktaufrufen gültig. Jeder angemeldete Benutzer (snc_internal und snc_external) kann auf diese API zugreifen. Gäste und öffentliche Benutzer haben keine Zugriffsrechte.

Diese API berücksichtigt alle Systembeschränkungen für hochgeladene Dateien, z. B. maximale Dateigröße und zulässige Anhangstypen. Sie können diese Einstellungen mit den Eigenschaften com.glide.attachment.max_size und glide.attachment.extensions steuern.

Standardmäßig gilt für diese API für nicht authentifizierte und „snc_external“-Benutzer eine Quotenbegrenzung von 500 pro Stunde. Weitere Informationen zur Quotenbegrenzung finden Sie unter Quotenbegrenzung der eingehenden REST-API.

CSM-Anhang – DELETE /now/attachment_csm/{sys_id}

Löscht den angegebenen Anhang.

URL-Format

URL mit Versionsangabe: /api/now/{api_version}/attachment_csm/{sys_id}

Standard-URL: /api/now/v1/attachment_csm/{sys_id}

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
sys_id	Sys_id des zu löschenden Anhangs. Dieser Anhang muss zu einer der Tabellen gehören, die in der Eigenschaft [ glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt sind. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

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
Keine

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
204	Erfolgreich. Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
400	Ungültige Anforderung. Gibt an, dass auf den Anhang aus dieser Tabelle möglicherweise nicht zugegriffen werden kann. Stellen Sie sicher, dass die zugehörige Tabelle in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables enthalten ist.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
Keine

Beispiel für eine cURL-Anforderung

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request DELETE \
--user 'username':'password'

None

CSM-Anhang: GET /now/attachment_csm

Gibt die Metadaten für mehrere Anhänge zurück.

Hinweis:

Sie können auf alle Sysparm-Abfrageparameter entweder mit ihrem vollständigen Namen oder ihrem abgekürzten Namen (ohne das Präfix sysparm_ ) verweisen. Beispielsweise können Sie für sysparm_limit auch limitverwenden.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/attachment_csm

Standard-URL: /api/now/v1/attachment_csm

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
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 10.000
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl im Parameter sysparm_offset. Datentyp: Zahl Standard: 0
sysparm_query	Erforderlich. Codierte Abfrage für die Suche nach Anhängen. Dieser Parameter muss mindestens sysparm_query = table_name =<table> enthalten, wobei <table> nur die Tabellen sein können, die in der Eigenschaft [ glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] angegeben sind. Beispiel: sysparm_query=file_name=kb_knowledge. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstextparameter (XML oder JSON)

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.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Ergebnis	Metadaten des angeforderten Anhangs. Datentyp: Objekt "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
result.average_image_color	Wenn der Anhang ein Bild ist, die Summe aller Farben. Datentyp: Zeichenfolge Einheit: RGB oder Anzahl der Pixel.
result.committed	Kennzeichnung, die angibt, ob die Anhangdatei komprimiert wurde. Gültige Werte: wahr: Datei wurde komprimiert. „falsch“: Datei wurde nicht komprimiert. Datentyp: Zeichenfolge
result.content_type	Inhaltstyp der zugeordneten Anhangdatei, z. B. „image“ oder „jpeg“ oder „application/x-shockWave-Flash“. Datentyp: Zeichenfolge
result.created_by_name	Vollständiger Name der Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.download_link	Laden Sie die URL des Anhangs in der Instanz ServiceNow herunter. Datentyp: Zeichenfolge
result.file_name	Dateiname des Anhangs. Datentyp: Zeichenfolge
result.image_height	Bei einer Bilddatei die Höhe des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
result.image_width	Bei einer Bilddatei die Breite des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
Ergebnis.Größe_Byte	Größe des Anhangs Datentyp: Zeichenfolge Einheit: Byte
Ergebnis.Größe_Komprimiert	Größe der komprimierten Anhangdatei. Wenn die Datei nicht komprimiert ist, leer. Datentyp: Zeichenfolge Einheit: Byte
result.sys_created_by	Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.sys_created_on	Zeitpunkt (Datum und Uhrzeit), zu dem die Anhangdatei zum ersten Mal in der Instanz gespeichert wurde. Datentyp: Zeichenfolge
result.sys_id	Sys_id der Anhangdatei. Datentyp: Zeichenfolge
result.sys_mod_count	Anzahl der Änderungen der Anhangdatei (Hochladen in die Instanz). Datentyp: Zeichenfolge
result.sys_tags	Alle System-Tags, die der Anhangdatei zugeordnet sind. Datentyp: Zeichenfolge
result.sys_updated_by	Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge
result.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung der Anhangdatei. Datentyp: Zeichenfolge
result.table_name	Name der Tabelle, der der Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.table_sys_id	Sys_id der Tabelle, die dem Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.updated_by_name	Vollständiger Name der Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

curl "https://instance.service-now.com/api/now/v1/attachment_csm?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
      "size_bytes": "462",
      "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
      "sys_updated_on": "2009-05-21 04:12:21",
      "sys_id": "615ea769c0a80166001cf5f2367302f5",
      "image_height": "",
      "sys_created_on": "2009-05-21 04:12:21",
      "file_name": "blocks.swf",
      "sys_created_by": "glide.maint",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "glide.maint",
      "sys_tags": "",
      "table_name": "content_block_programmatic",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "application/x-shockwave-flash",
      "size_compressed": "485",
      "created_by_name": "John Smith",
      "updated_by_name": "John Smith"
    }
  ]
}

CSM-Anhang: GET /now/attachment_csm/{sys_id}/file

Gibt den Dateianhang für die angegebene Anhang-Sys-ID zurück.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/attachment_csm/{sys_id}/file

Standard-URL: /api/now/v1/attachment_csm/{sys_id}/file

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
sys_id	Sys_id des Anhangs, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist. Dieser Anhang muss zu einer der Tabellen gehören, die in der Eigenschaft [ glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt sind.

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)

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. Verwenden Sie beispielsweise image/jpeg oder image/png, um ausschließlich JPEG- oder PNG-Bilddateien zu akzeptieren. Um alle Bildtypen zuzulassen, geben Sie image/*an. Um einen beliebigen Dateityp zuzulassen, geben Sie */*an. Standard: */*

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	Beschreibung
X-Attachment-Metadata	Metadaten zur zurückgegebenen Datei, z. B. Größe, Name und Dateityp.

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	Ungültige Anforderung. Gibt an, dass auf den Anhang aus dieser Tabelle möglicherweise nicht zugegriffen werden kann. Stellen Sie sicher, dass die zugehörige Tabelle in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables enthalten ist.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
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
	Inhalt des Anhangs

Beispiel für eine cURL-Anforderung

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/<attachment_sys_id>/file" \
--request GET \
--header "Accept:*/*" \
--user 'username':'password'

Recipient list Internal users Sheet1
sys_id	email
 Recipient list Internal users.xlsx

CSM-Anhang – GET /now/attachment_csm/{sys_id}

Gibt die Metadaten für die Anhangsdatei mit der spezifischen Anhangs-Sys-ID zurück.

URL-Format

URL mit Versionsangabe: /api/now/{api_version}/attachment_csm/{sys_id}

Standard-URL: /api/now/v1/attachment_csm/{sys_id}

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
sys_id	Sys_id des Anhangdatensatzes, für den Metadaten zurückgegeben werden sollen. Dieser Anhang muss zu einer der Tabellen gehören, die in der Eigenschaft [ glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt sind. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (XML oder JSON)

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ützte Typen: application/json oder application/xml. Standard: 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. Gibt an, dass auf den Anhang aus dieser Tabelle möglicherweise nicht zugegriffen werden kann. Stellen Sie sicher, dass die zugehörige Tabelle in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables enthalten ist.
401	Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch.
404	Nicht gefunden. Gibt an, dass der angegebene Anhang nicht vorhanden ist oder dass der aktuelle Anwender nicht berechtigt ist, darauf zuzugreifen.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Ergebnis	Metadaten des angeforderten Anhangs. Datentyp: Objekt "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
result.average_image_color	Wenn der Anhang ein Bild ist, die Summe aller Farben. Datentyp: Zeichenfolge Einheit: RGB oder Anzahl der Pixel.
result.committed	Kennzeichnung, die angibt, ob die Anhangdatei komprimiert wurde. Gültige Werte: wahr: Datei wurde komprimiert. „falsch“: Datei wurde nicht komprimiert. Datentyp: Zeichenfolge
result.content_type	Inhaltstyp der zugeordneten Anhangdatei, z. B. „image“ oder „jpeg“ oder „application/x-shockWave-Flash“. Datentyp: Zeichenfolge
result.created_by_name	Vollständiger Name der Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.download_link	Laden Sie die URL des Anhangs in der Instanz ServiceNow herunter. Datentyp: Zeichenfolge
result.file_name	Dateiname des Anhangs. Datentyp: Zeichenfolge
result.image_height	Bei einer Bilddatei die Höhe des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
result.image_width	Bei einer Bilddatei die Breite des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
Ergebnis.Größe_Byte	Größe des Anhangs Datentyp: Zeichenfolge Einheit: Byte
Ergebnis.Größe_Komprimiert	Größe der komprimierten Anhangdatei. Wenn die Datei nicht komprimiert ist, leer. Datentyp: Zeichenfolge Einheit: Byte
result.sys_created_by	Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.sys_created_on	Zeitpunkt (Datum und Uhrzeit), zu dem die Anhangdatei zum ersten Mal in der Instanz gespeichert wurde. Datentyp: Zeichenfolge
result.sys_id	Sys_id der Anhangdatei. Datentyp: Zeichenfolge
result.sys_mod_count	Anzahl der Änderungen der Anhangdatei (Hochladen in die Instanz). Datentyp: Zeichenfolge
result.sys_tags	Alle System-Tags, die der Anhangdatei zugeordnet sind. Datentyp: Zeichenfolge
result.sys_updated_by	Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge
result.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung der Anhangdatei. Datentyp: Zeichenfolge
result.table_name	Name der Tabelle, der der Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.table_sys_id	Sys_id der Tabelle, die dem Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.updated_by_name	Vollständiger Name der Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
    "size_bytes": "462",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
    "sys_updated_on": "2019-05-21 04:12:21",
    "sys_id": "615ea769c0a80166001cf5f2367302f5",
    "image_height": "",
    "sys_created_on": "2019-05-21 04:12:21",
    "file_name": "blocks.swf",
    "sys_created_by": "glide.maint",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "glide.maint",
    "sys_tags": "",
    "table_name": "content_block_programmatic",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "application/x-shockwave-flash",
    "size_compressed": "485",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

CSM-Anhang – POST /now/attachment_csm/file

Lädt eine angegebene Binärdatei als Anhang in einen angegebenen Datensatz hoch.

Der Endpunkt gibt auch die Metadaten für den gespeicherten Anhang zurück.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/attachment_csm/file

Standard-URL: /api/now/v1/attachment_csm/file

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
encryption_context	Sys_id eines Verschlüsselungskontextdatensatzes. Geben Sie diesen Parameter an, damit nur Benutzer mit dem angegebenen Verschlüsselungskontext auf den Anhang zugreifen können. Weitere Informationen zu Verschlüsselungskontextdatensätzen finden Sie unter Column Level Encryption. Datentyp: Zeichenfolge Standard: Die angehängte Datei wird nicht mit einem Verschlüsselungskontext verschlüsselt.
file_name	Erforderlich. Name für den Anhang. Hinweis: Die anzuhängende Datei muss nach dem letzten Parameter in der Liste der übergebenen Abfrageparameter angegeben werden. Datentyp: Zeichenfolge
table_name	Erforderlich. Name der Tabelle, an die Sie die Datei anhängen möchten. Diese Tabelle muss innerhalb der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt werden. Datentyp: Zeichenfolge
table_sys_id	Erforderlich. Sys_id des Datensatzes in der angegebenen Tabelle, an den Sie die Datei anhängen möchten. Datentyp: Zeichenfolge

Tabelle : 27. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
<String>	Pfad zur Binärdatei, die an den angegebenen Datensatz angehängt werden soll. Datentyp: Zeichenfolge

Header

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ützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Erforderlich. Datenformat der zu postenden Datei. Verwenden Sie beispielsweise image/jpeg oder image/png, um ausschließlich JPEG- oder PNG-Bilddateien zu veröffentlichen. Um alle Bildtypen zuzulassen, geben Sie image/*an. Um einen beliebigen Dateityp zuzulassen, geben Sie */*an.

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. Gibt an, dass auf den Anhang aus dieser Tabelle möglicherweise nicht zugegriffen werden kann. Stellen Sie sicher, dass die zugehörige Tabelle in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables enthalten ist.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Gibt an, dass der durch die Parameter table_name und table_sys_id angegebene Datensatz nicht vorhanden ist oder für den aktuellen Anwender nicht zugänglich ist.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Ergebnis	Metadaten des angeforderten Anhangs. Datentyp: Objekt "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
result.average_image_color	Wenn der Anhang ein Bild ist, die Summe aller Farben. Datentyp: Zeichenfolge Einheit: RGB oder Anzahl der Pixel.
result.committed	Kennzeichnung, die angibt, ob die Anhangdatei komprimiert wurde. Gültige Werte: wahr: Datei wurde komprimiert. „falsch“: Datei wurde nicht komprimiert. Datentyp: Zeichenfolge
result.content_type	Inhaltstyp der zugeordneten Anhangdatei, z. B. „image“ oder „jpeg“ oder „application/x-shockWave-Flash“. Datentyp: Zeichenfolge
result.created_by_name	Vollständiger Name der Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.download_link	Laden Sie die URL des Anhangs in der Instanz ServiceNow herunter. Datentyp: Zeichenfolge
result.file_name	Dateiname des Anhangs. Datentyp: Zeichenfolge
result.image_height	Bei einer Bilddatei die Höhe des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
result.image_width	Bei einer Bilddatei die Breite des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
Ergebnis.Größe_Byte	Größe des Anhangs Datentyp: Zeichenfolge Einheit: Byte
Ergebnis.Größe_Komprimiert	Größe der komprimierten Anhangdatei. Wenn die Datei nicht komprimiert ist, leer. Datentyp: Zeichenfolge Einheit: Byte
result.sys_created_by	Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.sys_created_on	Zeitpunkt (Datum und Uhrzeit), zu dem die Anhangdatei zum ersten Mal in der Instanz gespeichert wurde. Datentyp: Zeichenfolge
result.sys_id	Sys_id der Anhangdatei. Datentyp: Zeichenfolge
result.sys_mod_count	Anzahl der Änderungen der Anhangdatei (Hochladen in die Instanz). Datentyp: Zeichenfolge
result.sys_tags	Alle System-Tags, die der Anhangdatei zugeordnet sind. Datentyp: Zeichenfolge
result.sys_updated_by	Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge
result.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung der Anhangdatei. Datentyp: Zeichenfolge
result.table_name	Name der Tabelle, der der Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.table_sys_id	Sys_id der Tabelle, die dem Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.updated_by_name	Vollständiger Name der Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Zeigt, wie die JPG-Datei „Issue_screenshot.jpg“ in das Verzeichnis „ /images “ hochgeladen wird.

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/file?table_name=incident&table_sys_id=d71f7935c0a8016700802b64c67c11c6&file_name=Issue_screenshot" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type: image/jpeg" \
--user "username":"password" \
--data-binary "@/images/Issue_screenshot.jpg"

{
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/6ea10fe64f411200adf9f8e18110c739/file",
    "sys_updated_on": "2019-01-22 15:14:07",
    "sys_id": "6ea10fe64f411200adf9f8e18110c739",
    "image_height": "",
    "sys_created_on": "2019-01-22 15:14:07",
    "file_name": "Issue_screenshot",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

CSM-Anhang – POST /now/attachment_csm/upload

Lädt einen mehrteiligen Dateianhang hoch.

Die mehrteilige POST-Methode akzeptiert keine Parameter. Sie müssen den Tabellennamen und die sys_id-Werte des Datensatzes im Formulartext angeben. Im cURL-Beispiel unten finden Sie ein Beispiel für eine mehrteilige/Formulardatenanforderung.

Hinweis:

Stellen Sie bei der Verwendung von mehrteiligem POST sicher, dass der Dateiinhalt nur im letzten Teil der Meldung enthalten ist. Frühere Teile sollten nur Metadaten wie Tabellennamen und Datensatz-sys_id enthalten.

Wenn Sie eine mehrteilige/Formulardaten-POST-Anforderung zum Hochladen eines Dateianhangs senden, fügen Sie die Anhangdaten in den Formulartext ein, nicht in die URL-Parameter oder den Anforderungstext.

Tabelle : 31. Pflichtwerte

Wert	Beschreibung
Inhaltstyp	Inhaltstyp der Datei, die im Nachrichtentext für mehrteilige Uploads enthalten ist. Hinweis: Sie müssen den Inhaltstyp innerhalb des Dateiteils der POST-Nachricht definieren, nicht innerhalb der Formulardaten. Datentyp: Zeichenfolge
table_name	Name der Tabelle, an die Sie die Datei anhängen möchten. Diese Tabelle muss in der Eigenschaft [ glide.rest.attachment_csm_api.allowed_tables in der Tabelle „Systemeigenschaften“ [sys_properties] angegeben werden. Datentyp: Zeichenfolge
table_sys_id	Sys_id des Datensatzes in der angegebenen Tabelle, an den Sie die Datei anhängen möchten. Datentyp: Zeichenfolge

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/attachment_csm/upload

Standard-URL: /api/now/v1/attachment_csm/upload

Unterstützte Anforderungsparameter

Tabelle : 32. 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 : 33. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 34. Anforderungstextparameter (XML oder JSON)

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 : 35. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Anforderungstexts. Legen Sie diesen Wert auf multipart/form-data fest, wenn Sie die mehrteilige POST-Methode verwenden.

Tabelle : 36. Antwortkopfzeilen

Kopfzeile	Beschreibung
Standort	URL des neuen Anhangs in der Plattforminstanz ServiceNow.

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 : 37. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
400	Ungültige Anforderung. Gibt an, dass auf den Anhang aus dieser Tabelle möglicherweise nicht zugegriffen werden kann. Stellen Sie sicher, dass die zugehörige Tabelle in der Systemeigenschaft glide.rest.attachment_csm_api.allowed_tables enthalten ist.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

Parameter des Antworttexts (JSON oder XML)

Element	Beschreibung
Ergebnis	Metadaten des angeforderten Anhangs. Datentyp: Objekt "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
result.average_image_color	Wenn der Anhang ein Bild ist, die Summe aller Farben. Datentyp: Zeichenfolge Einheit: RGB oder Anzahl der Pixel.
result.committed	Kennzeichnung, die angibt, ob die Anhangdatei komprimiert wurde. Gültige Werte: wahr: Datei wurde komprimiert. „falsch“: Datei wurde nicht komprimiert. Datentyp: Zeichenfolge
result.content_type	Inhaltstyp der zugeordneten Anhangdatei, z. B. „image“ oder „jpeg“ oder „application/x-shockWave-Flash“. Datentyp: Zeichenfolge
result.created_by_name	Vollständiger Name der Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.download_link	Laden Sie die URL des Anhangs in der Instanz ServiceNow herunter. Datentyp: Zeichenfolge
result.file_name	Dateiname des Anhangs. Datentyp: Zeichenfolge
result.image_height	Bei einer Bilddatei die Höhe des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
result.image_width	Bei einer Bilddatei die Breite des Bildes. Datentyp: Zeichenfolge Einheit: Pixel
Ergebnis.Größe_Byte	Größe des Anhangs Datentyp: Zeichenfolge Einheit: Byte
Ergebnis.Größe_Komprimiert	Größe der komprimierten Anhangdatei. Wenn die Datei nicht komprimiert ist, leer. Datentyp: Zeichenfolge Einheit: Byte
result.sys_created_by	Entität, die die Anhangdatei ursprünglich erstellt hat. Datentyp: Zeichenfolge
result.sys_created_on	Zeitpunkt (Datum und Uhrzeit), zu dem die Anhangdatei zum ersten Mal in der Instanz gespeichert wurde. Datentyp: Zeichenfolge
result.sys_id	Sys_id der Anhangdatei. Datentyp: Zeichenfolge
result.sys_mod_count	Anzahl der Änderungen der Anhangdatei (Hochladen in die Instanz). Datentyp: Zeichenfolge
result.sys_tags	Alle System-Tags, die der Anhangdatei zugeordnet sind. Datentyp: Zeichenfolge
result.sys_updated_by	Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge
result.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung der Anhangdatei. Datentyp: Zeichenfolge
result.table_name	Name der Tabelle, der der Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.table_sys_id	Sys_id der Tabelle, die dem Anhang zugeordnet ist. Datentyp: Zeichenfolge
result.updated_by_name	Vollständiger Name der Entität, die die Anhangdatei zuletzt aktualisiert hat. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

curl "https://instance.service-now.com/api/now/v1/attachment_csm/upload" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:multipart/form-data" \
--user "username":"password" \
 -F "table_name=incident" \
 -F "table_sys_id=d71f7935c0a8016700802b64c67c11c6" \
 -F "uploadFile=@/image/banner-CS0001345_v1_1.jpeg"

{
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/994adbc64f511200adf9f8e18110c796/file",
    "sys_updated_on": "2019-02-02 14:00:21",
    "sys_id": "994adbc64f511200adf9f8e18110c796",
    "image_height": "",
    "sys_created_on": "2019-02-02 14:00:21",
    "file_name": "banner-CS0001345_v1_1.jpeg",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}