pyjama.ProjectsApi

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

Method	HTTP request	Description
add_project	POST /projects	Create a new project
get_project	GET /projects/{projectId}	Get the project with the specified ID
get_project_item_types	GET /projects/{projectId}/itemtypes	Get all item types for the project with the specified ID
get_project_tags	GET /projects/{projectId}/tags	Get all tags for the project with the specified ID
get_projects	GET /projects	Get all projects
post_attachment	POST /projects/{projectId}/attachments	Create a new attachment in the project with the specified ID
put_project	PUT /projects/{projectId}	Update the project with the specified ID

add_project

CreatedResponse add_project(body)

Create a new project

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_project import RequestProject
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 = projects_api.ProjectsApi(api_client)
    body = RequestProject(
        project_key="project_key_example",
        is_folder=True,
        parent=1,
        fields={
            "key": {},
        },
    ) # RequestProject | 

    # example passing only required values which don't have defaults set
    try:
        # Create a new project
        api_response = api_instance.add_project(body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->add_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	RequestProject

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

Content-Type: application/json
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_project

ProjectDataWrapper get_project(project_id)

Get the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.project_data_wrapper import ProjectDataWrapper
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 = projects_api.ProjectsApi(api_client)
    project_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 project with the specified ID
        api_response = api_instance.get_project(project_id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->get_project: %s\n" % e)

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

Parameters

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

Return type

ProjectDataWrapper

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_project_item_types

ItemTypeDataListWrapper get_project_item_types(project_id)

Get all item types for the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.item_type_data_list_wrapper import ItemTypeDataListWrapper
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 = projects_api.ProjectsApi(api_client)
    project_id = 1 # int | 
    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 item types for the project with the specified ID
        api_response = api_instance.get_project_item_types(project_id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->get_project_item_types: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
project_id	int
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

ItemTypeDataListWrapper

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_project_tags

TagDataListWrapper get_project_tags(project_id)

Get all tags for the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.tag_data_list_wrapper import TagDataListWrapper
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 = projects_api.ProjectsApi(api_client)
    project_id = 1 # int | 
    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 tags for the project with the specified ID
        api_response = api_instance.get_project_tags(project_id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->get_project_tags: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
project_id	int
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

TagDataListWrapper

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_projects

ProjectDataListWrapper get_projects()

Get all projects

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.project_data_list_wrapper import ProjectDataListWrapper
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 = projects_api.ProjectsApi(api_client)
    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 projects
        api_response = api_instance.get_projects(start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->get_projects: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

ProjectDataListWrapper

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]

post_attachment

CreatedResponse post_attachment(project_id, body)

Create a new attachment in the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_attachment import RequestAttachment
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 = projects_api.ProjectsApi(api_client)
    project_id = 1 # int | 
    body = RequestAttachment(
        fields={
            "key": {},
        },
    ) # RequestAttachment | 

    # example passing only required values which don't have defaults set
    try:
        # Create a new attachment in the project with the specified ID
        api_response = api_instance.post_attachment(project_id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->post_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int
body	RequestAttachment

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

Content-Type: application/json
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]

put_project

AbstractRestResponse put_project(project_id, body)

Update the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import projects_api
from pyjama.model.request_project import RequestProject
from pyjama.model.abstract_rest_response import AbstractRestResponse
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 = projects_api.ProjectsApi(api_client)
    project_id = 1 # int | 
    body = RequestProject(
        project_key="project_key_example",
        is_folder=True,
        parent=1,
        fields={
            "key": {},
        },
    ) # RequestProject | 

    # example passing only required values which don't have defaults set
    try:
        # Update the project with the specified ID
        api_response = api_instance.put_project(project_id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ProjectsApi->put_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int
body	RequestProject

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

Content-Type: application/json
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]

Files

ProjectsApi.md

Latest commit

History

ProjectsApi.md

File metadata and controls

pyjama.ProjectsApi

add_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_project_item_types

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_project_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_projects

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details