Anhang-API

Die Anhang- API bietet Endpunkte, mit denen Sie Dateianhänge hochladen und abfragen können.

Sie können mit jeder Anforderung eine einzelne Datei hochladen oder abrufen.

Die Anhang- 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, standardmäßig 1024 MB und glide.attachment.extensionssteuern.

Hinweis:

Die Anhang- API akzeptiert alle Inhaltstypwerte (*/*). Geben Sie den Content-Typ an, wenn Sie einen Anhang hochladen. Der Content-Typ wird mit Dateimetadaten gespeichert, sodass andere Tools die Datei korrekt identifizieren und analysieren können.

Das folgende Video enthält weitere Informationen zur Anhang -API:

Anforderungen an die Rolle „Attachment-API“

Zum Erstellen von Anhängen muss der Anwenderdatensatz, der zur Authentifizierung der HTTP-Anforderung mit ServiceNow verwendet wird, über alle Rollen verfügen, die zum Erstellen von Anhängen [sys_attachment]-Datensätzen erforderlich sind. Sie muss auch über alle Rollen verfügen, die zum Lesen und Schreiben von Datensätzen in der Zieltabelle erforderlich sind, z. B. die Rolle itil zum Hinzufügen von Anhängen zu Incident-Datensätzen.

Standardmäßig gibt es keine Einzelrolle, mit der ein Benutzer Anhänge hinzufügen kann. Sie können eine Rolle erstellen, um das Hinzufügen von Anhängen explizit zuzulassen, und diese Rolle dann dem Benutzeraccount zuordnen, das für die Anforderung verwendet wird.

Anhang – DELETE /now/attachment/{sys_id}

Diese Methode löscht den Anhang mit einem bestimmten sys_id-Wert.

URL-Format

Versionierte URL: /api/now/v1/attachment/{sys_id}

Standard-URL: /api/now/attachment/{sys_id}

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
sys_id	Sys_id-Wert des zu löschenden Anhangs. 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-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
204	Gibt an, dass die Anforderung erfolgreich ausgeführt wurde.
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

cURL-Anforderung

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

""

Anhang: GET /now/attachment

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

URL-Format

Versionierte URL: api/now/v1/attachment

Standard-URL: api/now/attachment

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 8. Abfrageparameter

Name	Beschreibung
sysparm_limit	Limit für die Paginierung. Hinweis: Ungewöhnlich große sysparm_limit-Werte können die Systemleistung beeinträchtigen. Datentyp: Zeichenfolge Standardwert: 1000
sysparm_offset	Anzahl der Datensätze, die von der Abfrage ausgeschlossen werden sollen. Verwenden Sie diesen Parameter, um mehr Datensätze abzurufen, als im Parameter sysparm_limit angegeben sind. Beispiel: Wenn sysparm_limit auf 500 festgelegt ist, es jedoch zusätzliche Datensätze gibt, die Sie abfragen möchten, können Sie einen sysparm_offset -Parameterwert von 500 angeben, um die zweite Gruppe von Datensätzen abzurufen. Datentyp: Zeichenfolge Standard: 0
sysparm_query	Codierte Abfrage. Abfragen für die Anhang -API sind relativ zur Tabelle „Anhänge“ [sys_attachment]. Beispiel: (sysparm_query=file_name=attachment.doc) Die codierte Abfrage bietet Unterstützung für order by. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query. Beispiel: sysparm_query=ORDERBYfile_name^ORDERBYDESCtable_Name ordnet die Ergebnisse zuerst in aufsteigender Reihenfolge nach Namen und dann in absteigender Reihenfolge nach Tabellenname. 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
Inhaltstyp	Inhaltstyp der Antwort. Bei Metadatenanforderungen ist dies der Content-Typ der Metadaten, nicht der Content-Typ der Anhangsdateien.
Link	Links zum Herunterladen der Anhänge.

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-Antwortcodes der 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)

Name	Beschreibung
Die zurückgegebenen Informationen hängen von den ausgewählten Anhängen ab.

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/attachment?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/attachment/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"
    }
  ]
}

Anhang: GET /now/attachment/{sys_id}/file

Gibt den Binärdateianhang mit einem bestimmten sys_id-Wert zurück.

URL-Format

URL mit Versionsnummer: /api/now/v1/attachment/{sys_id}/file

Standard-URL: /api/now/attachment/{sys_id}/file

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
sys_id	Sys_id des Anhangdatensatzes, aus dem Binärdaten zurückgegeben werden sollen.

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-Antwortcodes der 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.
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)

Name	Beschreibung
Binärdateianhang

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"

Binary response not shown.

Anhang – GET /now/attachment/{sys_id}

Gibt die Metadaten für die Anhangdatei mit einem bestimmten sys_id-Wert zurück.

URL-Format

Versionierte URL: /api/now/v1/attachment/{sys_id}

Standard-URL: /api/now/attachment/{sys_id}

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
sys_id	Sys_id des Anhangdatensatzes, für den die Metadaten abgerufen werden sollen.

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
Content-Type	Content-Typ der Antwort. Bei Metadatenanforderungen ist dies der Content-Typ der Metadaten, nicht der Content-Typ der Anhangsdateien.

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

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Gibt an, dass der angegebene Anhang nicht vorhanden ist oder der aktuelle Benutzer nicht darauf zugreifen kann.
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
Spezifische Metadaten für den angegebenen Anhang.

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/attachment/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/attachment/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"
  }
}

Anhang – POST /now/attachment/file

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

Hinweis:

Die anzuhängende Datei muss nach dem letzten Parameter in der Liste der übergebenen Anforderungsparameter angegeben werden.

URL-Format

Versionierte URL: /api/now/v1/attachment/file

Standard-URL: /api/now/attachment/file

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 26. Abfrageparameter

Name	Beschreibung
creation_time	Erstellungsdatum und -uhrzeit des Anhangs. Verwenden Sie diesen Parameter, um Zeiten für die Anhangserstellung zu erfassen, wenn Now Mobile-App offline ist und der Anhang zu einem späteren Zeitpunkt in einen Datensatz hochgeladen wird. Datentyp: Zeichenfolge Standard: Das aktuelle Datum und die aktuelle Uhrzeit.
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 Field Encryption. Datentyp: Zeichenfolge Standard: Die Datei wird mit einem Verschlüsselungskontext verschlüsselt, auf den der Anwender zugreifen kann, andernfalls wird die angehängte Datei nicht mit einem Verschlüsselungskontext verschlüsselt.
file_name	Erforderlich. Name für den Anhang. Datentyp: Zeichenfolge
table_name	Erforderlich. Name der Tabelle, an die die Datei angehängt werden soll. Datentyp: Zeichenfolge
table_sys_id	Erforderlich. Sys_id des Datensatzes in der in table_name 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.

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	Inhaltstyp der anzuhängenden Datei, z. B. image/jpeg oder */*. Dieser Kopfzeile ist obligatorisch, um Dateianhänge zu veröffentlichen.

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	Beschreibung
Standort	URL des neuen Anhangs.

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

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
201	Gibt an, dass die Abfrage erfolgreich ausgeführt wurde.
400	Gibt an, dass ein oder mehrere obligatorische Parameter in der Anforderung fehlten.
404	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. Mögliche 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

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/attachment/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 "@ location of the file on file system"

{
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.servicenow.com/api/now/attachment/6ea10fe64f411200adf9f8e18110c739/file",
    "sys_updated_on": "2016-01-22 15:14:07",
    "sys_id": "6ea10fe64f411200adf9f8e18110c739",
    "image_height": "",
    "sys_created_on": "2016-01-22 15:14:07",
    "file_name": "Issue_screenshot",
    "sys_created_by": "admin",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "admin",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130"
  }
}

Anhang: POST /now/attachment/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 finden Sie ein Beispiel für eine mehrteilige/Formulardatenanforderung.

Wichtig:

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

URL-Format

Versionierte URL: /api/now/v1/attachment/upload

Standard-URL: /api/now/attachment/upload

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. 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 : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Inhaltstyp der Anforderung. Legen Sie diesen Wert auf „multipart/form-data“ fest, wenn Sie die mehrteilige POST-Methode verwenden.

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Standort	URL des neuen Anhangs.

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

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
201	Gibt an, dass die Abfrage erfolgreich ausgeführt wurde.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
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)

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. Mögliche 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

Mehrteilige POST-Pflichtwerte

Fügen Sie beim Senden einer mehrteiligen POST-Anforderung zum Hochladen eines Dateianhangs die Anhangdaten in den Meldungstext ein, nicht in die URL-Parameter. Sie müssen diese Werte im Meldungstext angeben:

Tabelle : 37. Pflichtwerte

Wert	Beschreibung
Inhaltstyp	Inhaltstyp der Datei, die im Nachrichtentext für mehrteilige Uploads enthalten ist. Hinweis: Der Content-Type muss innerhalb des Dateibereichs der POST-Meldung definiert werden, nicht innerhalb der Formulardaten. Ein Beispiel für eine mehrteilige Meldung ist die mehrteilige POST-Beispielmeldung Datentyp: Zeichenfolge
table_name	Name der Tabelle, an die Sie die Datei anhängen möchten. Datentyp: Zeichenfolge
table_sys_id	Sys_id des Datensatzes in der angegebenen Tabelle, an den Sie die Datei anhängen möchten. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/attachment/upload" \
--request POST \
--header "Accept:application/json"\
--user "username":"password"\
--header "Content-Type:multipart/form-data"\
 -F 'table_name=incident' \
 -F 'table_sys_id=d71f7935c0a8016700802b64c67c11c6'\
 -F 'uploadFile=@ location of the file on file system'
\

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