REST API - Download a document
Last modified on 2023/01/23 11:04
Contents
GET /requests/{rfc_number}/documents/{document_id}
- This method allows a specified document to be downloaded.
example /requests/I221024_000001/documents/40000_9ae8ab51e5eb847d76a72aeac2a0f1c99f1039cebd585b49e6b1914c43bf7
- All documents attached to all types of tickets can be uploaded: incidents, service requests, change requests, investment requests, problems, events.
Notes
See Service Manager REST API Conventions
- If successful, an HTTP status code 200 is returned.
Best Practice
- To obtain the document identifier {document_id}: refer to the View the list of the URL of documents attached to a ticket method.
List of parameters / fields
Mandatory parameters
You must use the parameter below in the URL.
| Parameter | Type | Description / Example |
|---|---|---|
| rfc_number | integer | Request key. |
| document_id | integer | Document key. |
Optional parameters
| Minimum version | Parameter | Type | Description / Example | ||
|---|---|---|---|---|---|
| Autumn 2020 - Build 2020.2.125.3 | encoding | string | Encode the document in base64.
|
HTTP status codes for the method
StatusHeader
Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).
| 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 Service Manager account.
example { "error": "Invalid Login / Password" } |
Status403
| 403 | Forbidden | Server refused to execute the request. Unlike error 401, authentication is accepted but access rights do not authorize the client to access the resource: The user does not have the REST API parameter enabled in their profile. |
Status404
| 404 | Not Found | Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
example { "error": "Resource not found" } |
ConventionsAPI
REST API Conventions
| Convention | Meaning | |
|---|---|---|
| Orange | Parameters used in an HTTP request string which do not correspond to Service Manager database fields.
example 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 Service Manager database fields.
example 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 Service Manager database fields; they allow the value of a database field to be assigned or modified.
example 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 Service Manager database fields.
example Method Reopen an incident/request { "restarted": { "comment": "string (required)" } } |
||