traq.FileApi

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
delete_file	DELETE /files/{fileId}	ファイルを削除
get_file	GET /files/{fileId}	ファイルをダウンロード
get_file_meta	GET /files/{fileId}/meta	ファイルメタを取得
get_files	GET /files	ファイルメタのリストを取得
get_thumbnail_image	GET /files/{fileId}/thumbnail	サムネイル画像を取得
post_file	POST /files	ファイルをアップロード

delete_file

delete_file(file_id)

ファイルを削除

指定したファイルを削除します。指定したファイルの削除権限が必要です。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    file_id = "fileId_example" # str | ファイルUUID

    # example passing only required values which don't have defaults set
    try:
        # ファイルを削除
        api_instance.delete_file(file_id)
    except traq.ApiException as e:
        print("Exception when calling FileApi->delete_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str	ファイルUUID

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content ファイルが削除できました。	-
403	Forbidden	-
404	Not Found	-

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

get_file

file_type get_file(file_id)

ファイルをダウンロード

指定したファイル本体を取得します。指定したファイルへのアクセス権限が必要です。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    file_id = "fileId_example" # str | ファイルUUID
    dl = 1 # int | 1を指定するとレスポンスにContent-Dispositionヘッダーが付与されます (optional)

    # example passing only required values which don't have defaults set
    try:
        # ファイルをダウンロード
        api_response = api_instance.get_file(file_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_file: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # ファイルをダウンロード
        api_response = api_instance.get_file(file_id, dl=dl)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str	ファイルUUID
dl	int	1を指定するとレスポンスにContent-Dispositionヘッダーが付与されます	[optional]

Return type

file_type

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	OK ファイル本体を返します。 application/octet-streamで返すことになっていますが、ファイルの形式によって変わります。	* Content-Disposition - https://developer.mozilla.org/ja/docs/Web/HTTP/Headers/Content-Disposition
403	Forbidden	-
404	Not Found	-

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

get_file_meta

FileInfo get_file_meta(file_id)

ファイルメタを取得

指定したファイルのメタ情報を取得します。指定したファイルへのアクセス権限が必要です。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from traq.model.file_info import FileInfo
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    file_id = "fileId_example" # str | ファイルUUID

    # example passing only required values which don't have defaults set
    try:
        # ファイルメタを取得
        api_response = api_instance.get_file_meta(file_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_file_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str	ファイルUUID

Return type

FileInfo

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found ファイルが見つかりません。	-

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

get_files

[FileInfo] get_files()

ファイルメタのリストを取得

指定したクエリでファイルメタのリストを取得します。クエリパラメータchannelId, mineの少なくともいずれかが必須です。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from traq.model.file_info import FileInfo
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    channel_id = "channelId_example" # str | アップロード先チャンネルUUID (optional)
    limit = 50 # int | 取得する件数 (optional)
    offset = 150 # int | 取得するオフセット (optional) if omitted the server will use the default value of 0
    since = dateutil_parser('2016-10-12T11:00:00.000000Z') # datetime | 取得する時間範囲の開始日時 (optional) if omitted the server will use the default value of dateutil_parser('0000-01-01T00:00:00Z')
    until = dateutil_parser('2016-10-12T11:00:00.0000000Z') # datetime | 取得する時間範囲の終了日時 (optional)
    inclusive = False # bool | 範囲の端を含めるかどうか (optional) if omitted the server will use the default value of False
    order = "desc" # str | 昇順か降順か (optional) if omitted the server will use the default value of "desc"
    mine = False # bool | アップロード者が自分のファイルのみを取得するか (optional) if omitted the server will use the default value of False

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # ファイルメタのリストを取得
        api_response = api_instance.get_files(channel_id=channel_id, limit=limit, offset=offset, since=since, until=until, inclusive=inclusive, order=order, mine=mine)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
channel_id	str	アップロード先チャンネルUUID	[optional]
limit	int	取得する件数	[optional]
offset	int	取得するオフセット	[optional] if omitted the server will use the default value of 0
since	datetime	取得する時間範囲の開始日時	[optional] if omitted the server will use the default value of dateutil_parser('0000-01-01T00:00:00Z')
until	datetime	取得する時間範囲の終了日時	[optional]
inclusive	bool	範囲の端を含めるかどうか	[optional] if omitted the server will use the default value of False
order	str	昇順か降順か	[optional] if omitted the server will use the default value of "desc"
mine	bool	アップロード者が自分のファイルのみを取得するか	[optional] if omitted the server will use the default value of False

Return type

[FileInfo]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-TRAQ-MORE -
400	Bad Request	-

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

get_thumbnail_image

file_type get_thumbnail_image(file_id)

サムネイル画像を取得

指定したファイルのサムネイル画像を取得します。指定したファイルへのアクセス権限が必要です。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from traq.model.thumbnail_type import ThumbnailType
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    file_id = "fileId_example" # str | ファイルUUID
    type = ThumbnailType("image") # ThumbnailType | 取得するサムネイルのタイプ (optional)

    # example passing only required values which don't have defaults set
    try:
        # サムネイル画像を取得
        api_response = api_instance.get_thumbnail_image(file_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_thumbnail_image: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # サムネイル画像を取得
        api_response = api_instance.get_thumbnail_image(file_id, type=type)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->get_thumbnail_image: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str	ファイルUUID
type	ThumbnailType	取得するサムネイルのタイプ	[optional]

Return type

file_type

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: image/png, image/jpeg

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found ファイルが見つからない、またはサムネイル画像が存在しません。	-

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

post_file

FileInfo post_file(file, channel_id)

ファイルをアップロード

指定したチャンネルにファイルをアップロードします。アーカイブされているチャンネルにはアップロード出来ません。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import file_api
from traq.model.file_info import FileInfo
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# 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 OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = file_api.FileApi(api_client)
    file = open('/path/to/file', 'rb') # file_type | ファイル本体
    channel_id = "channel_id_example" # str | アップロード先チャンネルUUID

    # example passing only required values which don't have defaults set
    try:
        # ファイルをアップロード
        api_response = api_instance.post_file(file, channel_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling FileApi->post_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	file_type	ファイル本体
channel_id	str	アップロード先チャンネルUUID

Return type

FileInfo

Authorization

OAuth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
411	Length Required	-
413	Request Entity Too Large	-

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

Files

FileApi.md

Latest commit

History

FileApi.md

File metadata and controls

traq.FileApi

delete_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_file_meta

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_thumbnail_image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details