CSM-Anhang-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 18 Minuten Lesedauer
  • Die CSM-Anhang Die API stellt Endpunkte bereit, mit denen sowohl interne als auch externe Anwender Anhänge hochladen, herunterladen und entfernen können, die einer Tabelle zugeordnet sind, und Anhangsmetadaten abrufen können.

    Nur Anhänge, die Tabellen zugeordnet sind, die in angegeben sind glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft ist in jedem der zugeordneten Endpunktaufrufe gültig. Jeder angemeldete Anwender, sowohl snc_internal als auch snc_external, kann auf diese API zugreifen. Gäste und öffentliche Anwender 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 steuern com.glide.attachment.max_sizeUnd glide.attachment.extensionsEigenschaften.

    Standardmäßig hat diese API ein Quotenlimit von 500 pro Stunde für nicht authentifizierte und snc_external Anwender. Weitere Informationen zur Quotenbegrenzung finden Sie unter Begrenzung der eingehenden REST-API-Rate .

    CSM-Anhang: LÖSCHEN SIE /now/attachment_csm/{sys_ID}

    Löscht den angegebenen Anhang.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/attachment_csm/{sys_ID}

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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

    sys_id SYS_ID des zu löschenden Anhangs. Dieser Anhang muss zu einer der Tabellen gehören, die in aufgeführt sind glide.rest.attachment_csm_api.allowed_tablesEigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    Datentyp: Zeichenfolge

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 5. Antwort-Header
    Header 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
    204 Erfolgreich. Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
    400 Ungültige Anforderung. Gibt an, dass der Anhang aus dieser Tabelle möglicherweise nicht zugänglich ist. Stellen Sie sicher, dass die zugeordnete Tabelle in enthalten ist glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Keine

    Beispiel für 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 ihren vollständigen Namen oder ihren verkürzten Namen (ohne) verweisen sysparm_Präfix). Beispiel: Für sysparm_limitSie können auch verwenden limit.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/attachment_csm

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    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
    Sysparm_limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs.

    Dieser Grenzwert wird vor der ACL-Auswertung angewendet. Wenn keine Datensätze zurückgegeben werden, einschließlich der Datensätze, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge so an, dass Datensätze, auf die Sie zuerst zugreifen können, zurückgegeben werden.

    Hinweis:
    Ungewöhnlich groß sysparm_limitWerte können sich auf die Systemleistung auswirken.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100

    Sysparm_Offset Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

    Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Sysparm_Offset=sysparm_Offset+sysparm_limit , Bis Sie das Ende aller Datensätze erreichen.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0

    Sysparm_query Erforderlich. Codierte Abfrage, die zum Suchen nach Anhängen verwendet werden soll.

    Dieser Parameter muss mindestens enthalten Sysparm_query=table_Name= <table>Wo <table>Können nur die Tabellen sein, die in angegeben sind glide.rest.attachment_csm_api.allowed_tablesEigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    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 mit <value> überein.
      • !=: Stimmt nicht mit <value> überein.
      • ^: Logisch UND mehrere Abfrageanweisungen.
      • ^ODER: Logisch ODER mehrere Abfrageanweisungen.
      • LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „Zeichenfolge“ ist.
      • STARTSMIT: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „Zeichenfolge“ ist.
      • ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „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, z. B. Sysparm_query=<col_name> <operator> <value>[<operator> <col_name> <operator> <value>] .

    Zum Beispiel:

    (Sysparm_query=caller_ID=javascript:gs.getUserID()^Active=wahr)

    Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie SORTIEREN NACH Und ORDERBYDESC Klauseln in sysparm_query.

    Syntax:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    Beispiel: Sysparm_query=Active=wahr^ORDERBYNummer^ORDERBYDESCCATEGORY

    Diese Abfrage filtert alle aktiven Datensätze und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.

    Datentyp: Zeichenfolge

    Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 11. Antwort-Header
    Header 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.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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"
    }
    Ergebnis.average_image_color Wenn der Anhang ein Bild ist, die Summe aller Farben.

    Datentyp: Zeichenfolge

    Einheit: RGB oder Anzahl der Pixel.

    result.compressed 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

    Ergebnis.created_by_Name Vollständiger Name der Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.Download_Link URL des Anhangs auf herunterladen ServiceNowInstanz.

    Datentyp: Zeichenfolge

    Ergebnis.Dateiname Dateiname des Anhangs.

    Datentyp: Zeichenfolge

    Ergebnis.Image_height Bei einer Bilddatei die Höhe des Bildes.

    Datentyp: Zeichenfolge

    Einheit: Pixel

    Ergebnis.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

    Ergebnis.sys_created_by Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_created_on Datum und Uhrzeit der anfänglichen Speicherung der Anhangdatei in der Instanz.

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID der Anhangdatei.

    Datentyp: Zeichenfolge

    Ergebnis.sys_mod_count Gibt an, wie oft die Anhangsdatei geändert wurde (in die Instanz hochgeladen).

    Datentyp: Zeichenfolge

    Ergebnis.sys_Tags Alle System-Tags, die der Anhangdatei zugeordnet sind.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_by Entität, die die Anhangdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Anhangsdatei.

    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

    Ergebnis.aktualisiert_by_Name Vollständiger Name der Entität, die die Anhangsdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Beispiel für 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 – RUFT /now/attachment_csm/{sys_ID}/file AB

    Gibt den Dateianhang für die angegebene sys_ID des Anhangs zurück

    URL-Format

    Versionierte URL: /api/now/{api_Version}/attachment_csm/{sys_ID}/file

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfad-Parameter
    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

    sys_id SYS_ID des Anhangs. Dieser Anhang muss zu einer der Tabellen gehören, die in aufgeführt sind glide.rest.attachment_csm_api.allowed_tablesEigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    Datentyp: Zeichenfolge

    Tabelle: Anhänge [sys_attachment]

    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Verwenden Sie beispielsweise Image/JPEG Oder Bild/PNG Dient ausschließlich zum Akzeptieren von JPEG- oder PNG-Bilddateien. Geben Sie an, um alle Bildtypen zuzulassen Bild/* ; Um einen beliebigen Dateityp zuzulassen, geben Sie an */* .

    Standard: */*

    Tabelle : 17. Antwort-Header
    Header Beschreibung
    X-Anhang-Metadaten 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Gibt an, dass der Anhang aus dieser Tabelle möglicherweise nicht zugänglich ist. Stellen Sie sicher, dass die zugeordnete Tabelle in enthalten ist glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter

    Name Beschreibung
    Inhalt des Anhangs.

    Beispiel für 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} ab

    Gibt die Metadaten für die Anhangdatei mit der spezifischen Anhang-sys_ID zurück

    URL-Format

    Versionierte URL: /api/now/{api_Version}/attachment_csm/{sys_ID}

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    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

    sys_id SYS_ID des Anhangsdatensatzes, für den Metadaten zurückgegeben werden sollen. Dieser Anhang muss zu einer der Tabellen gehören, die in aufgeführt sind glide.rest.attachment_csm_api.allowed_tablesEigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    Datentyp: Zeichenfolge

    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 23. Antwort-Header
    Header 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. Gibt an, dass der Anhang aus dieser Tabelle möglicherweise nicht zugänglich ist. Stellen Sie sicher, dass die zugeordnete Tabelle in enthalten ist glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch.
    404 Nicht gefunden. Gibt an, dass der angegebene Anhang nicht vorhanden ist oder der aktuelle Anwender nicht über die Rechte zum Zugriff darauf verfügt.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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"
    }
    Ergebnis.average_image_color Wenn der Anhang ein Bild ist, die Summe aller Farben.

    Datentyp: Zeichenfolge

    Einheit: RGB oder Anzahl der Pixel.

    result.compressed 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

    Ergebnis.created_by_Name Vollständiger Name der Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.Download_Link URL des Anhangs auf herunterladen ServiceNowInstanz.

    Datentyp: Zeichenfolge

    Ergebnis.Dateiname Dateiname des Anhangs.

    Datentyp: Zeichenfolge

    Ergebnis.Image_height Bei einer Bilddatei die Höhe des Bildes.

    Datentyp: Zeichenfolge

    Einheit: Pixel

    Ergebnis.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

    Ergebnis.sys_created_by Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_created_on Datum und Uhrzeit der anfänglichen Speicherung der Anhangdatei in der Instanz.

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID der Anhangdatei.

    Datentyp: Zeichenfolge

    Ergebnis.sys_mod_count Gibt an, wie oft die Anhangsdatei geändert wurde (in die Instanz hochgeladen).

    Datentyp: Zeichenfolge

    Ergebnis.sys_Tags Alle System-Tags, die der Anhangdatei zugeordnet sind.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_by Entität, die die Anhangdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Anhangsdatei.

    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

    Ergebnis.aktualisiert_by_Name Vollständiger Name der Entität, die die Anhangsdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Beispiel für 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: VERÖFFENTLICHEN SIE /now/attachment_csm/file

    Lädt eine angegebene Binärdatei als Anhang zu einem angegebenen Datensatz hoch.

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

    URL-Format

    Versionierte URL: /api/now/{api_Version}/attachment_csm/file

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfad-Parameter
    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
    Encryption_context SYS_ID eines Verschlüsselungskontextdatensatzes. Geben Sie diesen Parameter an, damit nur Anwender 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: Angehängte Datei ist mit keinem Verschlüsselungskontext verschlüsselt.

    file_name Erforderlich. Name, der dem Anhang zugewiesen werden soll.
    Hinweis:
    Die anzuhängende Datei muss nach dem letzten Parameter in der übergebenen Abfrageparameterliste angegeben werden.

    Datentyp: Zeichenfolge

    table_name Erforderlich. Name der Tabelle, an die Sie die Datei anhängen möchten. Diese Tabelle muss in aufgeführt werden glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    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. Anforderungstext-Parameter (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 Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Inhaltstyp Erforderlich. Datenformat der zu veröffentlichenden Datei. Verwenden Sie beispielsweise Image/JPEG Oder Bild/PNG Dient ausschließlich zum Veröffentlichen von JPEG- oder PNG-Bilddateien. Geben Sie an, um alle Bildtypen zuzulassen Bild/* ; Um einen beliebigen Dateityp zuzulassen, geben Sie an */* .
    Tabelle : 29. Antwort-Header
    Header 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. Gibt an, dass der Anhang aus dieser Tabelle möglicherweise nicht zugänglich ist. Stellen Sie sicher, dass die zugeordnete Tabelle in enthalten ist glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Gibt den von angegebenen Datensatz an table_nameUnd table_sys_idParameter sind nicht vorhanden oder für den aktuellen Anwender nicht zugänglich.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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"
    }
    Ergebnis.average_image_color Wenn der Anhang ein Bild ist, die Summe aller Farben.

    Datentyp: Zeichenfolge

    Einheit: RGB oder Anzahl der Pixel.

    result.compressed 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

    Ergebnis.created_by_Name Vollständiger Name der Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.Download_Link URL des Anhangs auf herunterladen ServiceNowInstanz.

    Datentyp: Zeichenfolge

    Ergebnis.Dateiname Dateiname des Anhangs.

    Datentyp: Zeichenfolge

    Ergebnis.Image_height Bei einer Bilddatei die Höhe des Bildes.

    Datentyp: Zeichenfolge

    Einheit: Pixel

    Ergebnis.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

    Ergebnis.sys_created_by Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_created_on Datum und Uhrzeit der anfänglichen Speicherung der Anhangdatei in der Instanz.

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID der Anhangdatei.

    Datentyp: Zeichenfolge

    Ergebnis.sys_mod_count Gibt an, wie oft die Anhangsdatei geändert wurde (in die Instanz hochgeladen).

    Datentyp: Zeichenfolge

    Ergebnis.sys_Tags Alle System-Tags, die der Anhangdatei zugeordnet sind.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_by Entität, die die Anhangdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Anhangsdatei.

    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

    Ergebnis.aktualisiert_by_Name Vollständiger Name der Entität, die die Anhangsdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    Zeigt an, wie die JPG-Datei hochgeladen wird Issue_screenshot.jpg In /Images Verzeichnis.

    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: VERÖFFENTLICHEN SIE /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 Anforderung/Formulardaten.
    Hinweis:
    Wenn Sie mehrteilige POST verwenden, stellen Sie sicher, dass der Dateiinhalt nur im letzten Teil der Nachricht enthalten ist. Frühere Teile dürfen nur Metadaten wie Tabellenname und Datensatz-sys_ID enthalten
    Wenn Sie eine mehrteilige POST-Anforderung/Formulardaten zum Hochladen eines Dateianhangs senden, fügen Sie Anhangsdaten in den Formulartext ein, nicht in die URL-Parameter oder den Anforderungstext.
    Tabelle : 31. Obligatorische Werte
    Wert Beschreibung
    Inhaltstyp Inhaltstyp der Datei, der im Nachrichtentext für mehrteilige Uploads enthalten ist.
    Hinweis:
    Sie müssen den Inhaltstyp im Dateiabschnitt 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 angegeben werden glide.rest.attachment_csm_api.allowed_tablesEigenschaft in der Tabelle „Systemeigenschaften“ [sys_properties].

    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

    Versionierte URL: /api/now/{api_Version}/attachment_csm/Upload

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

    Hinweis:
    Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

    Unterstützte Anforderungsparameter

    Tabelle : 32. Pfad-Parameter
    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 : 33. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 34. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 35. Anforderungskopfzeilen.
    Header Beschreibung
    Inhaltstyp Datenformat des Anforderungstexts. Legen Sie diesen Wert auf fest Mehrteilig/Formulardaten Bei Verwendung der mehrteiligen POST-Methode.
    Tabelle : 36. Antwort-Header
    Header Beschreibung
    Standort URL des neuen Anhangs in ServiceNowPlattforminstanz.

    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 : 37. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Gibt an, dass die Anforderung erfolgreich abgeschlossen wurde.
    400 Ungültige Anforderung. Gibt an, dass der Anhang aus dieser Tabelle möglicherweise nicht zugänglich ist. Stellen Sie sicher, dass die zugeordnete Tabelle in enthalten ist glide.rest.attachment_csm_api.allowed_tablesSystemeigenschaft.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen 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.

    Antworttext-Parameter (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"
    }
    Ergebnis.average_image_color Wenn der Anhang ein Bild ist, die Summe aller Farben.

    Datentyp: Zeichenfolge

    Einheit: RGB oder Anzahl der Pixel.

    result.compressed 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

    Ergebnis.created_by_Name Vollständiger Name der Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.Download_Link URL des Anhangs auf herunterladen ServiceNowInstanz.

    Datentyp: Zeichenfolge

    Ergebnis.Dateiname Dateiname des Anhangs.

    Datentyp: Zeichenfolge

    Ergebnis.Image_height Bei einer Bilddatei die Höhe des Bildes.

    Datentyp: Zeichenfolge

    Einheit: Pixel

    Ergebnis.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

    Ergebnis.sys_created_by Entität, die die Anhangsdatei ursprünglich erstellt hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_created_on Datum und Uhrzeit der anfänglichen Speicherung der Anhangdatei in der Instanz.

    Datentyp: Zeichenfolge

    Ergebnis.sys_ID SYS_ID der Anhangdatei.

    Datentyp: Zeichenfolge

    Ergebnis.sys_mod_count Gibt an, wie oft die Anhangsdatei geändert wurde (in die Instanz hochgeladen).

    Datentyp: Zeichenfolge

    Ergebnis.sys_Tags Alle System-Tags, die der Anhangdatei zugeordnet sind.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_by Entität, die die Anhangdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Ergebnis.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Anhangsdatei.

    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

    Ergebnis.aktualisiert_by_Name Vollständiger Name der Entität, die die Anhangsdatei zuletzt aktualisiert hat.

    Datentyp: Zeichenfolge

    Beispiel für 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"
      }
    }