Skip to content

Latest commit

 

History

History
311 lines (236 loc) · 11.1 KB

FiltersApi.md

File metadata and controls

311 lines (236 loc) · 11.1 KB

pyjama.FiltersApi

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

Method HTTP request Description
get_filter GET /filters/{filterId} Get the filter with the specified ID
get_filter_results GET /filters/{filterId}/results Get all result items for the filter with the specified ID
get_filters GET /filters Get all filters viewable by the current user

get_filter

FilterDataWrapper get_filter(filter_id)

Get the filter with the specified ID

Example

  • Basic Authentication (basic):
  • OAuth Authentication (oauth2):
import time
import pyjama
from pyjama.api import filters_api
from pyjama.model.filter_data_wrapper import FilterDataWrapper
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 = filters_api.FiltersApi(api_client)
    filter_id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the filter with the specified ID
        api_response = api_instance.get_filter(filter_id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling FiltersApi->get_filter: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the filter with the specified ID
        api_response = api_instance.get_filter(filter_id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling FiltersApi->get_filter: %s\n" % e)

Parameters

Name Type Description Notes
filter_id int
include [str] Links to include as full objects in the linked map [optional]

Return type

FilterDataWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

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

get_filter_results

ItemDataListWrapper get_filter_results(filter_id)

Get all result items for the filter with the specified ID

Example

  • Basic Authentication (basic):
  • OAuth Authentication (oauth2):
import time
import pyjama
from pyjama.api import filters_api
from pyjama.model.item_data_list_wrapper import ItemDataListWrapper
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 = filters_api.FiltersApi(api_client)
    filter_id = 1 # int | 
    project = 1 # int | Use only for filters that run on any project, where \"projectScope\" is \"CURRENT\" (optional)
    last_activity_date = [
        "lastActivityDate_example",
    ] # [str] | Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\" (optional)
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all result items for the filter with the specified ID
        api_response = api_instance.get_filter_results(filter_id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling FiltersApi->get_filter_results: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all result items for the filter with the specified ID
        api_response = api_instance.get_filter_results(filter_id, project=project, last_activity_date=last_activity_date, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling FiltersApi->get_filter_results: %s\n" % e)

Parameters

Name Type Description Notes
filter_id int
project int Use only for filters that run on any project, where &quot;projectScope&quot; is &quot;CURRENT&quot; [optional]
last_activity_date [str] Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - &quot;yyyy-MM-dd'T'HH:mm:ss.SSSZ&quot; or &quot;yyyy-MM-dd'T'HH:mm:ssZ&quot; [optional]
start_at int [optional]
max_results int If not set, this defaults to 20. This cannot be larger than 50 [optional]
include [str] Links to include as full objects in the linked map [optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

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

get_filters

FilterDataListWrapper get_filters()

Get all filters viewable by the current user

Example

  • Basic Authentication (basic):
  • OAuth Authentication (oauth2):
import time
import pyjama
from pyjama.api import filters_api
from pyjama.model.filter_data_list_wrapper import FilterDataListWrapper
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 = filters_api.FiltersApi(api_client)
    project = 1 # int |  (optional)
    author = 1 # int |  (optional)
    filter_scope = [
        "ALL_PROJECTS",
    ] # [str] | Filter scope. More than one scope can be selected (optional)
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all filters viewable by the current user
        api_response = api_instance.get_filters(project=project, author=author, filter_scope=filter_scope, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling FiltersApi->get_filters: %s\n" % e)

Parameters

Name Type Description Notes
project int [optional]
author int [optional]
filter_scope [str] Filter scope. More than one scope can be selected [optional]
start_at int [optional]
max_results int If not set, this defaults to 20. This cannot be larger than 50 [optional]
include [str] Links to include as full objects in the linked map [optional]

Return type

FilterDataListWrapper

Authorization

basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

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