---
sourceDocument: Australia API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/api-reference

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# GlideSysAttachment - Scoped

# GlideSysAttachment - Scoped {#ariaid-title1}

* Release version: Australia
* 
* Updated March 12, 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 minutes to read

The GlideSysAttachment API provides methods to handle attachments.

Content is returned as a string, not as a byte array when getContent() is
called.

Content is returned as a GlideScriptableInputStream object when getContentStream() is called. The GlideScriptableInputStream contains the actual bytes not converted into a string.

## Scoped GlideSysAttachment - GlideSysAttachment() {#ariaid-title2}

Creates an instance of the GlideSysAttachment class.
{#r_SGSA-GlideSysAttachment__table_iys_ctb_fv__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#r_SGSA-GlideSysAttachment__table_iys_ctb_fv}

## Scoped GlideSysAttachment - addAttribute(String sysAttachmentID, String attrKey, String attrValue) {#ariaid-title3}

Adds a single attribute to an existing attachment record.
See also:

* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-addAttribute_S_S_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - addAttribute(String attrKey, String attrValue)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-addAttribute_S_S "Adds a single attribute to an existing attachment record.").
{#SGSA-addAttribute_S_S_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrKey | String | Key portion of a key-value pair for an attachment attribute. |
| attrValue | String | Value portion of a key-value pair for an attachment attribute. |
[Table 2. Parameters]

{#SGSA-addAttribute_S_S_S__table_rql_3mg_5fc} {#SGSA-addAttribute_S_S_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 3. Returns]

{#SGSA-addAttribute_S_S_S__table_sql_3mg_5fc}  
The following example shows how to add an attribute to a specified attachment with the key <kbd class="ph userinput">author</kbd> and value <kbd class="ph userinput">Fred Luddy</kbd>. The results can be viewed
in the Attachment Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();
    attach.addAttribute("9e1b714601932210f877b455304df0af", "author", "Fred Luddy");

    var result = attach.fetchAttribute("9e1b714601932210f877b455304df0af", "author");

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + " \nValue: " + result.getValue('value')); 
    }

Output:

    Key: author 
    Value: Fred Luddy

## Scoped GlideSysAttachment - addMultipleAttributes(String sysAttachmentID, Object attrsKeyValuePair) {#ariaid-title4}

Adds multiple attributes to an attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-addMultipleAttributes_S_O__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - addMultipleAttributes(Object attrsKeyValuePair)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-addMultipleAttributes_O "Adds multiple attributes to an attachment record.").
{#SGSA-addMultipleAttributes_S_O__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrsKeyValuePair | Object | Attachment attributes in a set of key-value pairs. Each attribute key and its value must be provided as a string. For example: var attachmentAttributes = { "description" : "Photo of the solar system", "dimensions" : "1600 x 300" } |
[Table 4. Parameters]

{#SGSA-addMultipleAttributes_S_O__table_rql_3mg_5fc} {#SGSA-addMultipleAttributes_S_O__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 5. Returns]

{#SGSA-addMultipleAttributes_S_O__table_sql_3mg_5fc}  
The following example shows how to add attributes to a specified attachment. The results can also be verified in the Attachment Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    var attrsKeyValuePair = { };
      attrsKeyValuePair["title"]  = "Add multiple attributes to an attachment";
      attrsKeyValuePair["category"] =  "KB";
      attrsKeyValuePair["length"] =  "5000";

    attach.addMultipleAttributes(attachmentID, attrsKeyValuePair);

    var result = attach.fetchAllAttributes(attachmentID);

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + ", Value: " + result.getValue('value'));
    }

Output:

    Key: title, Value: Add multiple attributes to an attachment
    Key: author, Value: Abel Tuter
    Key: category, Value: KB
    Key: length, Value: 5000

## Scoped GlideSysAttachment - copy(String sourceTable, String sourceID, String targetTable, String targetID) {#ariaid-title5}

Copies attachments from the source record to the target record.
Note:  
Copying an attachment also copies any attributes assigned to it. You can view a list of assigned attributes in the Attachment Attributes \[sys_attachment_list\] table, or run the fetchAllAttributes() method.
{#r_SGSA-copy_S_S_S_S__id_kdj_vjz_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| sourceTable | String | Name of the table with the attachments to be copied. |
| sourceID | String | Source table's sys_id. |
| targetTable | String | Name of the table on which to add the attachments. |
| targetID | String | The sys_id of the record in the target table on which to copy the attachment. |
[Table 6. Parameters]

{#r_SGSA-copy_S_S_S_S__id_kdj_vjz_g5b} {#r_SGSA-copy_S_S_S_S__id_db3_wjz_g5b__entry__2}

| Type | Description |
|-|-|
| String | Array of sys_ids of the attachments that were copied. Table: Attachments \[sys_attachment\] |
[Table 7. Returns]

{#r_SGSA-copy_S_S_S_S__id_db3_wjz_g5b}  
This example shows how to copy attachments from an incident record to a problem record.

    var attachment = new GlideSysAttachment();
    var incidentSysID = 'ab1b30031b04ec101363ff37dc4bcbfc';
    var incGR = new GlideRecord('incident');
    incGR.get(incidentSysID);

    var copiedAttachments = attachment.copy('incident', incidentSysID, 'problem', incGR.getValue('problem_id'));
    gs.info('Copied attachments: ' + copiedAttachments);

Output:

    Copied attachments: 6e4621df1bc420501363ff37dc4bcbb0,a87769531b0820501363ff37dc4bcba2

## Scoped GlideSysAttachment - deleteAllAttributes(String sysAttachmentID) {#ariaid-title6}

Deletes all attributes from an existing attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-deleteAllAttributes_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - deleteAllAttributes()](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-deleteAllAttributes "Deletes all attributes from an existing attachment record.").
{#SGSA-deleteAllAttributes_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
[Table 8. Parameters]

{#SGSA-deleteAllAttributes_S__table_rql_3mg_5fc} {#SGSA-deleteAllAttributes_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the attributes were successfully deleted. Valid values: * true: The attributes were successfully deleted. * false: The attributes were not successfully deleted. {#SGSA-deleteAllAttributes_S__ul_kwy_cth_5fc} |
[Table 9. Returns]

{#SGSA-deleteAllAttributes_S__table_sql_3mg_5fc}  
The following example shows how to delete all attributes assigned to a specified attachment. The results can also be verified in the Attachment Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    attach.deleteAllAttributes(attachmentID);

    var result = attach.fetchAllAttributes(attachmentID);

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + ", Value: " + result.getValue('value')); 
    }

Output:

    Attribute "null" not found for attachment "04f48541083e2e50f877df7a115e31f3"

## Scoped GlideSysAttachment - deleteAttachment(String attachmentID) {#ariaid-title7}

Deletes the specified attachment.
Note:  
Deleting an attachment also deletes any attributes assigned to it. You can view a list of assigned attributes in the Attachment Attributes \[sys_attachment\] table, or run the fetchAllAttributes() method.
{#r_SGSA-deleteAttachment_S__id_ajy_dlz_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| attachmentID | String | Attachment's sys_id. Table: Attachments \[sys_attachment\] |
[Table 10. Parameters]

{#r_SGSA-deleteAttachment_S__id_ajy_dlz_g5b} {#r_SGSA-deleteAttachment_S__table_gjy_lyb_fv__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 11. Returns]

{#r_SGSA-deleteAttachment_S__table_gjy_lyb_fv}  

    var attachment = new GlideSysAttachment();
    var attachmentSysID = 'a87769531b0820501363ff37dc4bcba2';
    attachment.deleteAttachment(attachmentSysID);

## Scoped GlideSysAttachment - deleteAttribute(String sysAttachmentID, String attrKey) {#ariaid-title8}

Deletes a specified attribute from attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-deleteAttribute_S_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - deleteAttribute(String attrKey)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-deleteAttribute_S "Deletes a specified attribute from attachment record.").
{#SGSA-deleteAttribute_S_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrKey | String | Key portion of a key-value pair for an attachment attribute. |
[Table 12. Parameters]

{#SGSA-deleteAttribute_S_S__table_rql_3mg_5fc} {#SGSA-deleteAttribute_S_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the attachment attribute was successfully deleted. Valid values: * true: The attachment attribute was successfully deleted. * false: The attachment attribute was not successfully deleted. {#SGSA-deleteAttribute_S_S__ul_val_cth_5fc} |
[Table 13. Returns]

{#SGSA-deleteAttribute_S_S__table_sql_3mg_5fc}  
The following example shows how to delete an attribute assigned to a specified attachment with the key <kbd class="ph userinput">author</kbd>. The results can also be verified in the Attachment
Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    attach.deleteAttribute(attachmentID, "author");

    var result = attach.fetchAttribute(attachmentID, "author");

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + " \nValue: " + result.getValue('value')); 
    }

Output:

    Attribute "author" not found for attachment "04f48541083e2e50f877df7a115e31f3"

## Scoped GlideSysAttachment - fetchAllAttributes(String sysAttachmentID) {#ariaid-title9}

Fetches all attributes from a specified attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-fetchAllAttributes_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - fetchAllAttributes()](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-fetchAllAttributes "Fetches all attributes from a specified attachment record.").
{#SGSA-fetchAllAttributes_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
[Table 14. Parameters]

{#SGSA-fetchAllAttributes_S__table_rql_3mg_5fc} {#SGSA-fetchAllAttributes_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| [GlideRecord](https://www.servicenow.com/docs/A8srNukp_c6TJp_LS_KZMg#c_GlideRecordScopedAPI "The scoped GlideRecord API is used for database operations.") | The attachment record and all of its attributes. |
[Table 15. Returns]

{#SGSA-fetchAllAttributes_S__table_sql_3mg_5fc}  
The following example shows how to get all attributes assigned to a specified attachment.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    var result = attach.fetchAllAttributes(attachmentID);

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + ", Value: " + result.getValue('value')); 
    }

Output:

    Key: title, Value: Add multiple attributes to an attachment
    Key: author, Value: Abel Tuter
    Key: category, Value: KB
    Key: length, Value: 5000

## Scoped GlideSysAttachment - fetchAttribute(String sysAttachmentID, String attrKey) {#ariaid-title10}

Fetches a specified attribute from an attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-fetchAttribute_S_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - fetchAttribute(String attrKey)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-fetchAttribute "Fetches a specified attribute from an attachment record.").
{#SGSA-fetchAttribute_S_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrKey | String | Key portion of a key-value pair for an attachment attribute. |
[Table 16. Parameters]

{#SGSA-fetchAttribute_S_S__table_rql_3mg_5fc} {#SGSA-fetchAttribute_S_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| [GlideRecord](https://www.servicenow.com/docs/A8srNukp_c6TJp_LS_KZMg#c_GlideRecordScopedAPI "The scoped GlideRecord API is used for database operations.") | The GlideRecord of the attachment and the specified attribute. |
[Table 17. Returns]

{#SGSA-fetchAttribute_S_S__table_sql_3mg_5fc}  
The following example shows how to get an attachment attribute with the key <kbd class="ph userinput">author</kbd>.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    var result = attach.fetchAttribute(attachmentID, "author");

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + " \nValue: " + result.getValue('value')); 
    }

Output:

    Key: author 
    Value: Abel Tuter

## Scoped GlideSysAttachment - getAttachments(String tableName, String sys_id) {#ariaid-title11}

Returns a GlideRecord containing the matching attachment metadata such as name, type,
or size.
{#r_SGSA-getAttachments_S_S__id_bvk_jmz_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| tableName | String | Name of the table to which the attachment belongs; for example, incident. |
| sys_id | String | Sys_id of record to which the attachment belongs. |
[Table 18. Parameters]

{#r_SGSA-getAttachments_S_S__id_bvk_jmz_g5b} {#r_SGSA-getAttachments_S_S__id_urm_kmz_g5b__entry__2}

| Type | Description |
|-|-|
| GlideRecord | GlideRecord object containing the matching attachment metadata such as name, type, or size. |
[Table 19. Returns]

{#r_SGSA-getAttachments_S_S__id_urm_kmz_g5b}  
The following script lists attachment file names for a record with two attachments.

    var attachment = new GlideSysAttachment();

    var agr = attachment.getAttachments('<table_name>', '<record_sys_id>');

    while(agr.next())
    gs.info(agr.getValue('file_name'));

Output:

    *** Script: filename1.txt
    *** Script: filename2.txt

## Scoped GlideSysAttachment - getContent(GlideRecord sysAttachment) {#ariaid-title12}

Returns the attachment content as a string.
This method is for use in scoped applications only. This method returns `undefined` when used in the global scope. To read attachment content in the global scope, use the getContentStream()
method from the GlideSysAttachment - Global API.  
This method supports the following file types for attachments.

* CSV (\*.csv)
* JSON (\*.json)
* Text (\*.txt)
{#r_SGSA-getContent_GR__ul_zd2_w21_cwb}
{#r_SGSA-getContent_GR__table_r2d_cng_2v__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachment | GlideRecord | Attachment record. |
[Table 20. Parameters]

{#r_SGSA-getContent_GR__table_r2d_cng_2v} {#r_SGSA-getContent_GR__table_s2d_cng_2v__entry__2}

| Type | Description |
|-|-|
| String | Attachment contents as a string. Returns up to 5MB of data. |
[Table 21. Returns]

{#r_SGSA-getContent_GR__table_s2d_cng_2v}  

    var attachment = new GlideSysAttachment();

    var agr = attachment.getAttachments('incident', '78271e1347c12200e0ef563dbb9a7109'); //create attachment GlideRecord

    while(agr.next()) { //for each attachment on the incident record
       gs.info(agr.getValue('file_name')); //print file name of attachment
       var attachmentContent = attachment.getContent(agr);
       gs.info('Attachment content: ' + attachmentContent); //print attachment content
    }

Output:

    Doc1.txt
    Attachment content: I am text in a txt file attached to a record.

## Scoped GlideSysAttachment - getContentBase64(GlideRecord sysAttachment) {#ariaid-title13}

Returns the attachment content as a string with base64 encoding.
This method is for use in scoped applications only. This method returns
`undefined` when used in the global scope. To read attachment content in
the global scope, use the getContentStream method from the
GlideSysAttachment - Global API.
{#r_SGSA-getContentBase64_GR__table_kds_4sb_fv__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachment | GlideRecord | Attachment record. |
[Table 22. Parameters]

{#r_SGSA-getContentBase64_GR__table_kds_4sb_fv} {#r_SGSA-getContentBase64_GR__table_lds_4sb_fv__entry__2}

| Type | Description |
|-|-|
| String | Attachment contents as a string with base64 encoding. Returns up to 5MB of data. |
[Table 23. Returns]

{#r_SGSA-getContentBase64_GR__table_lds_4sb_fv}  

    var attachment = new GlideSysAttachment();

    var agr = attachment.getAttachments('incident', '78271e1347c12200e0ef563dbb9a7109'); //create attachment GlideRecord

    while(agr.next()) { //for each attachment on the incident record
       gs.info(agr.getValue('file_name')); //print file name of attachment
       var attachmentContent = attachment.getContentBase64(agr);
       gs.info('Attachment content: ' + attachmentContent); //print attachment content
    }

Output:

    Doc1.txt
    Attachment content: SSBhbSB0ZXh0IGluIGEgdHh0IGZpbGUgYXR0YWNoZWQgdG8gYSByZWNvcmQuIA0=

## Scoped GlideSysAttachment - getContentStream(String sysID) {#ariaid-title14}

Returns a GlideScriptableInputStream object given the sys_id of an
attachment.
You can use the [GlideTextReader](https://www.servicenow.com/docs/9gnaixkHczN0SE0IXlBuLg#c_GlideTextReaderScopedAPI "The GlideTextReader API provides the ability to read single lines from an input stream. Because an input stream is used, it is not subject to the 5MB attachment size limit.") API to read the content stream.
{#r_SGSA-getContentStream_S__id_xhr_q4z_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| sysID | String | Attachment sys_id. |
[Table 24. Parameters]

{#r_SGSA-getContentStream_S__id_xhr_q4z_g5b} {#r_SGSA-getContentStream_S__id_yry_q4z_g5b__entry__2}

| Type | Description |
|-|-|
| GlideScriptableInputStream | Stream that contains the attachment content. |
[Table 25. Returns]

{#r_SGSA-getContentStream_S__id_yry_q4z_g5b}  

    var attachment = new GlideSysAttachment();
    var attachmentSysID = '6e4621df1bc420501363ff37dc4bcbb0';
    var attachmentContentStream = attachment.getContentStream(attachmentSysID);
    gs.info('Attachment content stream: ' + attachmentContentStream);

Output:

    Attachment content stream: com.glide.communications.GlideScriptableInputStream@14bd299

## Scoped GlideSysAttachment - updateAllAttributes(String sysAttachmentID, Object attrsKeyValuePair) {#ariaid-title15}

Updates all the attributes for an existing attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAttribute_S_S_S "Updates a single attribute for an existing attachment record.")

{#SGSA-updateAllAttributes_S_O__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - updateAllAttributes(Object attrsKeyValuePair)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-updateAllAttributes_O "Updates all the attributes for an existing attachment record.").
{#SGSA-updateAllAttributes_S_O__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrsKeyValuePair | Object | Attachment attributes in a set of key-value pairs. Each attribute key and its value must be provided as a string. For example: var attachmentAttributes = { "description" : "Photo of the solar system", "dimensions" : "1600 x 300" } |
[Table 26. Parameters]

{#SGSA-updateAllAttributes_S_O__table_rql_3mg_5fc} {#SGSA-updateAllAttributes_S_O__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 27. Returns]

{#SGSA-updateAllAttributes_S_O__table_sql_3mg_5fc}  
The following example shows how to update each attribute for a specified attachment. The results can also be verified in the Attachment Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    var attachmentAttributes = {
        "category" : "Training",
        "title" : "Updating attachment attributes", 
        "author" : "Abraham Lincoln",
        "length" : "6000"
    }

    attach.updateAllAttributes(attachmentID, attachmentAttributes);

    var result = attach.fetchAllAttributes(attachmentID);

    while(result.next()) {
       gs.info("Key: " + result.getValue('key') + ", Value: " + result.getValue('value'));
    }

Output:

    Key: title, Value: Updating attachment attributes
    Key: author, Value: Abraham Lincoln
    Key: category, Value: Training
    Key: length, Value: 6000

## Scoped GlideSysAttachment - updateAttribute(String sysAttachmentID, String attrKey, String attrValue) {#ariaid-title16}

Updates a single attribute for an existing attachment record.
See also:

* [addAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addAttribute_S_S_S "Adds a single attribute to an existing attachment record.")
* [addMultipleAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-addMultipleAttributes_S_O "Adds multiple attributes to an attachment record.")
* [deleteAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAllAttributes_S "Deletes all attributes from an existing attachment record.")
* [deleteAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-deleteAttribute_S_S "Deletes a specified attribute from attachment record.")
* [fetchAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAllAttributes_S "Fetches all attributes from a specified attachment record.")
* [fetchAttribute()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-fetchAttribute_S_S "Fetches a specified attribute from an attachment record.")
* [updateAllAttributes()](https://www.servicenow.com/docs/HBoKF45_FRddbuZ7MXGYQA#SGSA-updateAllAttributes_S_O "Updates all the attributes for an existing attachment record.")

{#SGSA-updateAttribute_S_S_S__ul_uwj_4yq_zfc}For the global equivalent of this method, use [GlideSysAttachment - updateAttribute(String attrKey, String attrValue)](https://www.servicenow.com/docs/Pmi5thUhwEdQG~h8rRJqAA#GSA-updateAttribute_S_S "Updates a single attribute for an existing attachment record.").
{#SGSA-updateAttribute_S_S_S__table_rql_3mg_5fc__entry__3}

| Name | Type | Description |
|-|-|-|
| sysAttachmentID | String | Sys_id of the attachment listed in the Attachments \[sys_attachment\] table. |
| attrKey | String | Key portion of a key-value pair for an attachment attribute. |
| attrValue | String | Value portion of a key-value pair for an attachment attribute. |
[Table 28. Parameters]

{#SGSA-updateAttribute_S_S_S__table_rql_3mg_5fc} {#SGSA-updateAttribute_S_S_S__table_sql_3mg_5fc__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 29. Returns]

{#SGSA-updateAttribute_S_S_S__table_sql_3mg_5fc}  
The following example shows how to update an attribute assigned to a specified attachment with the key <kbd class="ph userinput">author</kbd> and changes the value to Abel Tuter. The results can also be
verified in the Attachment Attributes \[sys_attachment_attribute\] table.

    var attach = new GlideSysAttachment();

    var attachmentID = '9e1b714601932210f877b455304df0af';

    var originalVal = attach.fetchAttribute(attachmentID, "author");
    while(originalVal.next()) {
       gs.info("Original attribute value: " + originalVal.getValue('value') + "\n"); 
    }

    attach.updateAttribute(attachmentID, "author", "Abel Tuter");

    var updatedVal = attach.fetchAttribute(attachmentID, "author"); 
    while(updatedVal.next()) {
       gs.info("Updated attribute value: " + updatedVal.getValue('value')); 
    }

Output:

    Original attribute value: Fred Luddy

    Updated attribute value: Abel Tuter

## Scoped GlideSysAttachment - write(GlideRecord record, String fileName, String contentType, String content) {#ariaid-title17}

Attaches a specified attachment to the specified record.
{#r_SGSA-write_GR_S_S_S__id_zx4_v4z_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| record | GlideRecord | Record to which to attach the attachment. |
| fileName | String | Attachment file name. |
| contentType | String | MIME type of the attachment, such as `image/png`. Located in the Attachment \[sys_attachment\] table in the Content type field. |
| content | String | Attachment content. |
[Table 30. Parameters]

{#r_SGSA-write_GR_S_S_S__id_zx4_v4z_g5b} {#r_SGSA-write_GR_S_S_S__id_rnx_v4z_g5b__entry__2}

| Type | Description |
|-|-|
| String | Attachment sys_id. Returns null if the attachment was not added. |
[Table 31. Returns]

{#r_SGSA-write_GR_S_S_S__id_rnx_v4z_g5b}  

    var attachment = new GlideSysAttachment();

    //set up inputs
    var rec = new GlideRecord('incident');
    rec.get('78271e1347c12200e0ef563dbb9a7109');
    var fileName = 'example.txt';
    var contentType = 'text/csv';
    var content = 'The text that is stored inside my file';

    var agr = attachment.write(rec, fileName, contentType, content);

    gs.info('The attachment sys_id is: ' + agr);

Output:

    The attachment sys_id is: 01271e4317c13311e0ef563dbb9abe34

## Scoped GlideSysAttachment - writeBase64(GlideRecord now_GR, String fileName, String contentType, String content_base64Encoded) {#ariaid-title18}

Inserts an attachment for the specified record using base64 encoded
content.
{#r_SGSA-writeBase64_GR_S_S_S__table_nfx_fwx_hx__entry__3}

| Name | Type | Description |
|-|-|-|
| now_GR | GlideRecord | Record to which to attach the attachment. |
| fileName | String | Attachment file name. |
| contentType | String | MIME type of the attachment, such as `image/png`. Located in the Attachment \[sys_attachment\] table in the Content type field. |
| content | String | Attachment content in base64 format. |
[Table 32. Parameters]

{#r_SGSA-writeBase64_GR_S_S_S__table_nfx_fwx_hx} {#r_SGSA-writeBase64_GR_S_S_S__table_ofx_fwx_hx__entry__2}

| Type | Description |
|-|-|
| String | Sys_id of the attachment created. |
[Table 33. Returns]

{#r_SGSA-writeBase64_GR_S_S_S__table_ofx_fwx_hx}  

    var attachment = new GlideSysAttachment();

    var rec = new GlideRecord('incident');
    var incidentSysID = 'ab1b30031b04ec101363ff37dc4bcbfc';
    rec.get(incidentSysID);
    var fileName = 'example.txt';
    var contentType = 'text/csv';
    var base64Encodedcontent = 'SSBhbSB0ZXh0Lg==';

    var agr = attachment.writeBase64(rec, fileName, contentType, base64Encodedcontent);

    gs.info('The attachment sys_id is: ' + agr);

Output:

    The attachment sys_id is: 10cde9971b0820501363ff37dc4bcba6

## Scoped GlideSysAttachment - writeContentStream(GlideRecord now_GR, String fileName, String contentType, GlideScriptableInputStream inputStream) {#ariaid-title19}

Inserts an attachment using the input stream.
{#r_SGS-writeContentStrm_GR_S_S_GSIS__id_n5v_npz_g5b__entry__3}

| Name | Type | Description |
|-|-|-|
| now_GR | GlideRecord | Record to which to attach the attachment. |
| fileName | String | Attachment file name. |
| contentType | String | MIME type of the attachment, such as `image/png`. Located in the Attachment \[sys_attachment\] table in the Content type field. |
| content | GlideScriptableInputStream | Attachment content. |
[Table 34. Parameters]

{#r_SGS-writeContentStrm_GR_S_S_GSIS__id_n5v_npz_g5b} {#r_SGS-writeContentStrm_GR_S_S_GSIS__id_lkf_npz_g5b__entry__2}

| Type | Description |
|-|-|
| String | Sys_id of the attachment created. |
[Table 35. Returns]

{#r_SGS-writeContentStrm_GR_S_S_GSIS__id_lkf_npz_g5b}  
Attaches a content stream from the sys_attachment table to a test_table record.

    function copyAttachmentToGlideRecord(conceptSysId) {

      // Get record from test_table using sys_id
      var targetGlideRecord = new GlideRecord("test_table");
      if (!targetGlideRecord.get(conceptSysId)) {
         throw ("Cannot find record created by test with sys_id: " + conceptSysId);
      }

      // Get record from sys_attachment table
      var sourceAttachmentGlideRecord = new GlideRecord('sys_attachment');    
      sourceAttachmentGlideRecord.query();
      sourceAttachmentGlideRecord.next();

      // Get field values from retrieved sys_attachment record
      var fileName = sourceAttachmentGlideRecord.getValue('file_name');
      var contentType = sourceAttachmentGlideRecord.getValue('content_type');
      var sourceAttachmentSysId = sourceAttachmentGlideRecord.getValue('sys_id');

      // Attach sys_attachment record content stream to test_table record
      var gsa = new GlideSysAttachment();
      gsa.writeContentStream(
        targetGlideRecord,
        fileName,
        contentType,
        gsa.getContentStream(sourceAttachmentSysId));
      gs.info("Attachment created");
    }