{"id":24229,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/addattachment-1\/"},"modified":"2025-02-17T09:38:04","modified_gmt":"2025-02-17T17:38:04","slug":"addattachment-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/","title":{"rendered":"add_attachment"},"content":{"rendered":"

This action uploads a file from the local file system to be attached to an existing record in ExtraView. It is designed to be used within an HTML form. Note that the syntax and usage of this command is different to other API commands; extra care should therefore be taken when using the add_attachment command.<\/p>\n

\n\tSYNTAX<\/h3>\n

<FORM METHOD=”post” action=http:\/\/www.myserver.com\/dev\/ExtraView\/ev_api.action?
\n\tuser_id=username
\n\t&password=password <\/span><\/span>OR <\/span>[&access_token=token-value]
\n\t&statevar=add_attachment
\n\t&p_template_file=template_filename
\n\t[&strict=no | yes]
\n\t <\/span><\/p>\n

This command must have additional parameters that are not part of the FORM tag, but are part of the HTML within the <\/span><form> … … <\/form><\/span> <\/span>construct. These will be provided as part of the INPUT tags within the form. The INPUT tags that must be provided are:<\/p>\n\n\n\n\n\n\n
\n\t\t\t\tTag name<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
\n\t\t\t\tp_id<\/td>\n\n\t\t\t\tThe issue ID<\/td>\n<\/tr>\n
\n\t\t\t\tp_attach_desc<\/td>\n\n\t\t\t\tThe description of the attachment<\/td>\n<\/tr>\n
\n\t\t\t\tfile<\/td>\n\n\t\t\t\tThe filename of the attachment<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The following example shows how this API command is used from within an HTML form. The example includes the use of a template file that formats the results returned from ExtraView.<\/p>\n

\n\tAdding an attachment from an HTML page<\/h3>\n

<html>
\n\t<title>Add an attachment to an existing issue<\/title>
\n\t<body>
\n\t<form method=”POST”
\n\t    action=”http:\/\/myserver.extraview.net\/dev\/ExtraView\/ev_api.action?
\n\t    statevar=add_attachment&p_template_file=attach_results.html&p_id=12345″
\n\t    enctype=”multipart\/form-data”>
\n\t<input type=”hidden” name=”p_id” value=”12345″>
\n\t<table>
\n\t<tr>
\n\t<td>Description<\/td>
\n\t<td><input type=”text” size=”40″ name=”p_attach_desc”><\/td>
\n\t<\/tr>
\n\t<tr>
\n\t<td colspan=”2″>Add attachment<\/td>
\n\t<\/tr>
\n\t<tr>
\n\t<td>Filename<\/td>
\n\t<td><input type=”file” size=”40″ name=”file”><\/td>
\n\t<\/tr>
\n\t<tr>
\n\t<td colspan=”2″><input type=”submit” value=”Add Attachment”> <\/td>
\n\t<\/tr>
\n\t<\/table>
\n\t<\/form>
\n\t<\/body>
\n\t<\/html><\/span><\/p>\n

\n\tNote that if you are using a template file to return the results of the command, you must include the parameter named <\/span>p_id<\/span> <\/span>twice within the HTML, once within the <\/span><form …><\/span> <\/span>tag, and once as a hidden field within the <\/span><INPUT …><\/span> <\/span>tag. This is because of the limitations of how browsers work with multi-part forms.<\/p>\n

\n\tattach_results.html<\/span> <\/span>template file<\/h3>\n

This file must reside in the <\/span>WEB-INF\/user_templates<\/span> <\/span>directory. Please see the page on <\/span>server-side templates<\/a> <\/span>for a fuller explanation. Carefully note the following in the example file. The following fields are available as tags within the template.<\/p>\n

You will see in the example that there is a <\/span>__REPEAT_START__, __REPEAT_STOP__<\/span> <\/span>block. This allows the display of all attachments added to the issue, with the one just added being the first in the list. If you only want to see the details of the attachment you just added, you can remove the <\/span>__REPEAT_START__ and __REPEAT_STOP__<\/span> <\/span>statements.<\/p>\n

<html>
\n\t<title> Attachment added to ExtraView <\/title>
\n\t<body>
\n\t<p>Attachment added successfully to issue # __ID__<\/p>
\n\t<br>
\n\tA list of all attachments held in the issue is as follows
\n\t<br><br>
\n\t<table>
\n\t<tr>
\n\t<td>File name<\/td>
\n\t<td>Description<\/td>
\n\t<td>File size<\/td>
\n\t<td>Created By<\/td>
\n\t<td>Date Created<\/td>
\n\t<\/tr>
\n\t__REPEAT_START__
\n\t<tr>
\n\t<td>__FILE_NAME__<\/td>
\n\t<td>__ATTACH_DESC__<\/td>
\n\t<td>__FILE_SIZE__<\/td>
\n\t<td>__CREATED_BY_USER__<\/td>
\n\t<td>__DATE_CREATED__<\/td>
\n\t<\/tr>
\n\t__REPEAT_STOP__
\n\t<\/table>
\n\t<br>
\n\t<\/body>
\n\t<\/html><\/span><\/p>\n

\n\tNOTES<\/h3>\n
    \n
  • \n\t\tThis command uses a different syntax to most other commands within the API. This is to allow ExtraView to handle the multi-part form, used for uploading files to the server<\/li>\n
  • \n\t\tYou can upload and attach the same file multiple times to a single record within ExtraView<\/li>\n
  • \n\t\tThere are no limits to the number of files that can be attached to a single record<\/li>\n
  • \n\t\tEach file uploaded can be up to 4 GB in size<\/li>\n
  • \n\t\tThe syntax of this command is likely to change with future versions of ExtraView, to be consistent with the same action structure as other commands<\/li>\n
  • \n\t\tThe optional parameter <\/span>strict<\/span>, with a value of <\/span>yes<\/span>, enforces the action to operate only on <\/span>ALT_ID.<\/span> <\/span>If there is no match for the value of the <\/span>ALT_ID<\/span> <\/span>in the specified <\/span>ID <\/span><\/span>parameter, then the message <\/span>Invalid Id <\/span><\/em>will be returned.  This means that a matching <\/span>ID<\/span> <\/span>value will be ignored<\/li>\n
  • \n\t\tThe optional access_token<\/code> parameter allows you to use a valid OAuth2 token obtained with the get_token<\/code> command.  If you provide the access_token<\/code> parameter, then the user_id<\/code> and password<\/code> parameters should not be provided.  This prevents the password being sent in clear text over your network connection.<\/li>\n<\/ul>\n\n\n\n\n\n\n\n\n\n\n\n
    \n\t\t\t\tTag name<\/td>\n\n\t\t\t\tPurpose<\/td>\n<\/tr>\n
    \n\t\t\t\t__ATTACH_DESC__<\/td>\n\n\t\t\t\tThe description of the file that was attached<\/td>\n<\/tr>\n
    \n\t\t\t\t__ATTACHMENT_ID__<\/td>\n\n\t\t\t\tThe internal ID of the attachment. Typically not useful for external purposes<\/td>\n<\/tr>\n
    \n\t\t\t\t__CREATED_BY_USER__<\/td>\n\n\t\t\t\tThe user who added the attachment<\/td>\n<\/tr>\n
    \n\t\t\t\t__DATE_CREATED__<\/td>\n\n\t\t\t\tThe date the attachment was created<\/td>\n<\/tr>\n
    \n\t\t\t\t__ID__<\/td>\n\n\t\t\t\tThe ID of the issue to which the attachment was added<\/td>\n<\/tr>\n
    \n\t\t\t\t__FILE_NAME__<\/td>\n\n\t\t\t\tThe filename of the file attached<\/td>\n<\/tr>\n
    \n\t\t\t\t__FILE_SIZE__<\/td>\n\n\t\t\t\tThe size, in bytes, of the attached file<\/td>\n<\/tr>\n
    \n\t\t\t\t__NFILES__<\/td>\n\n\t\t\t\tThe total number of files attached to the issue<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    \t <\/p>\n","protected":false},"excerpt":{"rendered":"

    This action uploads a file from the local file system to be attached to an existing record in ExtraView. It is designed to be used within an HTML form. Note that the syntax and usage of this command is different to other API commands; extra care should therefore be taken when using the add_attachment command….<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24229","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nadd_attachment - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"add_attachment - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This action uploads a file from the local file system to be attached to an existing record in ExtraView. It is designed to be used within an HTML form. Note that the syntax and usage of this command is different to other API commands; extra care should therefore be taken when using the add_attachment command....\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T17:38:04+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/\",\"name\":\"add_attachment - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T17:38:04+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"add_attachment\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"add_attachment - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/","og_locale":"en_US","og_type":"article","og_title":"add_attachment - Product Documentation","og_description":"This action uploads a file from the local file system to be attached to an existing record in ExtraView. It is designed to be used within an HTML form. Note that the syntax and usage of this command is different to other API commands; extra care should therefore be taken when using the add_attachment command....","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T17:38:04+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/","name":"add_attachment - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T17:38:04+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/addattachment-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"add_attachment"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24229","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24229"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24229\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24223"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24229"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}