REST API - View the list of the URL of documents attached to a ticket


GET  /requests/{rfc_number}/documents

Notes

     Open url.png  see REST API Conventions Product name - ev itsm.png

  • If successful, an HTTP status code 200 is returned and URL links (HREF) to the resource, parent resource and each file attachment are provided.

List of parameters / objects

Mandatory parameters

  • You must use the mandatory parameter below in the URL.
     
Parameter Type Description / Example
rfc_number string Ticket identifier

Optional parameters

None

Optional fields

None

HTTP status codes for the method

StatusHeader
Code Error Description
Status200
200 OK (Success) Request processed successfully.
Status401
401 Unauthorized Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "error": "Invalid Login / Password"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
Example documentation icon EN.png
{
 "error": "Resource not found"
}

Example

Result with a status code 200 returned

{
"PARENT_HREF": "https://{your_server}/api/v1/{your_account}/requests/I180919_000006",
"HREF": "https://{your_server}/api/v1/{your_account}/requests/I180919_000006/documents",
   "Documents": [
        {
           "HREF": "https://{your_server}/autoconnect_mail.php?field1=5C0F051E540F056E113E&field2=&field3=&docpath={your_account}/Documents/40000_f53ad2b20c7e234b6a3110fb33bbbb0c174616907b91cf4f2aca4d2559ec1e13&docname=document.docx",
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/requests/I180919_000006",
           "DDL_HREF": "https://{your_server}/api/v1/{your_account}/documents/40000_f53ad2b20c7e234b6a3110fb33bbbb0c174616907b91cf4f2aca4d2559ec1e13/document.docx"
        },
        {
           "HREF": "https://{your_server}/autoconnect_mail.php?field1=5C0F051E540F056E11AD&field2=&field3=&docpath={your_account}/Documents/40000_10d12f1a88001889e0956ad580bd87c48f4707ecf2cbe5f146c3fd742990536c&docname=document.docx",
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/requests/I180919_000006",
           "DDL_HREF": "https://{your_server}/api/v1/{your_account}/documents/40000_10d12f1a88001889e0956ad580bd87c48f4707ecf2cbe5f146c3fd742990536c/document.docx"
        },
        {
           "HREF": "https://{your_server}/autoconnect_mail.php?field1=5C0F051E540F056E1136&field2=&field3=&docpath={your_account}/Documents/40000_2af59b4d2897595383a2b692641e752a61ecb4280c5d189ed075d80ef0b67c45&docname=document.docx",
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/requests/I180919_000006",
           "DDL_HREF": "https://{your_server}/api/v1/{your_account}/documents/40000_2af59b4d2897595383a2b692641e752a61ecb4280c5d189ed075d80ef0b67c45/document.docx"
        }
    ]
}


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string (URL) which do not correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method View a list of assets
https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag
Black and Bold Parameters used in the URL of an HTTP request which correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method View an asset
https://{your_server}/api/v1/{your_account}/assets/{asset_id}
Green Parameters used in the body of an HTTP request which represent JSON object names corresponding to Product name - ev itsm.png database fields; they allow the value of a database field to be assigned or modified.
Example documentation icon EN.png   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2016 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }

Tags:
Last modified by Unknown User on 2018/11/14 12:30
Created by Administrator XWiki on 2017/04/21 12:17

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018