FilesApi.md

pyjama.FilesApi

All URIs are relative to http://<jama_endpoint>/rest/latest

Method	HTTP request	Description
download_files	GET /files	Download attachment file from the attachment with the specified Jama URL

download_files

download_files(url)

Download attachment file from the attachment with the specified Jama URL

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import files_api
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = files_api.FilesApi(api_client)
    url = "url_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Download attachment file from the attachment with the specified Jama URL
        api_instance.download_files(url)
    except pyjama.ApiException as e:
        print("Exception when calling FilesApi->download_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
url	str

Return type

void (empty response body)

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]