ItemsApi.md

pyjama.ItemsApi

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

Method	HTTP request	Description
add_item	POST /items	Create a new item
add_item_attachment	POST /items/{id}/attachments	Add an existing attachment to the item with the specified ID
add_item_link	POST /items/{id}/links	Create a new link for the item with the specified ID
add_item_tag	POST /items/{id}/tags	Add an existing tag to the item with the specified ID
break_sync_on_item	DELETE /items/{id}/synceditems/{syncedItemId}	Remove an existing item from the Global ID pool of the item with the specified ID (break sync)
connect_item_to_global_id_pool	POST /items/{id}/synceditems	Add an existing item to the Global ID pool of the item with the specified ID
delete_item	DELETE /items/{id}	Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)
delete_item_link	DELETE /items/{id}/links/{linkId}	Delete the link with the specified ID
duplicate_item	POST /items/{id}/duplicate	Create a duplicate of item
execute_transition	POST /items/{id}/workflowtransitions	Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions
get_item	GET /items/{id}	Get the item with the specified ID
get_item_activities	GET /items/{id}/activities	Get all activities for the item with the specified ID
get_item_attachments	GET /items/{id}/attachments	Get all attachments for the item with the specified ID
get_item_children	GET /items/{id}/children	Get all children items for the item with the specified ID
get_item_comments	GET /items/{id}/comments	Get all comments for the item with the specified ID
get_item_downstream_related	GET /items/{id}/downstreamrelated	Get all downstream related items for the item with the specified ID
get_item_downstream_relationships	GET /items/{id}/downstreamrelationships	Get all downstream relationships for the item with the specified ID
get_item_link	GET /items/{id}/links/{linkId}	Get the link with the specified ID
get_item_links	GET /items/{id}/links	Get all links for the item with the specified ID
get_item_location	GET /items/{id}/location	Get the location for the item with the specified ID
get_item_lock	GET /items/{id}/lock	Get the locked state, last locked date, and last locked by user for the item with the specified ID
get_item_parent	GET /items/{id}/parent	Get the parent item for the item with the specified ID
get_item_synced	GET /items/{id}/synceditems	Get all synchronized items for the item with the specified ID
get_item_synced_status	GET /items/{id}/synceditems/{syncedItemId}/syncstatus	Get the sync status for the synced item with the specified ID
get_item_tag	GET /items/{id}/tags/{tagId}	Get the tag with the specified ID
get_item_tags	GET /items/{id}/tags	Get all tags for the item with the specified ID
get_item_upstream_related	GET /items/{id}/upstreamrelated	Get all upstream related items for the item with the specified ID
get_item_upstream_relationships	GET /items/{id}/upstreamrelationships	Get all upstream relationships for the item with the specified ID
get_item_version	GET /items/{id}/versions/{versionNum}/versioneditem	Get the snapshot of the item at the specified version
get_item_versioned	GET /items/{id}/versions/{versionNum}	Get the numbered version for the item with the specified ID
get_item_versions	GET /items/{id}/versions	Get all versions for the item with the specified ID
get_item_workflow_transition_options	GET /items/{id}/workflowtransitionoptions	Get all valid workflow transitions that can be made on the item with the specified ID
get_items	GET /items	Get all items in the project with the specified ID
patch_item	PATCH /items/{id}	Update the item with the specified ID
put_item	PUT /items/{id}	Update the item with the specified ID
remove_attachment_from_item	DELETE /items/{id}/attachments/{attachmentId}	Remove an existing attachment from the item
remove_tag_from_item	DELETE /items/{id}/tags/{tagId}	Remove an existing tag from the item with the specified ID
update_item_link	PUT /items/{id}/links/{linkId}	Update the link with the specified ID
update_item_location	PUT /items/{id}/location	Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects
update_item_lock	PUT /items/{id}/lock	Update the locked state of the item with the specified ID

add_item

CreatedResponse add_item(body)

Create a new item

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_item import RequestItem
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 = items_api.ItemsApi(api_client)
    body = RequestItem(
        global_id="global_id_example",
        project=1,
        item_type=1,
        child_item_type=1,
        location=RequestLocation(
            parent=RequestParent(
                item=1,
                project=1,
            ),
        ),
        fields={
            "key": {},
        },
    ) # RequestItem | 
    set_global_id_manually = True # bool | This value must be set to true if you attempt to manually set the Global ID field of an item (optional)

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

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

Parameters

Name	Type	Description	Notes
body	RequestItem
set_global_id_manually	bool	This value must be set to true if you attempt to manually set the Global ID field of an item	[optional]

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]

add_item_attachment

CreatedResponse add_item_attachment(id, body)

Add an existing attachment to the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_item_attachment import RequestItemAttachment
from pyjama.model.created_response import CreatedResponse
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestItemAttachment(
        attachment=1,
    ) # RequestItemAttachment | 

    # example passing only required values which don't have defaults set
    try:
        # Add an existing attachment to the item with the specified ID
        api_response = api_instance.add_item_attachment(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->add_item_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestItemAttachment

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]

add_item_link

CreatedResponse add_item_link(id, body)

Create a new link for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_link import RequestLink
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestLink(
        url="url_example",
        description="description_example",
    ) # RequestLink | 

    # example passing only required values which don't have defaults set
    try:
        # Create a new link for the item with the specified ID
        api_response = api_instance.add_item_link(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->add_item_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestLink

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]

add_item_tag

CreatedResponse add_item_tag(id, body)

Add an existing tag to the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_item_tag import RequestItemTag
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestItemTag(
        tag=1,
    ) # RequestItemTag | 

    # example passing only required values which don't have defaults set
    try:
        # Add an existing tag to the item with the specified ID
        api_response = api_instance.add_item_tag(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->add_item_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestItemTag

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]

break_sync_on_item

AbstractRestResponse break_sync_on_item(synced_item_id, id)

Remove an existing item from the Global ID pool of the item with the specified ID (break sync)

Example

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

import time
import pyjama
from pyjama.api import items_api
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 = items_api.ItemsApi(api_client)
    synced_item_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Remove an existing item from the Global ID pool of the item with the specified ID (break sync)
        api_response = api_instance.break_sync_on_item(synced_item_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->break_sync_on_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
synced_item_id	int
id	int

Return type

AbstractRestResponse

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]

connect_item_to_global_id_pool

CreatedResponse connect_item_to_global_id_pool(id, body)

Add an existing item to the Global ID pool of the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_item_synced_item import RequestItemSyncedItem
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestItemSyncedItem(
        item=1,
    ) # RequestItemSyncedItem | 

    # example passing only required values which don't have defaults set
    try:
        # Add an existing item to the Global ID pool of the item with the specified ID
        api_response = api_instance.connect_item_to_global_id_pool(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->connect_item_to_global_id_pool: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestItemSyncedItem

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]

delete_item

AbstractRestResponse delete_item(id)

Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)

Example

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

import time
import pyjama
from pyjama.api import items_api
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)
        api_response = api_instance.delete_item(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->delete_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

AbstractRestResponse

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]

delete_item_link

AbstractRestResponse delete_item_link(link_id, id)

Delete the link with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
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 = items_api.ItemsApi(api_client)
    link_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the link with the specified ID
        api_response = api_instance.delete_item_link(link_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->delete_item_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_id	int
id	int

Return type

AbstractRestResponse

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]

duplicate_item

CreatedResponse duplicate_item(id)

Create a duplicate of item

Copies the name and description fields. Only items without children can be have a duplicate created.

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.duplicate_config import DuplicateConfig
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = DuplicateConfig(
        include_tags=True,
        include_attachments=True,
        include_links=True,
    ) # DuplicateConfig |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create a duplicate of item
        api_response = api_instance.duplicate_item(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->duplicate_item: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a duplicate of item
        api_response = api_instance.duplicate_item(id, body=body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->duplicate_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	DuplicateConfig		[optional]

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]

execute_transition

CreatedResponse execute_transition(id, body)

Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_transition import RequestTransition
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestTransition(
        transition_id="transition_id_example",
        comment="comment_example",
    ) # RequestTransition | 

    # example passing only required values which don't have defaults set
    try:
        # Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions
        api_response = api_instance.execute_transition(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->execute_transition: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestTransition

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_item

ItemDataWrapper get_item(id)

Get the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.item_data_wrapper import ItemDataWrapper
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 = items_api.ItemsApi(api_client)
    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 item with the specified ID
        api_response = api_instance.get_item(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item: %s\n" % e)

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

Parameters

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

Return type

ItemDataWrapper

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_item_activities

ActivityDataListWrapper get_item_activities(id)

Get all activities for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.activity_data_list_wrapper import ActivityDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 activities for the item with the specified ID
        api_response = api_instance.get_item_activities(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_activities: %s\n" % e)

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

Parameters

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

ActivityDataListWrapper

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_item_attachments

AttachmentDataListWrapper get_item_attachments(id)

Get all attachments for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.attachment_data_list_wrapper import AttachmentDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 attachments for the item with the specified ID
        api_response = api_instance.get_item_attachments(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_attachments: %s\n" % e)

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

Parameters

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

AttachmentDataListWrapper

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_item_children

ItemDataListWrapper get_item_children(id)

Get all children items for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    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 children items for the item with the specified ID
        api_response = api_instance.get_item_children(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_children: %s\n" % e)

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

Parameters

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

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_item_comments

CommentDataListWrapper get_item_comments(id)

Get all comments for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.comment_data_list_wrapper import CommentDataListWrapper
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 = items_api.ItemsApi(api_client)
    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)
    root_comments_only = False # bool |  (optional) if omitted the server will use the default value of False
    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 comments for the item with the specified ID
        api_response = api_instance.get_item_comments(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_comments: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
root_comments_only	bool		[optional] if omitted the server will use the default value of False
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

CommentDataListWrapper

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_item_downstream_related

ItemDataListWrapper get_item_downstream_related(id)

Get all downstream related items for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    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 downstream related items for the item with the specified ID
        api_response = api_instance.get_item_downstream_related(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_downstream_related: %s\n" % e)

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

Parameters

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

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_item_downstream_relationships

RelationshipDataListWrapper get_item_downstream_relationships(id)

Get all downstream relationships for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.relationship_data_list_wrapper import RelationshipDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 downstream relationships for the item with the specified ID
        api_response = api_instance.get_item_downstream_relationships(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_downstream_relationships: %s\n" % e)

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

Parameters

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

RelationshipDataListWrapper

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_item_link

LinkDataWrapper get_item_link(link_id, id)

Get the link with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.link_data_wrapper import LinkDataWrapper
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 = items_api.ItemsApi(api_client)
    link_id = 1 # int | 
    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 link with the specified ID
        api_response = api_instance.get_item_link(link_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_link: %s\n" % e)

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

Parameters

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

Return type

LinkDataWrapper

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_item_links

LinkDataListWrapper get_item_links(id)

Get all links for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.link_data_list_wrapper import LinkDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 links for the item with the specified ID
        api_response = api_instance.get_item_links(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_links: %s\n" % e)

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

Parameters

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

LinkDataListWrapper

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_item_location

LocationDataWrapper get_item_location(id)

Get the location for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.location_data_wrapper import LocationDataWrapper
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 = items_api.ItemsApi(api_client)
    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 location for the item with the specified ID
        api_response = api_instance.get_item_location(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_location: %s\n" % e)

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

Parameters

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

Return type

LocationDataWrapper

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_item_lock

LockDataWrapper get_item_lock(id)

Get the locked state, last locked date, and last locked by user for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.lock_data_wrapper import LockDataWrapper
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 = items_api.ItemsApi(api_client)
    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 locked state, last locked date, and last locked by user for the item with the specified ID
        api_response = api_instance.get_item_lock(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_lock: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the locked state, last locked date, and last locked by user for the item with the specified ID
        api_response = api_instance.get_item_lock(id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_lock: %s\n" % e)

Parameters

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

Return type

LockDataWrapper

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_item_parent

ItemDataWrapper get_item_parent(id)

Get the parent item for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.item_data_wrapper import ItemDataWrapper
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 = items_api.ItemsApi(api_client)
    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 parent item for the item with the specified ID
        api_response = api_instance.get_item_parent(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_parent: %s\n" % e)

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

Parameters

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

Return type

ItemDataWrapper

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_item_synced

ItemDataListWrapper get_item_synced(id)

Get all synchronized items for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    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 synchronized items for the item with the specified ID
        api_response = api_instance.get_item_synced(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_synced: %s\n" % e)

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

Parameters

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

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_item_synced_status

SyncStatusDataWrapper get_item_synced_status(synced_item_id, id)

Get the sync status for the synced item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.sync_status_data_wrapper import SyncStatusDataWrapper
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 = items_api.ItemsApi(api_client)
    synced_item_id = 1 # int | 
    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 sync status for the synced item with the specified ID
        api_response = api_instance.get_item_synced_status(synced_item_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_synced_status: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the sync status for the synced item with the specified ID
        api_response = api_instance.get_item_synced_status(synced_item_id, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_synced_status: %s\n" % e)

Parameters

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

Return type

SyncStatusDataWrapper

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_item_tag

TagDataWrapper get_item_tag(tag_id, id)

Get the tag with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.tag_data_wrapper import TagDataWrapper
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 = items_api.ItemsApi(api_client)
    tag_id = 1 # int | 
    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 tag with the specified ID
        api_response = api_instance.get_item_tag(tag_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_tag: %s\n" % e)

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

Parameters

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

Return type

TagDataWrapper

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_item_tags

TagDataListWrapper get_item_tags(id)

Get all tags for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    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 item with the specified ID
        api_response = api_instance.get_item_tags(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_tags: %s\n" % e)

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

Parameters

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

ItemDataListWrapper get_item_upstream_related(id)

Get all upstream related items for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    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 upstream related items for the item with the specified ID
        api_response = api_instance.get_item_upstream_related(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_upstream_related: %s\n" % e)

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

Parameters

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

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_item_upstream_relationships

RelationshipDataListWrapper get_item_upstream_relationships(id)

Get all upstream relationships for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.relationship_data_list_wrapper import RelationshipDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 upstream relationships for the item with the specified ID
        api_response = api_instance.get_item_upstream_relationships(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_upstream_relationships: %s\n" % e)

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

Parameters

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

RelationshipDataListWrapper

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_item_version

VersionedItemDataWrapper get_item_version(version_num, id)

Get the snapshot of the item at the specified version

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.versioned_item_data_wrapper import VersionedItemDataWrapper
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 = items_api.ItemsApi(api_client)
    version_num = 1 # int | 
    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 snapshot of the item at the specified version
        api_response = api_instance.get_item_version(version_num, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_version: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the snapshot of the item at the specified version
        api_response = api_instance.get_item_version(version_num, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_version: %s\n" % e)

Parameters

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

Return type

VersionedItemDataWrapper

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_item_versioned

VersionDataWrapper get_item_versioned(version_num, id)

Get the numbered version for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.version_data_wrapper import VersionDataWrapper
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 = items_api.ItemsApi(api_client)
    version_num = 1 # int | 
    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 numbered version for the item with the specified ID
        api_response = api_instance.get_item_versioned(version_num, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_versioned: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the numbered version for the item with the specified ID
        api_response = api_instance.get_item_versioned(version_num, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_versioned: %s\n" % e)

Parameters

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

Return type

VersionDataWrapper

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_item_versions

VersionDataListWrapper get_item_versions(id)

Get all versions for the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.version_data_list_wrapper import VersionDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 versions for the item with the specified ID
        api_response = api_instance.get_item_versions(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_versions: %s\n" % e)

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

Parameters

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

VersionDataListWrapper

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_item_workflow_transition_options

WorkflowTransitionDataListWrapper get_item_workflow_transition_options(id)

Get all valid workflow transitions that can be made on the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.workflow_transition_data_list_wrapper import WorkflowTransitionDataListWrapper
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 = items_api.ItemsApi(api_client)
    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 valid workflow transitions that can be made on the item with the specified ID
        api_response = api_instance.get_item_workflow_transition_options(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_workflow_transition_options: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all valid workflow transitions that can be made on the item with the specified ID
        api_response = api_instance.get_item_workflow_transition_options(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_item_workflow_transition_options: %s\n" % e)

Parameters

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

WorkflowTransitionDataListWrapper

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_items

ItemDataListWrapper get_items(project)

Get all items in the project with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_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 = items_api.ItemsApi(api_client)
    project = 1 # int | 
    root_only = True # bool | Set this to true to only get root-level nodes from the item tree (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 items in the project with the specified ID
        api_response = api_instance.get_items(project)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->get_items: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
project	int
root_only	bool	Set this to true to only get root-level nodes from the item tree	[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]

patch_item

AbstractRestResponse patch_item(id, body)

Update the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_patch_operation import RequestPatchOperation
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = [
        RequestPatchOperation(
            op="remove",
            path="path_example",
            value={},
        ),
    ] # [RequestPatchOperation] | 

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

Parameters

Name	Type	Description	Notes
id	int
body	[RequestPatchOperation]

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]

put_item

AbstractRestResponse put_item(id, body)

Update the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_item import RequestItem
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestItem(
        global_id="global_id_example",
        project=1,
        item_type=1,
        child_item_type=1,
        location=RequestLocation(
            parent=RequestParent(
                item=1,
                project=1,
            ),
        ),
        fields={
            "key": {},
        },
    ) # RequestItem | 
    set_global_id_manually = True # bool | This value must be set to true if you attempt to manually set the Global ID field of an item (optional)

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

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

Parameters

Name	Type	Description	Notes
id	int
body	RequestItem
set_global_id_manually	bool	This value must be set to true if you attempt to manually set the Global ID field of an item	[optional]

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]

remove_attachment_from_item

AbstractRestResponse remove_attachment_from_item(attachment_id, id)

Remove an existing attachment from the item

Example

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

import time
import pyjama
from pyjama.api import items_api
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 = items_api.ItemsApi(api_client)
    attachment_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Remove an existing attachment from the item
        api_response = api_instance.remove_attachment_from_item(attachment_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->remove_attachment_from_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
attachment_id	int
id	int

Return type

AbstractRestResponse

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]

remove_tag_from_item

AbstractRestResponse remove_tag_from_item(tag_id, id)

Remove an existing tag from the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
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 = items_api.ItemsApi(api_client)
    tag_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Remove an existing tag from the item with the specified ID
        api_response = api_instance.remove_tag_from_item(tag_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->remove_tag_from_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	int
id	int

Return type

AbstractRestResponse

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]

update_item_link

AbstractRestResponse update_item_link(link_id, id, body)

Update the link with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_link import RequestLink
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 = items_api.ItemsApi(api_client)
    link_id = 1 # int | 
    id = 1 # int | 
    body = RequestLink(
        url="url_example",
        description="description_example",
    ) # RequestLink | 

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

Parameters

Name	Type	Description	Notes
link_id	int
id	int
body	RequestLink

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]

update_item_location

AbstractRestResponse update_item_location(id, body)

Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_move_location import RequestMoveLocation
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestMoveLocation(
        parent=RequestMoveParent(
            project=1,
        ),
    ) # RequestMoveLocation | 

    # example passing only required values which don't have defaults set
    try:
        # Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects
        api_response = api_instance.update_item_location(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling ItemsApi->update_item_location: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestMoveLocation

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]

update_item_lock

AbstractRestResponse update_item_lock(id, body)

Update the locked state of the item with the specified ID

Example

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

import time
import pyjama
from pyjama.api import items_api
from pyjama.model.request_lock import RequestLock
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 = items_api.ItemsApi(api_client)
    id = 1 # int | 
    body = RequestLock(
        locked=True,
    ) # RequestLock | 

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

Parameters

Name	Type	Description	Notes
id	int
body	RequestLock

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]