API de pièce jointe
L’API de pièce jointe fournit des points de terminaison qui vous permettent de charger et d’interroger les pièces jointes de fichiers.
Vous pouvez charger ou récupérer un seul fichier avec chaque demande.
L’API de pièce jointe respecte toutes les limitations système sur les fichiers chargés, telles que la taille maximale et les types de pièces jointes autorisés. Vous pouvez contrôler ces paramètres à l’aide des propriétés com.glide.attachment.max_size, 1024 Mo par défaut, et glide.attachment.extensions.
La vidéo suivante fournit plus d’informations sur l’API des pièces jointes :
Pièces jointes Besoins du rôle API
Pour créer des pièces jointes, l’enregistrement utilisateur utilisé pour authentifier la requête ServiceNow HTTP doit disposer de tous les rôles requis pour créer des enregistrements de pièce jointe [sys_attachment]. Il doit également disposer de tous les rôles nécessaires pour lire et écrire des enregistrements sur la table cible, tels que le rôle itil pour ajouter des pièces jointes aux enregistrements d’incidents.
Par défaut, il n’existe pas de rôle unique permettant à un utilisateur d’ajouter des pièces jointes. Vous pouvez créer un rôle pour autoriser explicitement l’ajout de pièces jointes, puis affecter ce rôle au compte d’utilisateur utilisé pour effectuer la demande.
Pièce jointe : SUPPRIMER /now/attachment/{sys_id}
Supprime une pièce jointe spécifiée.
Format d'URL
URL avec version : /api/now/v1/attachment/{sys_id}
URL par défaut : /api/now/attachment/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 204 | Indique que la demande s’est exécutée avec succès. |
| 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 |
|---|---|
| Néant |
Demande cURL
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5" \
--request DELETE \
--user 'username':'password'
""
Pièce jointe : SUPPRIMER /now/attachment/{sys_id}/attributes
Supprime tous les attributs d’une pièce jointe.
Les attributs sont supprimés de la table Attributs de pièce jointe [sys_attachment_attribute].
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes
URL par défaut : /api/now/attachment/{sys_id}/attributes
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 204 | Aucun contenu. Les attributs ont été supprimés avec succès et aucun contenu n’a été renvoyé dans le corps de la réponse. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| Néant |
Demande cURL
Cet exemple supprime tous les attributs d’une pièce jointe.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request DELETE \
--user 'username':'password'
Corps de la réponse.
""
Pièce jointe : SUPPRIMER /now/attachment/{sys_id}/attributes/{attribute_key}
Supprime un attribut spécifié d’une pièce jointe.
Les attributs sont supprimés de la table Attributs de pièce jointe [sys_attachment_attribute].
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
URL par défaut : /api/now/attachment/{sys_id}/attributes/{attribute_key}
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| attribute_key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 204 | Aucun contenu. L’attribut a été supprimé avec succès et aucun contenu n’a été renvoyé dans le corps de la réponse. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| Néant |
Demande cURL
Cet exemple supprime un attribut spécifié d’une pièce jointe.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request DELETE \
--user 'username':'password'
Corps de la réponse.
""
Pièce jointe : GET /now/attachment
Renvoie les métadonnées pour plusieurs pièces jointes.
Format d'URL
URL versionnée : api/now/v1/attachment
URL par défaut : api/now/attachment
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| sysparm_limit | Limite à appliquer à la pagination. Remarque : Des valeurs de sysparm_limit inhabituellement élevées peuvent avoir un impact sur les performances du système.Type de données : chaîne Valeur par défaut : 1 000 |
| sysparm_offset | Nombre d’enregistrements à exclure de la requête. Utilisez ce paramètre pour obtenir plus d’enregistrements que spécifié dans le sysparm_limit paramètre. Par exemple, si sysparm_limit est défini sur 500, mais que vous souhaitez interroger des enregistrements supplémentaires, vous pouvez spécifier une sysparm_offset valeur de paramètre de 500 pour obtenir le deuxième ensemble d’enregistrements. Type de données : chaîne Par défaut : 0 |
| sysparm_query | Requête codée. Les requêtes de l’API de pièce jointe sont relatives à la table Pièces jointes [sys_attachment]. Par exemple : (sysparm_query=file_name=attachment.doc) La requête codée fournit une prise en charge de Trier par. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Par exemple, Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 |
| En-tête | Description |
|---|---|
| Type de contenu | Type de contenu de la réponse. Pour les demandes de métadonnées, il s’agit du type de contenu des métadonnées, et non du type de contenu des fichiers en pièce jointe. |
| un lien | Liens pour télécharger les pièces jointes. |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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)
| Nom | Description |
|---|---|
| Les informations renvoyées dépendent des pièces jointes sélectionnées. |
Demande cURL
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"
}
]
}
Pièce jointe : GET /now/attachment/{sys_id}
Renvoie les métadonnées du fichier de pièce jointe avec une valeur sys_id spécifique.
Format d'URL
URL avec version : /api/now/v1/attachment/{sys_id}
URL par défaut : /api/now/attachment/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| sys_id | Sys_id de l’enregistrement de pièce jointe dont les métadonnées doivent être récupérées. |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 |
| En-tête | Description |
|---|---|
| Type de contenu | Le type de contenu de la réponse. Pour les demandes de métadonnées, il s’agit du type de contenu des métadonnées, et non du type de contenu des fichiers en pièce jointe. |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 401 | Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises. |
| 404 | Indique que la pièce jointe spécifiée n’existe pas ou que l’utilisateur actuel ne peut pas 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)
| Nom | Description |
|---|---|
| Métadonnées spécifiques à la pièce jointe spécifiée. |
Demande cURL
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"
}
}
Pièce jointe : GET /now/attachment/{sys_id}/attributes
Récupère tous les attributs d’une pièce jointe.
Les attributs sont récupérés à partir de la table Attributs de pièce jointe [sys_attachment_attribute].
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes
URL par défaut : /api/now/attachment/{sys_id}/attributes
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Tableau d’objets contenant une paire clé-valeur pour chaque attribut. Type de données : tableau |
| result.key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| résultat.valeur | Valeur d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : valeur |
Demande cURL
Cet exemple récupère tous les attributs de la pièce jointe spécifiée.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Corps de la réponse.
{
"result": [
{
"key": "example_key",
"value": "example_value"
},
{
"key": "another_key",
"value": "another_value"
}
]
}
Pièce jointe : GET /now/attachment/{sys_id}/attributes/{attribute_key}
Récupère un attribut spécifié à partir d’une pièce jointe.
Les attributs sont récupérés à partir de la table Attributs de pièce jointe [sys_attachment_attribute].
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
URL par défaut : /api/now/attachment/{sys_id}/attributes/{attribute_key}
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| attribute_key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Objet contenant la paire clé-valeur de l’attribut. Type de données : objet |
| result.key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| résultat.valeur | Valeur d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : valeur |
Demande cURL
Cet exemple récupère un attribut spécifié à partir d’une pièce jointe.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Corps de la réponse.
{
"result": {
"key": "example_key",
"value": "example_value"
}
}
Pièce jointe : GET /now/attachment/{sys_id}/file
Renvoie la pièce jointe du fichier binaire avec une valeur sys_id spécifique.
Format d'URL
URL avec version : /api/now/v1/attachment/{sys_id}/file
URL par défaut : /api/now/attachment/{sys_id}/file
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| sys_id | Sys_id de l’enregistrement de pièce jointe à partir duquel renvoyer des données binaires. |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 */*.Par défaut : */* |
| En-tête | Description |
|---|---|
| MÉTADONNÉES X-PIÈCES JOINTES | 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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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)
| Nom | Description |
|---|---|
| Pièce jointe de fichier binaire |
Demande cURL
curl "https://instance.servicenow.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"
Binary response not shown.
Pièce jointe : PATCH /now/attachment/{sys_id}
Renomme une pièce jointe.
Format d'URL
URL avec version : /api/now/{api_version}/attachment/{sys_id}
URL par défaut : /api/now/attachment/{sys_id}
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Table : pièce jointe [sys_attachment] Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| file_name | Requis. Nouveau nom pour la pièce jointe. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 204 | Aucun contenu. La pièce jointe a été renommée avec succès et aucun contenu n’a été renvoyé dans le corps de la réponse. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 401 | Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Informations relatives à l’erreur. Ce paramètre n’est renvoyé qu’en cas d’échec de la demande. Type de données : objet |
| erreur.détail | Détails supplémentaires sur le motif d’échec de la demande. Type de données : chaîne |
| message.erreur | Message d’erreur indiquant le motif de l’échec de la demande. Type de données : chaîne |
| statut | Statut de la demande d’API. Ce paramètre n’est renvoyé que si la demande a échoué, de sorte que la seule valeur possible est échec.Type de données : chaîne |
Demande cURL
Cet exemple renomme une pièce jointe.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"file_name\": \"new_attachment_name\"
}" \
--user 'username':'password'
Corps de la réponse.
""
Pièce jointe : POST /now/attachment/{sys_id}/attributes
Ajoute un attribut à une pièce jointe spécifiée.
Les attributs sont ajoutés dans la table Attributs de pièce jointe [sys_attachment_attribute].
Ce point de terminaison permet d’ajouter un texte alternatif à une pièce jointe.
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes
URL par défaut : /api/now/attachment/{sys_id}/attributes
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| key | Requis. Clé à utiliser pour l’attribut. Type de données : chaîne |
| valide | Requis. Valeur à utiliser pour l’attribut. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 201 | Créé. L’attribut a été créé avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Objet contenant la paire clé-valeur de l’attribut. Type de données : objet |
| result.key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| résultat.valeur | Valeur d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : valeur |
Demande cURL
Cet exemple ajoute un attribut à une pièce jointe.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"key\": \"example_key\",
\"value\": \"example_value\"
}" \
--user 'username':'password'
Corps de la réponse.
{
"result": {
"key": "example_key",
"value": "example_value"
}
}
Pièce jointe : POST /now/attachment/file
Charge un fichier binaire spécifié en tant que pièce jointe à un enregistrement spécifié.
Format d'URL
URL versionnée : /api/now/v1/attachment/file
URL par défaut : /api/now/attachment/file
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| creation_time | Date et heure de création de la pièce jointe. Utilisez ce paramètre pour capturer les heures de création de pièces jointes lorsque le Application Now Mobile est hors ligne et que la pièce jointe est chargée dans un enregistrement ultérieurement. Type de données : chaîne Par défaut : date et heure actuelles. |
| encryption_context | Sys_id d’un enregistrement de contexte de chiffrement. Spécifiez ce paramètre pour autoriser uniquement les utilisateurs ayant le contexte de chiffrement spécifié à 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 est chiffré à l’aide d’un contexte de chiffrement accessible à l’utilisateur, sinon le fichier joint n’est chiffré avec aucun contexte de chiffrement. |
| file_name | Requis. Nom à donner à la pièce jointe. Type de données : chaîne |
| table_name | Requis. Nom de la table à laquelle joindre le fichier. Type de données : chaîne |
| table_sys_id | Requis. Sys_id de l’enregistrement dans la table spécifiée dans table_name laquelle vous souhaitez joindre le fichier. Type de données : chaîne |
| Nom | Description |
|---|---|
| <chaîne> | Chemin d’accès au fichier binaire à joindre à l’enregistrement spécifié. |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 | Type de contenu du fichier à joindre, tel que image/jpeg ou */*. Cet en-tête est obligatoire pour publier des pièces jointes. |
| En-tête | Description |
|---|---|
| Emplacement | URL de la nouvelle pièce jointe. |
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.
| Code d'état | Description |
|---|---|
| 201 | Indique que la requête s’est exécutée avec succès. |
| 400 | Indique qu’un ou plusieurs paramètres obligatoires étaient manquants dans la demande. |
| 404 | Indique que l’enregistrement spécifié par le et table_sys_id paramètres n’existe table_name pas ou n’est pas accessible à 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 de la pièce jointe demandée. Type de données : objet |
| 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 en pièce jointe a été compressé. Valeurs possibles :
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é (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 de pièce jointe pour la dernière fois. Type de données : chaîne |
| result.sys_updated_on | Date et heure de 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 de pièce jointe pour la dernière fois. Type de données : chaîne |
Demande cURL
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"
}
}
Pièce jointe : PUBLIER /now/attachment/upload
Télécharge une pièce jointe de fichier partitionné.
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 pour un exemple de demande de données en plusieurs parties/de formulaire.
Format d'URL
URL versionnée : /api/now/v1/attachment/upload
URL par défaut : /api/now/attachment/upload
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 | Type de contenu de la demande. Définissez cette valeur sur données en plusieurs parties/de formulaire lors de l’utilisation de la méthode POST en plusieurs parties. |
| En-tête | Description |
|---|---|
| Emplacement | URL de la nouvelle pièce jointe. |
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.
| Code d'état | Description |
|---|---|
| 201 | Indique que la requête s’est exécutée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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)
| Élément | Description |
|---|---|
| résultat | Métadonnées de la pièce jointe demandée. Type de données : objet |
| 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 en pièce jointe a été compressé. Valeurs possibles :
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é (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 de pièce jointe pour la dernière fois. Type de données : chaîne |
| result.sys_updated_on | Date et heure de 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 de pièce jointe pour la dernière fois. Type de données : chaîne |
PUBLIER les valeurs obligatoires en plusieurs parties
| Valeur | Description |
|---|---|
| Type de contenu | Type de contenu du fichier, inclus dans le corps du message pour les chargements partitionnés. Remarque :
Le type de contenu doit être défini dans la partie fichier du message POST, et non dans les données du formulaire. Voir l’exemple de message en plusieurs parties POST pour un exemple de message en plusieurs parties. Type de données : chaîne |
| table_name | Nom de la table à laquelle vous souhaitez joindre le fichier. Type de données : chaîne |
| table_sys_id | Sys_id de l’enregistrement sur la table spécifiée à laquelle vous souhaitez joindre le fichier. Type de données : chaîne |
Demande cURL
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"
}
}
Pièce jointe : PUT /now/attachment/{sys_id}/attributes/{attribute_key}
Met à jour la valeur d’un attribut existant pour une pièce jointe.
Les attributs sont mis à jour dans la table Attributs de pièce jointe [sys_attachment_attribute].
Format d'URL
URL versionnée : /api/now/{api_version}/attachment/{sys_id}/attributes/{attribute_key}
URL par défaut : /api/now/attachment/{sys_id}/attributes/{attribute_key}
Paramètres de demande pris en charge
| 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 autre que la plus récente. Type de données : chaîne |
| sys_id | Sys_id de la pièce jointe. Type de données : chaîne Table : pièce jointe [sys_attachment] |
| attribute_key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| valide | Requis. Nouvelle valeur pour l’attribut. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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.
| 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 | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Objet contenant la paire clé-valeur de l’attribut. Type de données : objet |
| result.key | Clé d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : clé |
| résultat.valeur | Valeur d’attribut. Type de données : chaîne Table : attributs de pièce jointe [sys_attachment_attribute] Colonne : valeur |
Demande cURL
Cet exemple met à jour la valeur de l’attribut example_key pour la pièce jointe spécifiée.
curl "https://instance.service-now.com/api/now/attachment/a3af695b0a0006871b657c200acf62e0/attributes/example_key" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"value\": \"new_value\"
}" \
--user 'username':'password'
Corps de la réponse.
{
"result": {
"key": "example_key",
"value": "new_value"
}
}