ItemsApi.md

ItemsApi

Method	HTTP request	Description
addAttachmentToItem	POST /items/{id}/attachments	Add an existing attachment to the item with the specified ID
addItem	POST /items	Create a new item
addItemLink	POST /items/{id}/links	Create a new link for the item with the specified ID
addTagToItem	POST /items/{id}/tags	Add an existing tag to the item with the specified ID
breakSyncOnItem	DELETE /items/{id}/synceditems/{syncedItemId}	Remove an existing item from the Global ID pool of the item with the specified ID (break sync)
connectItemToGlobalIDPool	POST /items/{id}/synceditems	Add an existing item to the Global ID pool of the item with the specified ID
deleteItem	DELETE /items/{id}	Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)
deleteItemLink	DELETE /items/{id}/links/{linkId}	Delete the link with the specified ID
duplicateItem	POST /items/{id}/duplicate	Create a duplicate of item
executeTransition	POST /items/{id}/workflowtransitions	Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions
getActivities	GET /items/{id}/activities	Get all activities for the item with the specified ID
getAttachments	GET /items/{id}/attachments	Get all attachments for the item with the specified ID
getChildItems	GET /items/{id}/children	Get all children items for the item with the specified ID
getDownstreamRelated	GET /items/{id}/downstreamrelated	Get all downstream related items for the item with the specified ID
getDownstreamRelationships	GET /items/{id}/downstreamrelationships	Get all downstream relationships for the item with the specified ID
getItem	GET /items/{id}	Get the item with the specified ID
getItemComments	GET /items/{id}/comments	Get all comments for the item with the specified ID
getItemLinks	GET /items/{id}/links	Get all links for the item with the specified ID
getItems	GET /items	Get all items in the project with the specified ID
getLinkById	GET /items/{id}/links/{linkId}	Get the link with the specified ID
getLocation	GET /items/{id}/location	Get the location for the item with the specified ID
getLock	GET /items/{id}/lock	Get the locked state, last locked date, and last locked by user for the item with the specified ID
getParentItem	GET /items/{id}/parent	Get the parent item for the item with the specified ID
getSyncItems	GET /items/{id}/synceditems	Get all synchronized items for the item with the specified ID
getSyncStatus	GET /items/{id}/synceditems/{syncedItemId}/syncstatus	Get the sync status for the synced item with the specified ID
getTagOnItem	GET /items/{id}/tags/{tagId}	Get the tag with the specified ID
getTagsOnItem	GET /items/{id}/tags	Get all tags for the item with the specified ID
getUpstreamRelated	GET /items/{id}/upstreamrelated	Get all upstream related items for the item with the specified ID
getUpstreamRelationships	GET /items/{id}/upstreamrelationships	Get all upstream relationships for the item with the specified ID
getVersionOnItem2	GET /items/{id}/versions/{versionNum}	Get the numbered version for the item with the specified ID
getVersionedItem2	GET /items/{id}/versions/{versionNum}/versioneditem	Get the snapshot of the item at the specified version
getVersionsOnItem2	GET /items/{id}/versions	Get all versions for the item with the specified ID
getWorkflowTransitionOptions	GET /items/{id}/workflowtransitionoptions	Get all valid workflow transitions that can be made on the item with the specified ID
patchItem	PATCH /items/{id}	Update the item with the specified ID
putItem	PUT /items/{id}	Update the item with the specified ID
removeAttachmentFromItem	DELETE /items/{id}/attachments/{attachmentId}	Remove an existing attachment from the item
removeTagFromItem	DELETE /items/{id}/tags/{tagId}	Remove an existing tag from the item with the specified ID
updateItemLink	PUT /items/{id}/links/{linkId}	Update the link with the specified ID
updateLocation	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
updateLock	PUT /items/{id}/lock	Update the locked state of the item with the specified ID

addAttachmentToItem

CreatedResponse addAttachmentToItem(body, id)

Add an existing attachment to the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestItemAttachment body = new RequestItemAttachment(); // RequestItemAttachment | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addAttachmentToItem(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#addAttachmentToItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestItemAttachment
id	Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

addItem

CreatedResponse addItem(body, setGlobalIdManually)

Create a new item

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestItem body = new RequestItem(); // RequestItem | 
Boolean setGlobalIdManually = true; // Boolean | This value must be set to true if you attempt to manually set the Global ID field of an item
try {
    CreatedResponse result = apiInstance.addItem(body, setGlobalIdManually);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#addItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestItem
setGlobalIdManually	Boolean	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

addItemLink

CreatedResponse addItemLink(body, id)

Create a new link for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestLink body = new RequestLink(); // RequestLink | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addItemLink(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#addItemLink");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestLink
id	Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

addTagToItem

CreatedResponse addTagToItem(body, id)

Add an existing tag to the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestItemTag body = new RequestItemTag(); // RequestItemTag | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addTagToItem(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#addTagToItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestItemTag
id	Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

breakSyncOnItem

AbstractRestResponse breakSyncOnItem(syncedItemId, id)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer syncedItemId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.breakSyncOnItem(syncedItemId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#breakSyncOnItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
syncedItemId	Integer
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

connectItemToGlobalIDPool

CreatedResponse connectItemToGlobalIDPool(body, id)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestItemSyncedItem body = new RequestItemSyncedItem(); // RequestItemSyncedItem | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.connectItemToGlobalIDPool(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#connectItemToGlobalIDPool");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestItemSyncedItem
id	Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteItem

AbstractRestResponse deleteItem(id)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteItem(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#deleteItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteItemLink

AbstractRestResponse deleteItemLink(linkId, id)

Delete the link with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer linkId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteItemLink(linkId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#deleteItemLink");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
linkId	Integer
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

duplicateItem

CreatedResponse duplicateItem(id, body)

Create a duplicate of item

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
DuplicateConfig body = new DuplicateConfig(); // DuplicateConfig | 
try {
    CreatedResponse result = apiInstance.duplicateItem(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#duplicateItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
body	DuplicateConfig		[optional]

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

executeTransition

CreatedResponse executeTransition(body, id)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestTransition body = new RequestTransition(); // RequestTransition | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.executeTransition(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#executeTransition");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestTransition
id	Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

getActivities

ActivityDataListWrapper getActivities(id, startAt, maxResults, include)

Get all activities for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ActivityDataListWrapper result = apiInstance.getActivities(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getActivities");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ActivityDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getAttachments

AttachmentDataListWrapper getAttachments(id, startAt, maxResults, include)

Get all attachments for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    AttachmentDataListWrapper result = apiInstance.getAttachments(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getAttachments");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

AttachmentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getChildItems

ItemDataListWrapper getChildItems(id, startAt, maxResults, include)

Get all children items for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataListWrapper result = apiInstance.getChildItems(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getChildItems");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getDownstreamRelated

ItemDataListWrapper getDownstreamRelated(id, startAt, maxResults, include)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataListWrapper result = apiInstance.getDownstreamRelated(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getDownstreamRelated");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getDownstreamRelationships

RelationshipDataListWrapper getDownstreamRelationships(id, startAt, maxResults, include)

Get all downstream relationships for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    RelationshipDataListWrapper result = apiInstance.getDownstreamRelationships(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getDownstreamRelationships");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItem

ItemDataWrapper getItem(id, include)

Get the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataWrapper result = apiInstance.getItem(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItemComments

CommentDataListWrapper getItemComments(id, startAt, maxResults, rootCommentsOnly, include)

Get all comments for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
Boolean rootCommentsOnly = false; // Boolean | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    CommentDataListWrapper result = apiInstance.getItemComments(id, startAt, maxResults, rootCommentsOnly, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getItemComments");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
rootCommentsOnly	Boolean		[optional] [default to false]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

CommentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItemLinks

LinkDataListWrapper getItemLinks(id, startAt, maxResults, include)

Get all links for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    LinkDataListWrapper result = apiInstance.getItemLinks(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getItemLinks");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

LinkDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItems

ItemDataListWrapper getItems(project, rootOnly, startAt, maxResults, include)

Get all items in the project with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer project = 56; // Integer | 
Boolean rootOnly = true; // Boolean | Set this to true to only get root-level nodes from the item tree
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataListWrapper result = apiInstance.getItems(project, rootOnly, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getItems");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
project	Integer
rootOnly	Boolean	Set this to true to only get root-level nodes from the item tree	[optional]
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getLinkById

LinkDataWrapper getLinkById(linkId, id, include)

Get the link with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer linkId = 56; // Integer | 
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    LinkDataWrapper result = apiInstance.getLinkById(linkId, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getLinkById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
linkId	Integer
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

LinkDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getLocation

LocationDataWrapper getLocation(id, include)

Get the location for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    LocationDataWrapper result = apiInstance.getLocation(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getLocation");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

LocationDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getLock

LockDataWrapper getLock(id, include)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    LockDataWrapper result = apiInstance.getLock(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getLock");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

LockDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getParentItem

ItemDataWrapper getParentItem(id, include)

Get the parent item for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataWrapper result = apiInstance.getParentItem(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getParentItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getSyncItems

ItemDataListWrapper getSyncItems(id, startAt, maxResults, include)

Get all synchronized items for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataListWrapper result = apiInstance.getSyncItems(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getSyncItems");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getSyncStatus

SyncStatusDataWrapper getSyncStatus(syncedItemId, id, include)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer syncedItemId = 56; // Integer | 
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    SyncStatusDataWrapper result = apiInstance.getSyncStatus(syncedItemId, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getSyncStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
syncedItemId	Integer
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

SyncStatusDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTagOnItem

TagDataWrapper getTagOnItem(tagId, id, include)

Get the tag with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer tagId = 56; // Integer | 
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    TagDataWrapper result = apiInstance.getTagOnItem(tagId, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getTagOnItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
tagId	Integer
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

TagDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTagsOnItem

TagDataListWrapper getTagsOnItem(id, startAt, maxResults, include)

Get all tags for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    TagDataListWrapper result = apiInstance.getTagsOnItem(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getTagsOnItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

TagDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getUpstreamRelated

ItemDataListWrapper getUpstreamRelated(id, startAt, maxResults, include)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemDataListWrapper result = apiInstance.getUpstreamRelated(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getUpstreamRelated");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getUpstreamRelationships

RelationshipDataListWrapper getUpstreamRelationships(id, startAt, maxResults, include)

Get all upstream relationships for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    RelationshipDataListWrapper result = apiInstance.getUpstreamRelationships(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getUpstreamRelationships");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionOnItem2

VersionDataWrapper getVersionOnItem2(versionNum, id, include)

Get the numbered version for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer versionNum = 56; // Integer | 
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionDataWrapper result = apiInstance.getVersionOnItem2(versionNum, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getVersionOnItem2");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
versionNum	Integer
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

VersionDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionedItem2

VersionedItemDataWrapper getVersionedItem2(versionNum, id, include)

Get the snapshot of the item at the specified version

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer versionNum = 56; // Integer | 
Integer id = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionedItemDataWrapper result = apiInstance.getVersionedItem2(versionNum, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getVersionedItem2");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
versionNum	Integer
id	Integer
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

VersionedItemDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionsOnItem2

VersionDataListWrapper getVersionsOnItem2(id, startAt, maxResults, include)

Get all versions for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionDataListWrapper result = apiInstance.getVersionsOnItem2(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getVersionsOnItem2");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

VersionDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getWorkflowTransitionOptions

WorkflowTransitionDataListWrapper getWorkflowTransitionOptions(id, startAt, maxResults, include)

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

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer id = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    WorkflowTransitionDataListWrapper result = apiInstance.getWorkflowTransitionOptions(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#getWorkflowTransitionOptions");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer
startAt	Integer		[optional]
maxResults	Integer	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	List<String>	Links to include as full objects in the linked map	[optional]

Return type

WorkflowTransitionDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

patchItem

AbstractRestResponse patchItem(body, id)

Update the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
List<RequestPatchOperation> body = Arrays.asList(new RequestPatchOperation()); // List<RequestPatchOperation> | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.patchItem(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#patchItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	List<RequestPatchOperation>
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

putItem

AbstractRestResponse putItem(body, id, setGlobalIdManually)

Update the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestItem body = new RequestItem(); // RequestItem | 
Integer id = 56; // Integer | 
Boolean setGlobalIdManually = true; // Boolean | This value must be set to true if you attempt to manually set the Global ID field of an item
try {
    AbstractRestResponse result = apiInstance.putItem(body, id, setGlobalIdManually);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#putItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestItem
id	Integer
setGlobalIdManually	Boolean	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

removeAttachmentFromItem

AbstractRestResponse removeAttachmentFromItem(attachmentId, id)

Remove an existing attachment from the item

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer attachmentId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.removeAttachmentFromItem(attachmentId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#removeAttachmentFromItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
attachmentId	Integer
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

removeTagFromItem

AbstractRestResponse removeTagFromItem(tagId, id)

Remove an existing tag from the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer tagId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.removeTagFromItem(tagId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#removeTagFromItem");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
tagId	Integer
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateItemLink

AbstractRestResponse updateItemLink(linkId, body, id)

Update the link with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
Integer linkId = 56; // Integer | 
RequestLink body = new RequestLink(); // RequestLink | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateItemLink(linkId, body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#updateItemLink");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
linkId	Integer
body	RequestLink
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateLocation

AbstractRestResponse updateLocation(body, id)

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

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestMoveLocation body = new RequestMoveLocation(); // RequestMoveLocation | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateLocation(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#updateLocation");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestMoveLocation
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateLock

AbstractRestResponse updateLock(body, id)

Update the locked state of the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemsApi apiInstance = new ItemsApi();
RequestLock body = new RequestLock(); // RequestLock | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateLock(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemsApi#updateLock");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RequestLock
id	Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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