API de pièce jointe CSM

L’API de pièce jointe CSM fournit des points de terminaison qui permettent aux utilisateurs internes et externes de charger, de télécharger et de supprimer les pièces jointes associées à une table et de récupérer les métadonnées de la pièce jointe.

Seules les pièces jointes associées aux tables spécifiées dans la glide.rest.attachment_csm_api.allowed_tables propriété système sont valides pour les appels de points de terminaison associés. Tout utilisateur connecté, snc_internal ou snc_external, peut accéder à cette API. Les invités et les utilisateurs publics n’ont pas de droits d’accès.

Cette API respecte toutes les limitations système sur les fichiers chargés, telles que la taille maximale des fichiers et les types de pièces jointes autorisés. Vous pouvez contrôler ces paramètres à l’aide des com.glide.attachment.max_size propriétés and glide.attachment.extensions .

Par défaut, cette API a une limite de taux de 500 par heure pour les utilisateurs non authentifiés et snc_external. Pour plus d’informations sur la limitation des débits, consultez Limitation des débits de l’API REST entrante.

Pièce jointe CSM : SUPPRIMER /now/attachment_csm/{sys_id}

Supprime la pièce jointe spécifiée.

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm/{sys_id}

URL par défaut : /api/now/v1/attachment_csm/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de la pièce jointe à supprimer. Cette pièce jointe doit appartenir à l’une des tables répertoriées dans la glide.rest.attachment_csm_api.allowed_tables propriété dans la table Propriétés système [sys_properties]. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

Tableau 3. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes

En-tête	Description
Aucun

Tableau 5. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

Code d'état	Description
204	Réussi. Indique que la demande a été effectuée avec succès.
400	Demande incorrecte. Indique que la pièce jointe de cette table n’est peut-être pas accessible. Vérifiez que la table associée est incluse dans la glide.rest.attachment_csm_api.allowed_tables propriété système.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
Aucun

Exemple de demande cURL

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

None

Pièce jointe CSM : GET /now/attachment_csm

Renvoie les métadonnées pour plusieurs pièces jointes.

Remarque :

Vous pouvez référencer tous les paramètres de requête sysparm à l’aide de leur nom complet ou de leur nom abrégé (sans le sysparm_ préfixe). Par exemple, pour sysparm_limit vous pouvez également utiliser limit.

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm

URL par défaut : /api/now/v1/attachment_csm

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier. Remarque : Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 20 Maximum : 100
sysparm_offset	Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre sysparm_offset=sysparm_offset+sysparm_limit, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requis. Requête codée à utiliser pour rechercher des pièces jointes. Ce paramètre doit contenir au moins sysparm_query=table_name=<table> où <table> ne peuvent être que les tables spécifiées dans la glide.rest.attachment_csm_api.allowed_tables propriété située dans la table Propriétés système [sys_properties]. Par exemple : sysparm_query=file_name=kb_knowledge. Syntaxe : sysparm_query=<col_name><operator><value>. <col_name> : nom de la colonne de table à laquelle appliquer le filtre. <operator> : prend en charge les valeurs suivantes : = : correspond exactement à <value>. != : ne correspond pas à <value>. ^ : instructions de requête logiques ET multiples. ^OR : instructions de requête logiques OU multiples. LIKE : <col_name> contient la chaîne spécifiée. Fonctionne uniquement pour les champs <col_name> dont les données sont de type chaîne. STARTSWITH : <col_name> commence par la chaîne spécifiée. Fonctionne uniquement pour les champs <col_name> dont les données sont de type chaîne. ENDSWITH : <col_name> se termine par la chaîne spécifiée. Fonctionne uniquement pour les champs <col_name> dont les données sont de type chaîne. <value> : valeur avec laquelle établir une correspondance. Tous les paramètres sont sensibles à la casse. Les requêtes peuvent contenir plusieurs entrées, telles que sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Par exemple : (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Les requêtes codées prennent également en charge le classement par fonctionnalité. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Syntaxe : ORDERBY<col_name> ORDERBYDESC<col_name> Par exemple : sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Cette requête filtre tous les enregistrements actifs et classe les résultats par ordre croissant, par nombre, puis dans l'ordre décroissant des catégories. Type de données : chaîne

Tableau 9. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 10. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 11. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Métadonnées pour la pièce jointe demandée. Type de données : objet "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	Si la pièce jointe est une image, la somme de toutes les couleurs. Type de données : chaîne Unité : RVB ou nombre de pixels.
résultat.compressé	Marqueur indiquant si le fichier de pièce jointe a été compressé. Valeurs possibles : vrai : le fichier a été compressé. faux : le fichier n’a pas été compressé. Type de données : chaîne
result.content_type	Type de contenu du fichier de pièce jointe associé, tel que image ou jpeg ou application/x-shockwave-flash. Type de données : chaîne
result.created_by_name	Nom complet de l’entité qui a initialement créé le fichier en pièce jointe. Type de données : chaîne
result.download_link	URL de téléchargement de la pièce jointe sur l’instance ServiceNow . Type de données : chaîne
result.file_name	Nom de fichier de la pièce jointe. Type de données : chaîne
result.image_height	S’il s’agit d’un fichier image, la hauteur de l’image. Type de données : chaîne Unité : Pixels
result.image_width	S’il s’agit d’un fichier image, la largeur de l’image. Type de données : chaîne Unité : Pixels
result.size_bytes	Taille de la pièce jointe. Type de données : chaîne Unité : Octets
result.size_compressed	Taille du fichier de pièce jointe compressé. Si le fichier n’est pas compressé, vide. Type de données : chaîne Unité : Octets
result.sys_created_by	Entité qui a créé à l’origine le fichier en pièce jointe. Type de données : chaîne
result.sys_created_on	Date et heure auxquelles le fichier en pièce jointe a été initialement enregistré dans l’instance. Type de données : chaîne
result.sys_id	Sys_id du fichier en pièce jointe. Type de données : chaîne
result.sys_mod_count	Nombre de fois où le fichier de pièce jointe a été modifié (téléchargé dans l’instance). Type de données : chaîne
result.sys_balises	Toutes les balises système associées au fichier en pièce jointe. Type de données : chaîne
result.sys_updated_by	Entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne
result.sys_updated_on	Date et heure de la dernière mise à jour du fichier en pièce jointe. Type de données : chaîne
result.table_name	Nom de la table à laquelle la pièce jointe est associée. Type de données : chaîne
result.table_sys_id	Sys_id de la table associée à la pièce jointe. Type de données : chaîne
result.updated_by_name	Nom complet de l’entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne

Exemple de demande cURL

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

Pièce jointe CSM : GET /now/attachment_csm/{sys_id}/file

Renvoie la pièce jointe pour le sys_id de pièce jointe spécifié.

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm/{sys_id}/file

URL par défaut : /api/now/v1/attachment_csm/{sys_id}/file

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de la pièce jointe. Cette pièce jointe doit appartenir à l’une des tables répertoriées dans la glide.rest.attachment_csm_api.allowed_tables propriété dans la table Propriétés système [sys_properties]. Type de données : chaîne Table : pièces jointes [sys_attachment]

Tableau 14. Paramètres de requête

Nom	Description
Aucun

Tableau 15. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 16. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Par exemple, utilisez image/jpeg ou image/png pour accepter exclusivement les fichiers image JPEG ou PNG. Pour autoriser tous les types d’images, spécifiez image/* ; Pour autoriser n’importe quel type de fichier, spécifiez */*. Faire défaut:*/*

Tableau 17. En-têtes de réponses

En-tête	Description
Métadonnées x-pièce jointe	Métadonnées sur le fichier renvoyé, telles que la taille, le nom et le type de fichier.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Indique que la pièce jointe de cette table n’est peut-être pas accessible. Vérifiez que la table associée est incluse dans la glide.rest.attachment_csm_api.allowed_tables propriété système.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de réponse

Nom	Description
	Contenu de la pièce jointe.

Exemple de demande cURL

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

Pièce jointe CSM : GET /now/attachment_csm/{sys_id}

Renvoie les métadonnées du fichier de pièce jointe avec le sys_id de pièce jointe spécifique.

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm/{sys_id}

URL par défaut : /api/now/v1/attachment_csm/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de pièce jointe pour lequel renvoyer les métadonnées. Cette pièce jointe doit appartenir à l’une des tables répertoriées dans la glide.rest.attachment_csm_api.allowed_tables propriété dans la table Propriétés système [sys_properties]. Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Aucun

Tableau 21. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 22. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 23. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Indique que la pièce jointe de cette table n’est peut-être pas accessible. Vérifiez que la table associée est incluse dans la glide.rest.attachment_csm_api.allowed_tables propriété système.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes.
404	Introuvable. Indique que la pièce jointe spécifiée n’existe pas ou que l’utilisateur actuel n’a pas les droits pour y accéder.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Métadonnées pour la pièce jointe demandée. Type de données : objet "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	Si la pièce jointe est une image, la somme de toutes les couleurs. Type de données : chaîne Unité : RVB ou nombre de pixels.
résultat.compressé	Marqueur indiquant si le fichier de pièce jointe a été compressé. Valeurs possibles : vrai : le fichier a été compressé. faux : le fichier n’a pas été compressé. Type de données : chaîne
result.content_type	Type de contenu du fichier de pièce jointe associé, tel que image ou jpeg ou application/x-shockwave-flash. Type de données : chaîne
result.created_by_name	Nom complet de l’entité qui a initialement créé le fichier en pièce jointe. Type de données : chaîne
result.download_link	URL de téléchargement de la pièce jointe sur l’instance ServiceNow . Type de données : chaîne
result.file_name	Nom de fichier de la pièce jointe. Type de données : chaîne
result.image_height	S’il s’agit d’un fichier image, la hauteur de l’image. Type de données : chaîne Unité : Pixels
result.image_width	S’il s’agit d’un fichier image, la largeur de l’image. Type de données : chaîne Unité : Pixels
result.size_bytes	Taille de la pièce jointe. Type de données : chaîne Unité : Octets
result.size_compressed	Taille du fichier de pièce jointe compressé. Si le fichier n’est pas compressé, vide. Type de données : chaîne Unité : Octets
result.sys_created_by	Entité qui a créé à l’origine le fichier en pièce jointe. Type de données : chaîne
result.sys_created_on	Date et heure auxquelles le fichier en pièce jointe a été initialement enregistré dans l’instance. Type de données : chaîne
result.sys_id	Sys_id du fichier en pièce jointe. Type de données : chaîne
result.sys_mod_count	Nombre de fois où le fichier de pièce jointe a été modifié (téléchargé dans l’instance). Type de données : chaîne
result.sys_balises	Toutes les balises système associées au fichier en pièce jointe. Type de données : chaîne
result.sys_updated_by	Entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne
result.sys_updated_on	Date et heure de la dernière mise à jour du fichier en pièce jointe. Type de données : chaîne
result.table_name	Nom de la table à laquelle la pièce jointe est associée. Type de données : chaîne
result.table_sys_id	Sys_id de la table associée à la pièce jointe. Type de données : chaîne
result.updated_by_name	Nom complet de l’entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne

Exemple de demande cURL

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

Pièce jointe CSM : POST /now/attachment_csm/file

Charge un fichier binaire spécifié en tant que pièce jointe à un enregistrement spécifié.

Le point de terminaison renvoie également les métadonnées de la pièce jointe enregistrée.

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm/file

URL par défaut : /api/now/v1/attachment_csm/file

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 26. Paramètres de requête

Nom	Description
encryption_context	Sys_id d’un enregistrement de contexte de chiffrement. Spécifiez ce paramètre pour permettre uniquement aux utilisateurs ayant le contexte de chiffrement spécifié d’accéder à la pièce jointe. Pour plus d’informations sur les enregistrements de contexte de chiffrement, reportez-vous à la section Field Encryption. Type de données : chaîne Par défaut : le fichier joint n’est chiffré avec aucun contexte de chiffrement.
file_name	Requis. Nom à donner en pièce jointe. Remarque : Le fichier à joindre doit être spécifié après le dernier paramètre de la liste de paramètres de requête transmise. Type de données : chaîne
table_name	Requis. Nom de la table à laquelle vous souhaitez joindre le fichier. Cette table doit être répertoriée dans la glide.rest.attachment_csm_api.allowed_tables propriété système de la table Propriétés système [sys_properties]. Type de données : chaîne
table_sys_id	Requis. Sys_id de l’enregistrement de la table spécifiée à laquelle vous souhaitez joindre le fichier. Type de données : chaîne

Tableau 27. Paramètres de corps de demande (XML ou JSON)

Nom	Description
<chaîne>	Chemin d’accès au fichier binaire à joindre à l’enregistrement spécifié. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 28. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Requis. Format des données du fichier à publier. Par exemple, utilisez image/jpeg ou image/png pour publier exclusivement des fichiers image JPEG ou PNG. Pour autoriser tous les types d’images, spécifiez image/* ; Pour autoriser n’importe quel type de fichier, spécifiez */*.

Tableau 29. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Indique que la pièce jointe de cette table n’est peut-être pas accessible. Vérifiez que la table associée est incluse dans la glide.rest.attachment_csm_api.allowed_tables propriété système.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. Indique que l’enregistrement spécifié par les paramètres et table_sys_id n’existe table_name pas ou n’est pas accessible par l’utilisateur actuel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Métadonnées pour la pièce jointe demandée. Type de données : objet "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	Si la pièce jointe est une image, la somme de toutes les couleurs. Type de données : chaîne Unité : RVB ou nombre de pixels.
résultat.compressé	Marqueur indiquant si le fichier de pièce jointe a été compressé. Valeurs possibles : vrai : le fichier a été compressé. faux : le fichier n’a pas été compressé. Type de données : chaîne
result.content_type	Type de contenu du fichier de pièce jointe associé, tel que image ou jpeg ou application/x-shockwave-flash. Type de données : chaîne
result.created_by_name	Nom complet de l’entité qui a initialement créé le fichier en pièce jointe. Type de données : chaîne
result.download_link	URL de téléchargement de la pièce jointe sur l’instance ServiceNow . Type de données : chaîne
result.file_name	Nom de fichier de la pièce jointe. Type de données : chaîne
result.image_height	S’il s’agit d’un fichier image, la hauteur de l’image. Type de données : chaîne Unité : Pixels
result.image_width	S’il s’agit d’un fichier image, la largeur de l’image. Type de données : chaîne Unité : Pixels
result.size_bytes	Taille de la pièce jointe. Type de données : chaîne Unité : Octets
result.size_compressed	Taille du fichier de pièce jointe compressé. Si le fichier n’est pas compressé, vide. Type de données : chaîne Unité : Octets
result.sys_created_by	Entité qui a créé à l’origine le fichier en pièce jointe. Type de données : chaîne
result.sys_created_on	Date et heure auxquelles le fichier en pièce jointe a été initialement enregistré dans l’instance. Type de données : chaîne
result.sys_id	Sys_id du fichier en pièce jointe. Type de données : chaîne
result.sys_mod_count	Nombre de fois où le fichier de pièce jointe a été modifié (téléchargé dans l’instance). Type de données : chaîne
result.sys_balises	Toutes les balises système associées au fichier en pièce jointe. Type de données : chaîne
result.sys_updated_by	Entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne
result.sys_updated_on	Date et heure de la dernière mise à jour du fichier en pièce jointe. Type de données : chaîne
result.table_name	Nom de la table à laquelle la pièce jointe est associée. Type de données : chaîne
result.table_sys_id	Sys_id de la table associée à la pièce jointe. Type de données : chaîne
result.updated_by_name	Nom complet de l’entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne

Exemple de demande cURL

Affiche comment télécharger le fichier .jpg Issue_screenshot.jpg dans le répertoire /images .

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

Pièce jointe gestionnaire du service à la clientèle : PUBLIER /maintenant/attachment_csm/charger

Télécharge une pièce jointe de fichier en plusieurs parties.

La méthode POST en plusieurs parties n’accepte aucun paramètre. Vous devez spécifier le nom de la table et les valeurs des sys_id d’enregistrement dans le corps du formulaire. Consultez l’exemple cURL ci-dessous pour obtenir un exemple de demande en plusieurs parties/form-data.

Remarque :

Lorsque vous utilisez POST en plusieurs parties, assurez-vous que le contenu du fichier est contenu dans la dernière partie du message uniquement. Les parties antérieures ne doivent contenir que des métadonnées telles que le nom de table et le sys_id d’enregistrement.

Lors de l’envoi d’une demande POST en plusieurs parties/données de formulaire pour charger une pièce jointe, incluez les données de pièce jointe dans le corps du formulaire, et non dans les paramètres d’URL ou le corps de la demande.

Tableau 31. Valeurs obligatoires

Valeur	Description
Type de contenu	Type de contenu du fichier, inclus dans le corps du message pour les chargements partitionnés. Remarque : Vous devez définir le type de contenu dans la partie fichier du message POST, et non dans les données du formulaire. Type de données : chaîne
table_name	Nom de la table à laquelle vous souhaitez joindre le fichier. Cette table doit être spécifiée dans la glide.rest.attachment_csm_api.allowed_tables propriété de la table Propriétés système [sys_properties]. Type de données : chaîne
table_sys_id	Sys_id de l’enregistrement de la table spécifiée à laquelle vous souhaitez joindre le fichier. Type de données : chaîne

Format d'URL

URL versionnée : /api/now/{api_version}/attachment_csm/upload

URL par défaut : /api/now/v1/attachment_csm/upload

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 32. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 33. Paramètres de requête

Nom	Description
Aucun

Tableau 34. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 35. En-têtes de demandes

En-tête	Description
Type de contenu	Format de données du corps de la demande. Définissez cette valeur sur multipart/form-data lors de l’utilisation de la méthode POST en plusieurs parties.

Tableau 36. En-têtes de réponses

En-tête	Description
Emplacement	URL de la nouvelle pièce jointe dans l’instance de ServiceNow plateforme.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 37. Codes d'état

Code d'état	Description
201	Réussi. Indique que la demande a été effectuée avec succès.
400	Demande incorrecte. Indique que la pièce jointe de cette table n’est peut-être pas accessible. Vérifiez que la table associée est incluse dans la glide.rest.attachment_csm_api.allowed_tables propriété système.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. L'élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
résultat	Métadonnées pour la pièce jointe demandée. Type de données : objet "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	Si la pièce jointe est une image, la somme de toutes les couleurs. Type de données : chaîne Unité : RVB ou nombre de pixels.
résultat.compressé	Marqueur indiquant si le fichier de pièce jointe a été compressé. Valeurs possibles : vrai : le fichier a été compressé. faux : le fichier n’a pas été compressé. Type de données : chaîne
result.content_type	Type de contenu du fichier de pièce jointe associé, tel que image ou jpeg ou application/x-shockwave-flash. Type de données : chaîne
result.created_by_name	Nom complet de l’entité qui a initialement créé le fichier en pièce jointe. Type de données : chaîne
result.download_link	URL de téléchargement de la pièce jointe sur l’instance ServiceNow . Type de données : chaîne
result.file_name	Nom de fichier de la pièce jointe. Type de données : chaîne
result.image_height	S’il s’agit d’un fichier image, la hauteur de l’image. Type de données : chaîne Unité : Pixels
result.image_width	S’il s’agit d’un fichier image, la largeur de l’image. Type de données : chaîne Unité : Pixels
result.size_bytes	Taille de la pièce jointe. Type de données : chaîne Unité : Octets
result.size_compressed	Taille du fichier de pièce jointe compressé. Si le fichier n’est pas compressé, vide. Type de données : chaîne Unité : Octets
result.sys_created_by	Entité qui a créé à l’origine le fichier en pièce jointe. Type de données : chaîne
result.sys_created_on	Date et heure auxquelles le fichier en pièce jointe a été initialement enregistré dans l’instance. Type de données : chaîne
result.sys_id	Sys_id du fichier en pièce jointe. Type de données : chaîne
result.sys_mod_count	Nombre de fois où le fichier de pièce jointe a été modifié (téléchargé dans l’instance). Type de données : chaîne
result.sys_balises	Toutes les balises système associées au fichier en pièce jointe. Type de données : chaîne
result.sys_updated_by	Entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne
result.sys_updated_on	Date et heure de la dernière mise à jour du fichier en pièce jointe. Type de données : chaîne
result.table_name	Nom de la table à laquelle la pièce jointe est associée. Type de données : chaîne
result.table_sys_id	Sys_id de la table associée à la pièce jointe. Type de données : chaîne
result.updated_by_name	Nom complet de l’entité qui a mis à jour le fichier en pièce jointe pour la dernière fois. Type de données : chaîne

Exemple de demande cURL

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