Skip to content

Latest commit

 

History

History
396 lines (361 loc) · 46 KB

API.md

File metadata and controls

396 lines (361 loc) · 46 KB

pycherwell

Unofficial Python Cherwell REST API library.

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/greenpau/pycherwell.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/greenpau/pycherwell.git)

Then import the package:

import pycherwell

Setuptools

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 pycherwell

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import pycherwell
from pycherwell.rest import ApiException
from pprint import pprint


# Defining host is optional and default to https://demo.cherwellondemand.com
configuration.host = "https://demo.cherwellondemand.com"
# Create an instance of the API class
api_instance = pycherwell.BusinessObjectApi(pycherwell.ApiClient(configuration))
batch_delete_request = pycherwell.BatchDeleteRequest() # BatchDeleteRequest | Specify an array of Business Object IDs and record IDs or public IDs. Use a flag to stop on error or continue on error.

try:
    # Delete Business Objects in a batch
    api_response = api_instance.business_object_delete_business_object_batch_v1(batch_delete_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessObjectApi->business_object_delete_business_object_batch_v1: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://demo.cherwellondemand.com

Class Method HTTP request Description
BusinessObjectApi business_object_delete_business_object_batch_v1 POST /api/V1/deletebusinessobjectbatch Delete Business Objects in a batch
BusinessObjectApi business_object_delete_business_object_by_public_id_v1 DELETE /api/V1/deletebusinessobject/busobid/{busobid}/publicid/{publicid} Delete a Business Object by public ID
BusinessObjectApi business_object_delete_business_object_by_rec_id_v1 DELETE /api/V1/deletebusinessobject/busobid/{busobid}/busobrecid/{busobrecid} Delete a Business Object by record ID
BusinessObjectApi business_object_delete_related_business_object_by_public_id_v1 DELETE /api/V1/deleterelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid}/publicid/{publicid} Delete a related Business Object by public ID
BusinessObjectApi business_object_delete_related_business_object_by_rec_id_v1 DELETE /api/V1/deleterelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid}/busobrecid/{busobrecid} Delete a related Business Object by record ID
BusinessObjectApi business_object_field_values_lookup_v1 POST /api/V1/fieldvalueslookup Get lookup values for fields
BusinessObjectApi business_object_get_business_object_attachment_by_attachment_id_v1 GET /api/V1/getbusinessobjectattachment/attachmentid/{attachmentid}/busobid/{busobid}/busobrecid/{busobrecid} Get an imported Business Object attachment
BusinessObjectApi business_object_get_business_object_attachments_by_id_and_public_id_v1 GET /api/V1/getbusinessobjectattachments/busobid/{busobid}/publicid/{publicid}/type/{type}/attachmenttype/{attachmenttype} Get attachments by Business Object public ID
BusinessObjectApi business_object_get_business_object_attachments_by_id_and_rec_id_v1 GET /api/V1/getbusinessobjectattachments/busobid/{busobid}/busobrecid/{busobrecid}/type/{type}/attachmenttype/{attachmenttype} Get attachments by Business Object record ID
BusinessObjectApi business_object_get_business_object_attachments_by_name_and_public_id_v1 GET /api/V1/getbusinessobjectattachments/busobname/{busobname}/publicid/{publicid}/type/{type}/attachmenttype/{attachmenttype} Get attachments by Business Object name and public ID
BusinessObjectApi business_object_get_business_object_attachments_by_name_and_rec_id_v1 GET /api/V1/getbusinessobjectattachments/busobname/{busobname}/busobrecid/{busobrecid}/type/{type}/attachmenttype/{attachmenttype} Get attachments by Business Object name and record ID
BusinessObjectApi business_object_get_business_object_attachments_v1 POST /api/V1/getbusinessobjectattachments Get Business Object attachments by request object
BusinessObjectApi business_object_get_business_object_batch_v1 POST /api/V1/getbusinessobjectbatch Get a batch of Business Object records
BusinessObjectApi business_object_get_business_object_by_public_id_v1 GET /api/V1/getbusinessobject/busobid/{busobid}/publicid/{publicid} Get a Business Object record
BusinessObjectApi business_object_get_business_object_by_rec_id_v1 GET /api/V1/getbusinessobject/busobid/{busobid}/busobrecid/{busobrecid} Get a Business Object record
BusinessObjectApi business_object_get_business_object_by_scan_code_bus_ob_id_v1 GET /api/V1/getbusinessobject/scancode/{scanCode}/busobid/{busobid} Get a Business Object by its scan code and Business Object ID
BusinessObjectApi business_object_get_business_object_by_scan_code_bus_ob_name_v1 GET /api/V1/getbusinessobject/scancode/{scanCode}/busobname/{busobname} Get a Business Object by its scan code and Business Object name
BusinessObjectApi business_object_get_business_object_schema_v1 GET /api/V1/getbusinessobjectschema/busobid/{busobId} Get a Business Object schema
BusinessObjectApi business_object_get_business_object_summaries_v1 GET /api/V1/getbusinessobjectsummaries/type/{type} Get Business Object summaries by type
BusinessObjectApi business_object_get_business_object_summary_by_id_v1 GET /api/V1/getbusinessobjectsummary/busobid/{busobid} Get a Business Object summary by ID
BusinessObjectApi business_object_get_business_object_summary_by_name_v1 GET /api/V1/getbusinessobjectsummary/busobname/{busobname} Get a Business Object summary by name
BusinessObjectApi business_object_get_business_object_template_v1 POST /api/V1/getbusinessobjecttemplate Get Business Object templates for create
BusinessObjectApi business_object_get_related_business_object_by_request_v1 POST /api/V1/getrelatedbusinessobject Get related Business Objects using a request object
BusinessObjectApi business_object_get_related_business_object_v1 GET /api/V1/getrelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid} Get related Business Objects by ID
BusinessObjectApi business_object_get_related_business_object_with_custom_grid_v1 GET /api/V1/getrelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid}/gridid/{gridid} Get related Business Objects custom grid
BusinessObjectApi business_object_link_related_business_object_by_rec_id_v1 GET /api/V1/linkrelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid}/busobid/{busobid}/busobrecid/{busobrecid} Link related Business Objects
BusinessObjectApi business_object_remove_business_object_attachment_by_id_and_public_id_v1 DELETE /api/V1/removebusinessobjectattachment/attachmentid/{attachmentid}/busobid/{busobid}/publicid/{publicid} Remove an attachment by Business Object ID and public ID
BusinessObjectApi business_object_remove_business_object_attachment_by_id_and_rec_id_v1 DELETE /api/V1/removebusinessobjectattachment/attachmentid/{attachmentid}/busobid/{busobid}/busobrecid/{busobrecid} Remove an attachment by Business Object ID and record ID
BusinessObjectApi business_object_remove_business_object_attachment_by_name_and_public_id_v1 DELETE /api/V1/removebusinessobjectattachment/attachmentid/{attachmentid}/busobname/{busobname}/publicid/{publicid} Remove an attachment by Business Object name and public ID
BusinessObjectApi business_object_remove_business_object_attachment_by_name_and_rec_id_v1 DELETE /api/V1/removebusinessobjectattachment/attachmentid/{attachmentid}/busobname/{busobname}/busobrecid/{busobrecid} Remove an attachment by Business Object name and record ID
BusinessObjectApi business_object_save_business_object_attachment_bus_ob_v1 PUT /api/V1/savebusinessobjectattachmentbusob Attach a Business Object to a Business Object
BusinessObjectApi business_object_save_business_object_attachment_link_v1 PUT /api/V1/savebusinessobjectattachmentlink Attach a file via UNC
BusinessObjectApi business_object_save_business_object_attachment_url_v1 PUT /api/V1/savebusinessobjectattachmenturl Attach a URL path
BusinessObjectApi business_object_save_business_object_batch_v1 POST /api/V1/savebusinessobjectbatch Create or update a batch of Business Objects
BusinessObjectApi business_object_save_business_object_v1 POST /api/V1/savebusinessobject Create or Update a Business Object
BusinessObjectApi business_object_save_related_business_object_v1 POST /api/V1/saverelatedbusinessobject Create or update a related Business Object
BusinessObjectApi business_object_un_link_related_business_object_by_rec_id_v1 DELETE /api/V1/unlinkrelatedbusinessobject/parentbusobid/{parentbusobid}/parentbusobrecid/{parentbusobrecid}/relationshipid/{relationshipid}/busobid/{busobid}/busobrecid/{busobrecid} UnLink related Business Objects
BusinessObjectApi business_object_upload_business_object_attachment_by_id_and_public_id_v1 POST /api/V1/uploadbusinessobjectattachment/filename/{filename}/busobid/{busobid}/publicid/{publicid}/offset/{offset}/totalsize/{totalsize} Upload an attachment by Business Object ID and public ID
BusinessObjectApi business_object_upload_business_object_attachment_by_id_and_rec_id_v1 POST /api/V1/uploadbusinessobjectattachment/filename/{filename}/busobid/{busobid}/busobrecid/{busobrecid}/offset/{offset}/totalsize/{totalsize} Upload an attachment by Business Object ID and record ID
BusinessObjectApi business_object_upload_business_object_attachment_by_name_and_public_id_v1 POST /api/V1/uploadbusinessobjectattachment/filename/{filename}/busobname/{busobname}/publicid/{publicid}/offset/{offset}/totalsize/{totalsize} Upload an attachment by Business Object name and public ID
BusinessObjectApi business_object_upload_business_object_attachment_by_name_and_rec_id_v1 POST /api/V1/uploadbusinessobjectattachment/filename/{filename}/busobname/{busobname}/busobrecid/{busobrecid}/offset/{offset}/totalsize/{totalsize} Upload an attachment by Business Object name and record ID
CoreApi core_delete_gallery_image_by_stand_in_key_v1 DELETE /api/V1/deletegalleryimage/standinkey/{standinkey} Delete a gallery image
CoreApi core_get_gallery_image_v1 GET /api/V1/getgalleryimage/name/{name} Get built-in images
CoreApi core_get_gallery_images_folder_v1 GET /api/V1/getgalleryimages/scope/{scope}/scopeowner/{scopeowner}/folder/{folder} Get gallery images by scope, scopeowner, and folder
CoreApi core_get_gallery_images_scope_owner_v1 GET /api/V1/getgalleryimages/scope/{scope}/scopeowner/{scopeowner} Get gallery images by scope and scopeowner
CoreApi core_get_gallery_images_scope_v1 GET /api/V1/getgalleryimages/scope/{scope} Get gallery images by scope
CoreApi core_get_gallery_images_v1 GET /api/V1/getgalleryimages Get all gallery images
CoreApi core_get_stored_value_v1 GET /api/V1/getstoredvalue/standinkey/{standInKey} Get a stored value
CoreApi core_get_stored_values_folder_v1 GET /api/V1/storedvalues/scope/{scope}/scopeowner/{scopeowner}/folder/{folder} Get stored values by folder
CoreApi core_get_stored_values_scope_owner_v1 GET /api/V1/storedvalues/scope/{scope}/scopeowner/{scopeowner} Get stored values by scope owner
CoreApi core_get_stored_values_scope_v1 GET /api/V1/storedvalues/scope/{scope} Get stored values by scope
CoreApi core_get_stored_values_v1 GET /api/V1/storedvalues Gets all the stored values in the system
CoreApi core_get_views_v1 GET /api/V1/getviews Get a list of the views
CoreApi core_save_gallery_image_v1 POST /api/V1/savegalleryimage Create or update a gallery image
CoreApi core_save_stored_value_v1 POST /api/V1/savestoredvalue Create or update a stored value
CoreApi core_set_culture_v1 PUT /api/V1/setculture/culturecode/{culturecode} Set the culture for the current user
FormsApi forms_get_mobile_form_for_bus_ob_by_id_and_public_id_v1 GET /api/V1/getmobileformforbusob/busobid/{busobid}/publicid/{publicid} Get mobile form by BusObId and Public ID
FormsApi forms_get_mobile_form_for_bus_ob_by_id_and_rec_id_v1 GET /api/V1/getmobileformforbusob/busobid/{busobid}/busobrecid/{busobrecid} Get mobile form by Business Object ID and Business Object Record ID.
FormsApi forms_get_mobile_form_for_bus_ob_by_name_and_public_id_v1 GET /api/V1/getmobileformforbusob/busobname/{busobname}/publicid/{publicid} Get mobile form by Business Object name and Public ID
FormsApi forms_get_mobile_form_for_bus_ob_by_name_and_rec_id_v1 GET /api/V1/getmobileformforbusob/busobname/{busobname}/busobrecid/{busobrecid} Get mobile form by Business Object name and record ID.
QueuesApi queues_add_item_to_queue_v1 POST /api/V1/additemtoqueue Add a Business Object to a queue
QueuesApi queues_check_in_queue_item_v1 POST /api/V1/checkinqueueitem Check a Business Object in to a queue
QueuesApi queues_check_out_queue_item_v1 POST /api/V1/checkoutqueueitem Check a Business Object out of a queue
QueuesApi queues_get_queues_folder_v1 GET /api/V1/getqueues/scope/{scope}/scopeowner/{scopeowner}/folder/{folder} Get available queues.
QueuesApi queues_get_queues_scope_owner_v1 GET /api/V1/getqueues/scope/{scope}/scopeowner/{scopeowner} Get available queues.
QueuesApi queues_get_queues_scope_v1 GET /api/V1/getqueues/scope/{scope} Get available queues.
QueuesApi queues_get_queues_v1 GET /api/V1/getqueues Get available queues.
QueuesApi queues_remove_item_from_queue_v1 POST /api/V1/removeitemfromqueue Remove an item from a queue
SearchesApi searches_get_quick_search_configuration_for_bus_obs_v1 POST /api/V1/getquicksearchconfigurationforbusobs Get a Quick Search from a list of Business Object IDs
SearchesApi searches_get_quick_search_configuration_for_bus_obs_with_view_rights_v1 GET /api/V1/getquicksearchconfigurationforbusobswithviewrights Get a Quick Search by Business Objects with view rights
SearchesApi searches_get_quick_search_results_v1 POST /api/V1/getquicksearchresults Execute a Quick Search from a list of Business Object IDs and search text
SearchesApi searches_get_quick_search_specific_results_v1 POST /api/V1/getquicksearchspecificresults Execute a Quick Search on a specific Business Object
SearchesApi searches_get_quick_search_specific_results_v2 POST /api/V2/getquicksearchspecificresults Execute a Quick Search on a specific Business Object
SearchesApi searches_get_search_items_by_association_scope_scope_owner_folder_v1 GET /api/V1/getsearchitems/association/{association}/scope/{scope}/scopeowner/{scopeowner}/folder/{folder} Get all saved searches by Folder ID
SearchesApi searches_get_search_items_by_association_scope_scope_owner_folder_v2 GET /api/V2/getsearchitems/association/{association}/scope/{scope}/scopeowner/{scopeowner}/folder/{folder} Get all saved searches by Folder ID
SearchesApi searches_get_search_items_by_association_scope_scope_owner_v1 GET /api/V1/getsearchitems/association/{association}/scope/{scope}/scopeowner/{scopeowner} Get all saved searches by scope owner (sub scope)
SearchesApi searches_get_search_items_by_association_scope_scope_owner_v2 GET /api/V2/getsearchitems/association/{association}/scope/{scope}/scopeowner/{scopeowner} Get all saved searches by scope owner (sub scope)
SearchesApi searches_get_search_items_by_association_scope_v1 GET /api/V1/getsearchitems/association/{association}/scope/{scope} Get all saved searches by scope
SearchesApi searches_get_search_items_by_association_scope_v2 GET /api/V2/getsearchitems/association/{association}/scope/{scope} Get all saved searches by scope
SearchesApi searches_get_search_items_by_association_v1 GET /api/V1/getsearchitems/association/{association} Get all saved searches by Business Object association
SearchesApi searches_get_search_items_by_association_v2 GET /api/V2/getsearchitems/association/{association} Get all saved searches by Business Object association
SearchesApi searches_get_search_items_v1 GET /api/V1/getsearchitems Get all saved searches by default Business Object association
SearchesApi searches_get_search_items_v2 GET /api/V2/getsearchitems Get all saved searches by default Business Object association
SearchesApi searches_get_search_results_ad_hoc_v1 POST /api/V1/getsearchresults Run an ad-hoc search
SearchesApi searches_get_search_results_by_id_v1 GET /api/V1/getsearchresults/association/{association}/scope/{scope}/scopeowner/{scopeowner}/searchid/{searchid} Run a saved search by internal ID
SearchesApi searches_get_search_results_by_name_v1 GET /api/V1/getsearchresults/association/{association}/scope/{scope}/scopeowner/{scopeowner}/searchname/{searchname} Run a saved search by name
SearchesApi searches_get_search_results_export_ad_hoc_v1 POST /api/V1/getsearchresultsexport Export an ad-hoc search
SearchesApi searches_get_search_results_export_by_id_v1 GET /api/V1/getsearchresultsexport/association/{association}/scope/{scope}/scopeowner/{scopeowner}/searchid/{searchid}/exportformat/{exportformat} Export a saved search by ID
SearchesApi searches_get_search_results_export_by_name_v1 GET /api/V1/getsearchresultsexport/association/{association}/scope/{scope}/scopeowner/{scopeowner}/searchname/{searchname}/exportformat/{exportformat} Export a saved search by name
SecurityApi security_get_client_security_settings_v1 GET /api/V1/getclientsecuritysettings/applicationtype/{applicationtype} Get client security settings
SecurityApi security_get_roles_v1 GET /api/V1/getroles Get all available Roles
SecurityApi security_get_roles_v2 GET /api/V2/getroles Get all available Roles
SecurityApi security_get_security_group_business_object_permissions_by_bus_ob_id_v1 GET /api/V1/getsecuritygroupbusinessobjectpermissions/groupid/{groupid}/busobid/{busObId} Get Business Object permissions by Security Group
SecurityApi security_get_security_group_business_object_permissions_by_bus_ob_id_v2 GET /api/V2/getsecuritygroupbusinessobjectpermissions/groupid/{groupid}/busobid/{busObId} Get Business Object permissions by Security Group
SecurityApi security_get_security_group_business_object_permissions_by_bus_ob_name_v1 GET /api/V1/getsecuritygroupbusinessobjectpermissions/groupname/{groupname}/busobname/{busobname} Get Business Object permissions by Security Group
SecurityApi security_get_security_group_business_object_permissions_by_bus_ob_name_v2 GET /api/V2/getsecuritygroupbusinessobjectpermissions/groupname/{groupname}/busobname/{busobname} Get Business Object permissions by Security Group
SecurityApi security_get_security_group_business_object_permissions_for_current_user_by_bus_ob_id_v1 GET /api/V1/getsecuritygroupbusinessobjectpermissionsforcurrentuserbybusobid/busobid/{busObId} Get Business Object permission for current user
SecurityApi security_get_security_group_business_object_permissions_for_current_user_by_bus_ob_id_v2 GET /api/V2/getsecuritygroupbusinessobjectpermissionsforcurrentuserbybusobid/busobid/{busObId} Get Business Object permission for current user
SecurityApi security_get_security_group_business_object_permissions_for_current_user_by_bus_ob_name_v1 GET /api/V1/getsecuritygroupbusinessobjectpermissionsforcurrentuserbybusobname/busobname/{busobname} Get Business Object permissions for current user
SecurityApi security_get_security_group_business_object_permissions_for_current_user_by_bus_ob_name_v2 GET /api/V2/getsecuritygroupbusinessobjectpermissionsforcurrentuserbybusobname/busobname/{busobname} Get Business Object permissions for current user
SecurityApi security_get_security_group_categories_v1 GET /api/V1/getsecuritygroupcategories Get all Security Group categories
SecurityApi security_get_security_group_categories_v2 GET /api/V2/getsecuritygroupcategories Get all Security Group categories
SecurityApi security_get_security_group_rights_by_group_id_and_category_id_v1 GET /api/V1/getsecuritygrouprights/groupid/{groupid}/categoryid/{categoryid} Get permissions for a Security Group by category
SecurityApi security_get_security_group_rights_by_group_id_and_category_id_v2 GET /api/V2/getsecuritygrouprights/groupid/{groupid}/categoryid/{categoryid} Get permissions for a Security Group by category
SecurityApi security_get_security_group_rights_by_group_name_and_category_name_v1 GET /api/V1/getsecuritygrouprights/groupname/{groupname}/categoryname/{categoryname} Get permissions for a Security Group by category
SecurityApi security_get_security_group_rights_by_group_name_and_category_name_v2 GET /api/V2/getsecuritygrouprights/groupname/{groupname}/categoryname/{categoryname} Get permissions for a Security Group by category
SecurityApi security_get_security_group_rights_for_current_user_by_category_id_v1 GET /api/V1/getsecuritygrouprightsforcurrentuserbycategoryid/categoryid/{categoryid} Get current user's permissions by Security Group category by ID
SecurityApi security_get_security_group_rights_for_current_user_by_category_id_v2 GET /api/V2/getsecuritygrouprightsforcurrentuserbycategoryid/categoryid/{categoryid} Get current user's permissions by Security Group category by ID
SecurityApi security_get_security_group_rights_for_current_user_by_category_name_v1 GET /api/V1/getsecuritygrouprightsforcurrentuserbycategoryname/categoryname/{categoryname} Get current user's permissions by Security Group category by name
SecurityApi security_get_security_group_rights_for_current_user_by_category_name_v2 GET /api/V2/getsecuritygrouprightsforcurrentuserbycategoryname/categoryname/{categoryname} Get current user's permissions by Security Group category by name
SecurityApi security_get_security_groups_v1 GET /api/V1/getsecuritygroups Get all available Security Groups
SecurityApi security_get_security_groups_v2 GET /api/V2/getsecuritygroups Get all available Security Groups
SecurityApi security_get_users_in_security_group_v1 GET /api/V1/getusersinsecuritygroup/groupid/{groupid} Get users in a Security Group
SecurityApi security_get_users_in_security_group_v2 GET /api/V2/getusersinsecuritygroup/groupid/{groupid} Get users in a Security Group
ServiceApi service_get_service_info_v1 GET /api/V1/serviceinfo Get information about the REST Api and CSM
ServiceApi service_logout_user_v1 DELETE /api/V1/logout Log out user by token
TeamsApi teams_add_user_to_team_by_batch_v1 POST /api/V1/addusertoteambybatch Add users to a team by batch
TeamsApi teams_add_user_to_team_v1 POST /api/V1/addusertoteam Add a user to a team
TeamsApi teams_add_user_to_team_v2 POST /api/V2/addusertoteam Add a user to a team
TeamsApi teams_delete_team_v1 DELETE /api/V1/deleteteam/{teamid} Delete a Team
TeamsApi teams_get_team_v1 GET /api/V1/getteam/{teamid} Get a team by its TeamId
TeamsApi teams_get_teams_v1 GET /api/V1/getteams Get all available Teams
TeamsApi teams_get_teams_v2 GET /api/V2/getteams Get all available Teams
TeamsApi teams_get_users_teams_v1 GET /api/V1/getusersteams/userrecordid/{userRecordId} Get Team assignments for a user
TeamsApi teams_get_users_teams_v2 GET /api/V2/getusersteams/userrecordid/{userRecordId} Get Team assignments for a user
TeamsApi teams_get_workgroups_v1 GET /api/V1/getworkgroups Get all available Workgroups
TeamsApi teams_get_workgroups_v2 GET /api/V2/getworkgroups Get all available Workgroups
TeamsApi teams_remove_customer_from_workgroup_v1 DELETE /api/V1/removecustomerfromworkgroup/workgroupid/{workgroupid}/customerrecordid/{customerrecordid} Remove a customer from a Workgroup
TeamsApi teams_remove_user_from_team_v1 DELETE /api/V1/removeuserfromteam/teamid/{teamId}/userrecordid/{userrecordid} Operation to remove a User from a Team.
TeamsApi teams_remove_user_from_team_v2 DELETE /api/V2/removeuserfromteam/teamid/{teamId}/userrecordid/{userrecordid} Operation to remove a User from a Team.
TeamsApi teams_save_team_member_v1 POST /api/V1/saveteammember Add or Update a team member
TeamsApi teams_save_team_v1 POST /api/V1/saveteam Create or update a team
TeamsApi teams_save_workgroup_member_v1 POST /api/V1/saveworkgroupmember Save the membership status of a Workgroup member.
UsersApi users_delete_user_batch_v1 POST /api/V1/deleteuserbatch Delete a batch of users
UsersApi users_delete_user_batch_v2 POST /api/V2/deleteuserbatch Delete a batch of users
UsersApi users_delete_user_v1 DELETE /api/V1/deleteuser/userrecordid/{userrecordid} Delete a user by record ID
UsersApi users_delete_user_v2 DELETE /api/V2/deleteuser/userrecordid/{userrecordid} Delete a user by record ID
UsersApi users_get_list_of_users GET /api/V1/getlistofusers Get a list of all system users.
UsersApi users_get_user_batch_v1 POST /api/V1/getuserbatch Get user information in a batch
UsersApi users_get_user_by_login_id_v1 GET /api/V1/getuserbyloginid/loginid/{loginid} Get a user by login ID
UsersApi users_get_user_by_login_id_v2 GET /api/V2/getuserbyloginid Get a user by login ID and login ID type
UsersApi users_get_user_by_login_id_v3 GET /api/V3/getuserbyloginid Get a user by login ID and login ID type
UsersApi users_get_user_by_public_id_v1 GET /api/V1/getuserbypublicid/publicid/{publicid} Get a user by public ID
UsersApi users_get_user_by_public_id_v2 GET /api/V2/getuserbypublicid/publicid/{publicid} Get a user by public ID
UsersApi users_get_user_by_rec_id GET /api/V1/getuserbyrecid/recid/{recid} Get a user by record ID
UsersApi users_save_user_batch_v1 POST /api/V1/saveuserbatch Create or update users in a batch
UsersApi users_save_user_batch_v2 POST /api/V2/saveuserbatch Create or update users in a batch
UsersApi users_save_user_v1 POST /api/V1/saveuser Create or update a user
UsersApi users_save_user_v2 POST /api/V2/saveuser Create or update a user

Documentation For Models

Documentation For Authorization

cherwellAuth

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Author

See AUTHORS.