No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the Swagger Codegen project:
- API version: 3.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://codebeamer.com
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import swagger_client Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import swagger_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
body = swagger_client.Association() # Association |
try:
# Create a new association
api_response = api_instance.create_association(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->create_association: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
association_id = 56 # int |
try:
# Delete association
api_instance.delete_association(association_id)
except ApiException as e:
print("Exception when calling AssociationApi->delete_association: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
association_id = 56 # int |
try:
# Get an association by id
api_response = api_instance.get_association(association_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->get_association: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
association_id = 56 # int |
page = 1 # int | Index of the result page starting from 1. (optional) (default to 1)
page_size = 25 # int | Number of items in a result page. Max value: 500 (optional) (default to 25)
try:
# Returns the change history of the specified association
api_response = api_instance.get_association_history(association_id, page=page, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->get_association_history: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
association_type_id = 56 # int |
try:
# Get association type by id
api_response = api_instance.get_association_type(association_type_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->get_association_type: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
try:
# Get available association types
api_response = api_instance.get_available_association_types()
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->get_available_association_types: %s\n" % e)
# Configure API key authorization: ApiKeyAuth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'# Configure HTTP basic authorization: BasicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AssociationApi(swagger_client.ApiClient(configuration))
body = swagger_client.Association() # Association |
association_id = 56 # int |
try:
# Update association settings
api_response = api_instance.update_association(body, association_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssociationApi->update_association: %s\n" % e)All URIs are relative to https://alm.codebeamer.com/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AssociationApi | create_association | POST /v3/associations | Create a new association |
| AssociationApi | delete_association | DELETE /v3/associations/{associationId} | Delete association |
| AssociationApi | get_association | GET /v3/associations/{associationId} | Get an association by id |
| AssociationApi | get_association_history | GET /v3/associations/{associationId}/history | Returns the change history of the specified association |
| AssociationApi | get_association_type | GET /v3/associations/types/{associationTypeId} | Get association type by id |
| AssociationApi | get_available_association_types | GET /v3/associations/types | Get available association types |
| AssociationApi | update_association | PUT /v3/associations/{associationId} | Update association settings |
| AttachmentApi | delete_attachment | DELETE /v3/attachments/{attachmentId} | Deletes an attachment |
| AttachmentApi | get_attachment | GET /v3/attachments/{attachmentId} | Get attachment by id |
| AttachmentApi | get_attachment_content | GET /v3/attachments/{attachmentId}/content | Get content of an attachment by id |
| AttachmentApi | get_attachment_history | GET /v3/attachments/{attachmentId}/history | Returns the change history of the specified attachment |
| AttachmentApi | restore_attachment | PUT /v3/attachments/{attachmentId}/restore | Restore attachment to previous version |
| AttachmentApi | update_attachment | PUT /v3/attachments/{attachmentId}/content | Update attachment |
| BackgroundJobApi | get_background_job | GET /v3/job/{jobId} | Retrieve background job information |
| BackgroundJobApi | update_working_set | POST /v3/jobs/working-set-update | Create background job to update working-set |
| BaselineApi | create_baseline | POST /v3/baselines | Create a project or tracker baseline |
| BranchesApi | get_tracker_item_on_branch | GET /v3/branches/{branchId}/item | Get tracker item on branch |
| DeploymentApi | export_for_deployment | POST /v3/deployment/export | Export projects for deployment |
| DeploymentApi | upload_deployment | POST /v3/deployment | Start a deployment process |
| ExportApi | batch_get_tracker_item_reviews | POST /v3/export/tracker-item-reviews | Get tracker item reviews by a list of tracker item IDs |
| ExportApi | export | POST /v3/projects/{projectId}/content | Exports the specified project to a zip file |
| ExportApi | export_to_word | POST /v3/export/exportToWord | Exports items to Word |
| ExportApi | get_tracker_items | POST /v3/export/items | Get tracker items |
| GroupApi | get_group | GET /v3/users/groups/{groupId} | Get user group |
| GroupApi | get_group_members | GET /v3/users/groups/{groupId}/members | Get all members of a user group |
| GroupApi | get_groups | GET /v3/users/groups | Get user groups |
| MigrationApi | migrate_attachments | POST /v3/migration/attachment | Migrate attachments |
| ProjectApi | create_tracker | POST /v3/projects/{projectId}/trackers | Create a tracker |
| ProjectApi | deploy_configuration | POST /v3/projects/deploy | Deploy a project configuration to a Project |
| ProjectApi | get_members_of_project | GET /v3/projects/{projectId}/members | Get all members of a project |
| ProjectApi | get_project_by_id | GET /v3/projects/{projectId} | Get project |
| ProjectApi | get_project_roles_of_member | GET /v3/projects/{projectId}/members/{userId}/permissions | Get all roles the user has on a project |
| ProjectApi | get_projects | GET /v3/projects | Get projects |
| ProjectApi | get_top_level_wiki_pages | GET /v3/projects/{projectId}/wikipages | Get wiki pages of a project |
| ProjectApi | get_trackers | GET /v3/projects/{projectId}/trackers | Get trackers |
| ProjectApi | search_all_trackers_in_project | POST /v3/projects/{projectId}/trackers/search | Get the list of all trackers in a project |
| ProjectApi | search_projects | POST /v3/projects/search | Search projects by given criteria |
| ReportApi | create_report | POST /v3/reports | Create a report |
| ReportApi | get_report_by_id | GET /v3/reports/{reportId}/results | Get a report results by id of the report |
| ReportApi | get_report_items_by_id | GET /v3/reports/{reportId}/items | Get a report items by id of the report |
| ReportApi | update_report | PUT /v3/reports/{reportId} | Update report settings |
| RepositoryItemApi | create_external_scm_repository | POST /v3/trackers/projects/{projectId}/repository | Create an external scm repository item |
| RepositoryItemApi | update_external_scm_repository | PUT /v3/trackers/projects/{projectId}/repository/{repositoryId} | Update an external scm repository item |
| RoleApi | get_role | GET /v3/roles/{roleId} | Get role |
| RoleApi | get_roles | GET /v3/roles | Get roles |
| SystemApi | get_system_status | GET /v3/system/maintenance | Get system maintenance status |
| SystemApi | set_system_status | PUT /v3/system/maintenance | Set system maintenance status |
| SystemAdministratorApi | get_audit_permissions | POST /v3/sysadmin/audit/permissions | Get audit permission entries |
| TestManagementApi | auto_apply_step_reuses | POST /v3/testcases/autoApplyStepReuses | Find duplicate TestSteps in a set of TestCases and converting duplicates to Reuses |
| TestRunApi | create_test_run_for_test_case | POST /v3/trackers/{testRunTrackerId}/testruns | Create a new test run for test cases or test sets |
| TestRunApi | create_test_run_for_test_sets | POST /v3/trackers/{testRunTrackerId}/testruns/generatefromtestset | Create a new test run for test cases or test sets |
| TestRunApi | update_test_run_result | PUT /v3/testruns/{testRunId} | Update result of a Test Run. |
| TestRunApi | upload_automated_test_results | POST /v3/trackers/{testRunTrackerId}/automatedtestruns | Create a new test run for large number of automated test cases |
| TraceabilityApi | get_traceability_initial_item_ids | POST /v3/traceability/items | Get initial ids |
| TraceabilityApi | get_traceability_level_item_ids | POST /v3/traceability/relations | Get traceability level item ids |
| TrackerApi | delete_tracker | DELETE /v3/trackers/{trackerId} | Deletes a tracker |
| TrackerApi | get_choice_option | GET /v3/trackers/{trackerId}/fields/{fieldId}/options/{optionId} | Get option of a choice field of tracker |
| TrackerApi | get_items_by_tracker | GET /v3/trackers/{trackerId}/items | Get items in a specific tracker |
| TrackerApi | get_tracker | GET /v3/trackers/{trackerId} | Get tracker |
| TrackerApi | get_tracker_baselines | GET /v3/trackers/{trackerId}/baselines | Get baselines of a specific tracker |
| TrackerApi | get_tracker_configuration | GET /v3/tracker/{trackerId}/configuration | Get tracker configuration |
| TrackerApi | get_tracker_field | GET /v3/trackers/{trackerId}/fields/{fieldId} | Get field of tracker |
| TrackerApi | get_tracker_field_permissions | GET /v3/trackers/{trackerId}/fields/{fieldId}/permissions | Get permissions of tracker field |
| TrackerApi | get_tracker_fields | GET /v3/trackers/{trackerId}/fields | Get fields of tracker |
| TrackerApi | get_tracker_fields_permissions | GET /v3/trackers/{trackerId}/fields/permissions | Get permissions of all fields of a tracker |
| TrackerApi | get_tracker_outline | GET /v3/trackers/{trackerId}/outline | Get outline of a specific tracker |
| TrackerApi | get_tracker_schema | GET /v3/trackers/{trackerId}/schema | Get the schema of a tracker |
| TrackerApi | get_tracker_transitions | GET /v3/trackers/{trackerId}/transitions | Get all transitions of a specific tracker |
| TrackerApi | get_tracker_type | GET /v3/trackers/types/{trackerTypeId} | Get the immutable definition of a tracker type |
| TrackerApi | get_tracker_types | GET /v3/trackers/types | Get the list of tracker types |
| TrackerApi | post_tracker_configuration | POST /v3/tracker/configuration | Create or update tracker configuration |
| TrackerApi | update_tracker | PUT /v3/trackers/{trackerId} | Updates a specific tracker |
| TrackerApi | update_tracker_icon | PUT /v3/trackers/{trackerId}/icon | Upload a tracker icon |
| TrackerItemMoveApi | get_item_move_field_mapping | GET /v3/items/move/field-mapping | Gets the default field mapping between two trackers |
| TrackerItemMoveApi | move_tracker_items | POST /v3/items/move | Move Tracker Items from the Source Tracker to the Target Tracker |
| TrackerTreeApi | list_tracker_tree | GET /v3/trackers/tree | List tracker tree |
| TrackerTreeApi | update_tracker_tree | POST /v3/trackers/tree/update | Update tracker tree |
| TrackerItemApi | add_child_to_tracker | POST /v3/trackers/{trackerId}/children | Add a child item to a tracker item |
| TrackerItemApi | add_child_to_tracker_item | POST /v3/items/{itemId}/children | Add a child item to a tracker item |
| TrackerItemApi | bulk_update_tracker_item_fields | PUT /v3/items/fields | Bulk update fields of a tracker item |
| TrackerItemApi | check_tracker_item_lock | GET /v3/items/{itemId}/lock | Check whether a tracker item is locked, and if it is, retrieve the details of the lock |
| TrackerItemApi | create_tracker_item | POST /v3/trackers/{trackerId}/items | Create a tracker item |
| TrackerItemApi | delete_tracker_item | DELETE /v3/items/{itemId} | Move tracker item to trash |
| TrackerItemApi | find_tracker_children | GET /v3/trackers/{trackerId}/children | Get child items of a tracker item |
| TrackerItemApi | find_tracker_item_children | GET /v3/items/{itemId}/children | Get child items of a tracker item |
| TrackerItemApi | find_tracker_items | GET /v3/items/query | Get tracker items by cbQL query string |
| TrackerItemApi | find_tracker_items_by_cb_ql | POST /v3/items/query | Get tracker items by cbQL query string |
| TrackerItemApi | get_baseline_tracker_item_relations | GET /v3/items/{itemId}/relations | Get tracker items related to a tracker item |
| TrackerItemApi | get_baseline_tracker_items_relations | POST /v3/items/relations | Get tracker items related to some tracker items |
| TrackerItemApi | get_choice_options | GET /v3/items/{itemId}/fields/{fieldId}/options | Get the options of a choice field of tracker |
| TrackerItemApi | get_item_accessibility | GET /v3/items/{itemId}/fields/accessibility | Get a tracker item fields accessibility |
| TrackerItemApi | get_tracker_item | GET /v3/items/{itemId} | Get basic tracker item |
| TrackerItemApi | get_tracker_item_fields | GET /v3/items/{itemId}/fields | Get fields of a tracker item |
| TrackerItemApi | get_tracker_item_history | GET /v3/items/{itemId}/history | Get tracker item history |
| TrackerItemApi | get_tracker_item_reviews | GET /v3/items/{itemId}/reviews | Get all Tracker Item Reviews for a particular Tracker Item |
| TrackerItemApi | get_tracker_item_transitions | GET /v3/items/{itemId}/transitions | Get available transitions for a tracker item |
| TrackerItemApi | lock_tracker_item | PUT /v3/items/{itemId}/lock | Put a soft lock on a tracker item |
| TrackerItemApi | patch_children_of_tracker | PATCH /v3/trackers/{trackerId}/children | Patch the child item list of a tracker item |
| TrackerItemApi | patch_children_of_tracker_item | PATCH /v3/items/{itemId}/children | Patch the child item list of a tracker item |
| TrackerItemApi | replace_children_of_tracker | PUT /v3/trackers/{trackerId}/children | Reorder the child item list of a tracker |
| TrackerItemApi | replace_children_of_tracker_item | PUT /v3/items/{itemId}/children | Replace the child item list of a tracker item |
| TrackerItemApi | unlock_tracker_item | DELETE /v3/items/{itemId}/lock | Unlock a tracker item |
| TrackerItemApi | update_custom_field_tracker_item | PUT /v3/items/{itemId}/fields | Update fields of a tracker item |
| TrackerItemApi | update_table_field_tracker_item | PUT /v3/items/{itemId}/fields/tables/{tableFieldId} | Update table field of tracker item |
| TrackerItemApi | update_tracker_item | PUT /v3/items/{itemId} | Update tracker item |
| TrackerItemsAttachmentApi | delete_tracker_item_attachment | DELETE /v3/items/{itemId}/attachments/{attachmentId} | Delete attachment of tracker item by id |
| TrackerItemsAttachmentApi | delete_tracker_item_attachments | DELETE /v3/items/{itemId}/attachments | Delete attachments of tracker item |
| TrackerItemsAttachmentApi | get_tracker_item_attachment | GET /v3/items/{itemId}/attachments/{attachmentId} | Get attachment of tracker item by id |
| TrackerItemsAttachmentApi | get_tracker_item_attachment_content | GET /v3/items/{itemId}/attachments/{attachmentId}/content | Get content of an attachment of tracker item by id |
| TrackerItemsAttachmentApi | get_tracker_item_attachment_contents | GET /v3/items/{itemId}/attachments/content | Get attachments of a tracker item |
| TrackerItemsAttachmentApi | get_tracker_item_attachments | GET /v3/items/{itemId}/attachments | Get attachments of tracker item |
| TrackerItemsAttachmentApi | get_tracker_items_attachment_contents | POST /v3/items/attachments/content | Get attachments of tracker items matching the extension or mime type filters |
| TrackerItemsAttachmentApi | update_attachment_of_tracker_item | PUT /v3/items/{itemId}/attachments/{attachmentId}/content | Update content of attachment of tracker item |
| TrackerItemsAttachmentApi | upload_tracker_item_attachment | POST /v3/items/{itemId}/attachments | Upload an attachment to a tracker item |
| TrackerItemsCommentApi | comment_on_tracker_item | POST /v3/items/{itemId}/comments | Comment on a tracker item |
| TrackerItemsCommentApi | delete_tracker_item_comment | DELETE /v3/items/{itemId}/comments/{commentId} | Delete comment of tracker item by id |
| TrackerItemsCommentApi | delete_tracker_item_comments | DELETE /v3/items/{itemId}/comments | Delete comments of tracker item by item id |
| TrackerItemsCommentApi | edit_comment_on_tracker_item | PUT /v3/items/{itemId}/comments/{commentId} | Edit comment on a tracker item |
| TrackerItemsCommentApi | get_tracker_item_comment | GET /v3/items/{itemId}/comments/{commentId} | Get comment of tracker item by id |
| TrackerItemsCommentApi | get_tracker_item_comments | GET /v3/items/{itemId}/comments | Get comments of tracker item |
| TrackerItemsCommentApi | reply_on_comment_of_tracker_item | POST /v3/items/{itemId}/comments/{commentId} | Reply on a comment of a tracker item |
| TrackerPermissionApi | get_tracker_permission | GET /v3/trackers/permissions/{trackerPermissionId} | Get the immutable definition of a tracker permission |
| TrackerPermissionApi | get_tracker_permissions | GET /v3/trackers/permissions | Get available tracker permissions |
| TrackerPermissionApi | get_tracker_permissions_with_roles | GET /v3/trackers/{trackerId}/permissions | List tracker permissions per role |
| TrackerPermissionApi | remove_permissions | DELETE /v3/trackers/{trackerId}/roles/{roleId}/permissions | Removes all tracker permissions from a specific role |
| TrackerPermissionApi | update_permission | PUT /v3/trackers/{trackerId}/roles/{roleId}/permissions | Set the tracker permissions for a specific role |
| TrackerReportApi | create_tracker_report | POST /v3/trackers/{trackerId}/reports | Creates a report of a specific tracker |
| TrackerReportApi | delete_tracker_report | DELETE /v3/trackers/{trackerId}/reports/{reportId} | Deletes a report of a specific tracker |
| TrackerReportApi | get_tracker_report | GET /v3/trackers/{trackerId}/reports/{reportId}/results | Get a report of a specific tracker |
| TrackerReportApi | get_tracker_report_items | GET /v3/trackers/{trackerId}/reports/{reportId}/items | Get report items of a specific tracker view |
| TrackerReportApi | get_tracker_reports | GET /v3/trackers/{trackerId}/reports | Get all reports of a specific tracker |
| TrackerReportApi | update_tracker_report | PUT /v3/trackers/{trackerId}/reports/{reportId} | Updates a report of a specific tracker |
| UserApi | get_user | GET /v3/users/{userId} | Get user |
| UserApi | get_user_by_email | GET /v3/users/findByEmail | Get user by email address |
| UserApi | get_user_by_name | GET /v3/users/findByName | Get user by name |
| UserApi | get_users | GET /v3/users | Get users |
| UserApi | search_users | POST /v3/users/search | Search users |
| WikiApi | check_wiki_page_lock | GET /v3/wikipages/{wikiId}/lock | Check whether a wiki page is locked, and if it is, retrieve the details of the lock |
| WikiApi | create_wiki_page | POST /v3/wikipages | Create a new wiki page |
| WikiApi | delete_wiki_page | DELETE /v3/wikipages/{wikiId} | Delete a wiki page by its ID |
| WikiApi | get_wiki_page | GET /v3/wikipages/{wikiId} | Get wiki page |
| WikiApi | get_wiki_page_history | GET /v3/wikipages/{wikiId}/history | Returns the change history of the specified wiki page |
| WikiApi | get_wiki_permissions | GET /v3/wikipages/{wikiId}/permissions | Get permissions of a wiki page |
| WikiApi | lock_wiki_page | PUT /v3/wikipages/{wikiId}/lock | Lock a wiki page |
| WikiApi | render_wiki_markup | POST /v3/projects/{projectId}/wiki2html | Render a wiki page as HTML in a specific context |
| WikiApi | render_wiki_page | GET /v3/wikipages/{wikiId}/html | Render a wiki page as HTML |
| WikiApi | restore_wiki_page_content | PUT /v3/wikipages/{wikiId}/restorecontent | Restores the content from a previous version of a wiki page |
| WikiApi | set_wiki_permissions | PUT /v3/wikipages/{wikiId}/permissions | Set permissions of a wiki page |
| WikiApi | unlock_wiki_page | DELETE /v3/wikipages/{wikiId}/lock | Unlock a wiki page |
| WikiApi | update_wiki_page | PUT /v3/wikipages/{itemId} | Update and/or move a wiki page |
| WikisCommentApi | comment_on_wiki | POST /v3/wikipages/{wikiId}/comments | Comment on a wiki page |
| WikisCommentApi | get_attachment_by_name | GET /v3/wikipages/{wikiId}/attachments | Get attachment of wiki page by file name |
| WorkingSetApi | get_items_mapping_in_working_set | POST /v3/working-sets/items-mapping | Maps Tracker Items in Working-Set |
| WorkingSetApi | get_tracker_working_sets | GET /v3/trackers/{trackerId}/working-sets | Lists Working-Sets |
| WorkingSetApi | get_working_set_information | GET /v3/working-sets/{workingSetId} | Working-Set information |
| WorkingSetApi | get_working_set_trackers | GET /v3/working-sets/{workingSetId}/trackers | Lists the trackers in a Working-Set |
| WorkingSetApi | list_working_sets_of_project | GET /v3/projects/{projectId}/working-sets | Project level Working-Sets information |
| WorkingSetPermissionApi | update_working_set_permission | POST /v3/workingset/{workingSetId}/permission | Set the trackers permissions for specific roles in the given workingset |
- AbstractBackgroundJobStatusInfo
- AbstractBaselineReferenceModel
- AbstractField
- AbstractFieldValue
- AbstractOutline
- AbstractReference
- AbstractTrackerItemChange
- AbstractTrackerItemReference
- AccessPermission
- AccessPermissionsRequest
- ArtifactReference
- ArtifactReferenceField
- ArtifactRevision
- ArtifactRevisionSearchResult
- Association
- AssociationType
- AssociationTypeReference
- Attachment
- AttachmentMigrationRequest
- AttachmentReference
- AttachmentSearchResult
- AuditPermissionMessage
- AuditPermissions
- AuditPermissionsRequest
- AutoApplyTestStepReuses
- AutomatedTestCaseRunResult
- AutomatedTestRunRequest
- BackgroundJob
- BackgroundJobStep
- BadRequestException
- BaseTrackerFieldChoiceOption
- BaseTrackerFieldPermission
- Baseline
- BatchGetTrackerItemReviewsRequest
- BoolField
- BoolFieldValue
- BranchReference
- BulkOperationResponse
- ChoiceDocuments
- ChoiceFieldMultiValue
- ChoiceFieldValue
- ChoiceMembers
- ChoiceOptionReference
- ChoiceOptions
- ChoiceOptionsChoiceOption
- ChoiceProjects
- ChoiceRepositories
- ChoiceTrackers
- ChoiceUsers
- ChoiceWorkConfigItems
- ColorField
- ColorFieldValue
- Comment
- CommentReference
- CountryField
- CountryFieldMultiValue
- CountryFieldValue
- CreateBaselineRequest
- CreateTestRunFromTestSetsRequest
- CreateTestRunRequest
- CrossProjectDependency
- DateField
- DateFieldValue
- DecimalField
- DecimalFieldValue
- DefaultBackgroundJobStatusInfo
- DefaultFieldSingleValue
- DefaultMultiFieldValue
- DependencyAttribute
- DependencyEntityReference
- DependencyFinderJobStatusInfo
- DeployProject
- DeploymentModel
- DeploymentProjectExportSettings
- DeploymentTrackerExportSettings
- DownstreamTrackerItemReference
- DurationField
- DurationFieldValue
- EditComment
- ExportForDeploymentRequest
- ExportProject
- ExportToWordRequest
- ExternalScmRepositoryRequest
- FailedOperation
- FieldLayoutGroups
- FieldLayoutSettings
- FieldReference
- IncomingTrackerItemAssociation
- IntegerField
- IntegerFieldValue
- InternalServerErrorException
- InvalidParametersException
- JobReference
- JsonView
- Label
- LanguageField
- LanguageFieldMultiValue
- LanguageFieldValue
- LayoutField
- LockInfo
- LockRequest
- MaintenanceMode
- MaintenanceModeProperties
- MemberField
- MemberReferenceSearchResult
- NotImplementedException
- NotSupportedFieldValue
- OptionChoiceField
- OutgoingTrackerItemAssociation
- OutlineIndex
- OutlineItem
- OutlineItemSearchResult
- OutlineWiki
- PaginatedAuditPermissionsResponse
- PerStatusFieldPermission
- PermissionIdsRequest
- PostComment
- Project
- ProjectBaselineReference
- ProjectChoiceField
- ProjectFilteringRequest
- ProjectMemberPermissions
- ProjectReference
- ProjectRoleReference
- ProjectSearchResult
- ProjectWithTrackerTypesReference
- ReferenceField
- ReferenceFilterBasedChoiceReferenceFilter
- ReferenceSearchResult
- ReferredTestStepFieldValue
- RemoteMigrationFile
- ReportAggregate
- ReportCell
- ReportColumn
- ReportColumnSettings
- ReportGroup
- ReportGroupWithGroups
- ReportGroupWithReferencedRows
- ReportGroupWithRows
- ReportItem
- ReportItemReference
- ReportItemResult
- ReportPagingInformation
- ReportPermission
- ReportReference
- ReportReferenceLevel
- ReportReferenceLevelSettings
- ReportReferencedRow
- ReportResult
- ReportRow
- RepositoryChoiceField
- RepositoryReference
- ResizableReportColumnSettings
- ResourceForbiddenException
- ResourceLockedException
- ResourceNotFoundException
- ResourceUnauthorizedException
- RestException
- ReviewMemberReferenceField
- Role
- RoleReference
- RoleWithPermissions
- SameAsFieldPermission
- SharedFieldReference
- SimpleReportSettings
- SingleFieldPermission
- StatusLayout
- SystemStatus
- TableField
- TableFieldValue
- TestRunResult
- TextField
- TextFieldValue
- TooManyRequestsException
- TraceabilityInitialLevelFilter
- TraceabilityItem
- TraceabilityLevelFilter
- TraceabilityResult
- Tracker
- TrackerBaselineReference
- TrackerBasicInformation
- TrackerChoiceField
- TrackerConfiguration
- TrackerField
- TrackerFieldComputedFieldReference
- TrackerFieldDateFieldSettings
- TrackerFieldDependency
- TrackerFieldLayoutSettings
- TrackerFieldPermissionAccessPermission
- TrackerFieldPermissions
- TrackerFieldServiceDeskField
- TrackerFieldStatusPermissions
- TrackerFieldsStatusPermissions
- TrackerFilteringRequest
- TrackerIdIconBody
- TrackerItem
- TrackerItemAttachmentRequest
- TrackerItemChange
- TrackerItemChildReference
- TrackerItemChoiceField
- TrackerItemField
- TrackerItemFieldAccessibility
- TrackerItemFieldAccessibilityList
- TrackerItemFieldMapping
- TrackerItemFieldMappingInfo
- TrackerItemFieldMappingPair
- TrackerItemFieldMappingPossiblePair
- TrackerItemHistory
- TrackerItemHistoryRevision
- TrackerItemMoveRequest
- TrackerItemReference
- TrackerItemReferenceData
- TrackerItemReferenceSearchResult
- TrackerItemRelationsResult
- TrackerItemReview
- TrackerItemReviewConfig
- TrackerItemReviewExport
- TrackerItemReviewVote
- TrackerItemReviewVoteExport
- TrackerItemRevision
- TrackerItemRowChange
- TrackerItemSearchRequest
- TrackerItemSearchResult
- TrackerItemWithTrackerItemReviewsExport
- TrackerItemsRequest
- TrackerPermission
- TrackerPermissionReference
- TrackerReference
- TrackerReportSettings
- TrackerSearchResult
- TrackerTree
- TrackerType
- TrackerTypeReference
- TrackerWorkingSet
- UnrestrictedFieldPermission
- UpdateAttachment
- UpdateTestCaseRunRequest
- UpdateTestRunRequest
- UpdateTrackerItemChildrenRequest
- UpdateTrackerItemField
- UpdateTrackerItemFieldWithItemId
- UpdateTrackerItemTableField
- UploadAttachment
- UpstreamTrackerItemReference
- UrlField
- UrlFieldValue
- User
- UserChoiceField
- UserFilteringRequest
- UserGroup
- UserGroupReference
- UserReference
- UserReferenceSearchResult
- UserSearchResult
- WikiOutlineSearchResult
- WikiPage
- WikiPageReference
- WikiRenderRequest
- WikiTextField
- WikiTextFieldMultiValue
- WikiTextFieldValue
- WorkflowTransition
- WorkingSetInformation
- WorkingSetItemMapping
- WorkingSetItemsMappingRequest
- WorkingSetMinimal
- WorkingSetPermissionRequest
- WorkingSetReference
- WorkingSetTracker
- WorkingSetTrackerUpdateRequest
- WorkingSetUpdateRequest
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: HTTP basic authentication