api.cases.v2 package¶
Submodules¶
api.cases.v2.case module¶
Autogenerated API
-
api.cases.v2.case.
acknowledge_workflow
(caseID: int, workflow: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Acknowledge workflow on case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- workflow (str) – Workflow to acknowledge
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 261, “limit”: 917, “responseCode”: 200, “count”: 261, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Special beyond mean marriage family measure bill.”, “messageTemplate”: “Moment spring manage system.”, “field”: “True hard billion professional production.”, “parameter”: {}, “timestamp”: 517955958}], “currentPage”: 853, “size”: 753}
-
api.cases.v2.case.
add_attachment
(caseID: int, name: str = None, mimeType: str = None, data: str = None, encryptedZip: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Add new attachment (PUBLIC) Upload new attachment as JSON object with base64-encoded data
Return type: dict
-
api.cases.v2.case.
add_case_link
(caseID: int, linkToCaseID: int, type: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Add link to case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – ID of case to link from
- linkToCaseID (int) – ID of case to link to
- type (str) – Type of link to add
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 607, “limit”: 505, “responseCode”: 200, “count”: 870, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Tax agree despite hard.”, “messageTemplate”: “Just few event heavy body scientist.”, “field”: “Strategy minute bag policy.”, “parameter”: {}, “timestamp”: 253834563}], “currentPage”: 308, “size”: 369}
-
api.cases.v2.case.
add_case_tag
(caseID: int, tags: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Add tag to case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- tags (list) – Add multiple tags as key/value strings or JSON objects
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 562, “limit”: 326, “responseCode”: 200, “count”: 499, “data”: [{“id”: “Structure either expect budget.”, “addedTimestamp”: 674147504, “addedByUser”: {“id”: 166, “customerID”: 464, “userName”: “sbrown”, “name”: “Glenn Dixon”}, “key”: “According behind fight.”, “value”: “Research admit quality activity attorney population.”, “flags”: [“MERGED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Image the teach only.”, “messageTemplate”: “Teacher popular break performance eat sure do.”, “field”: “Sometimes surface future upon.”, “parameter”: {}, “timestamp”: 73179398}], “currentPage”: 592, “size”: 712}
-
api.cases.v2.case.
add_case_watcher
(caseID: int, subjectID: int = None, destination: str = None, type: str = 'email', verbose: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Add watcher to case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- subjectID (int) – Subject to add watcher for
- destination (str) – Contact information to add as watcher (email address or phone number). If subject is specified, this is ignored.
- type (str) – Type of watcher to add (default email)
- verbose (bool) – If set, explicitly set verbosity for watcher (will override default settings on subject)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 148, “limit”: 986, “responseCode”: 200, “count”: 855, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Similar exactly even loss security production.”, “messageTemplate”: “Here plant blood.”, “field”: “Them create home guess.”, “parameter”: {}, “timestamp”: 1374234213}], “currentPage”: 873, “size”: 188}
-
api.cases.v2.case.
add_comment
(caseID: int, asReplyTo: str = None, comment: str = None, originEmailAddress: str = None, internal: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Submit new comment to case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- asReplyTo (str) – Optional ID of comment to reply to.
- comment (str) – Comment to add. Html is allowed, will be sanitized.
- originEmailAddress (str) – If comment is added from an email, specify origin email address here => format:email
- internal (bool) – If true, mark comment as internal, only visible to service techs. Default is false.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 236, “limit”: 826, “responseCode”: 200, “count”: 643, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Subject magazine nor value federal meeting.”, “messageTemplate”: “Sound within sense though employee.”, “field”: “Trade all build couple doctor.”, “parameter”: {}, “timestamp”: 1218594467}], “currentPage”: 684, “size”: 34}
-
api.cases.v2.case.
advanced_case_search
(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, caseID: list = None, type: list = None, service: list = None, category: list = None, status: list = None, priority: list = None, startTimestamp: int = None, endTimestamp: int = None, assetID: list = None, tag: list = None, workflow: list = None, field: list = None, keywords: list = None, timeFieldStrategy: list = None, timeMatchStrategy: str = None, keywordFieldStrategy: list = None, keywordMatchStrategy: str = None, userID: list = None, userFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', userAssigned: bool = 'False', techAssigned: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Returns cases matching the defined CaseSearchCriteria (PUBLIC)
Return type: dict
Parameters: - limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
- offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
- subCriteria (list) –
- customerID (list) – Restrict search to data belonging to specified customers.
- caseID (list) – Restrict search to specific cases (by ID).
- type (list) – Restrict search to entries of one of these types.
- service (list) – Restrict search to entries of one of these services (by service shortname or ID).
- category (list) – Restrict search to entries of one of these categories (by category shortname or ID).
- status (list) – Restrict search to entries of one of these statuses.
- priority (list) – Restrict search to entries with given priorties
- startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
- endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
- assetID (list) – Restrict search to cases associated with specified assets (hosts, services or processes)
- tag (list) – Restrict search to entries matching the given tag criteria.
- workflow (list) – Restrict search to entries matching the given workflow criteria.
- field (list) – Restrict search to entries matching the given field criteria.
- keywords (list) – Search for keywords.
- timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).
- timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
- keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
- keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
- userID (list) – Restrict search to cases associated with these users.
- userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).
- sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
- includeFlags (list) – Only include objects which have includeFlags set.
- excludeFlags (list) – Exclude objects which have excludeFlags set.
- includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
- exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
- required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
- userAssigned (bool) – If set, limit search to cases where assignedUser field is set/unset
- techAssigned (bool) – If set, limit search to cases where assignedTech field is set/unset
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 81, “limit”: 404, “responseCode”: 200, “count”: 636, “data”: [{“id”: 652, “initialStatus”: “pendingClose”, “status”: “pendingClose”, “initialPriority”: “low”, “priority”: “medium”, “subject”: “Course these team energy attorney.”, “description”: “However couple occur clearly outside member grow.”, “customerReference”: “Argue book realize economic.”, “accessMode”: “explicit”, “reporter”: {“id”: 463, “customerID”: 761, “userName”: “scotttorres”, “name”: “Maria Arias”}, “assignedUser”: {“id”: 183, “customerID”: 640, “userName”: “john89”, “name”: “Jeffrey Sanchez”}, “assignedTech”: {“id”: 280, “customerID”: 999, “userName”: “sandra75”, “name”: “Kevin Craig”}, “createdTimestamp”: 242354604, “createdByUser”: {“id”: 398, “customerID”: 367, “userName”: “noah83”, “name”: “Lucas Christensen”}, “lastUpdatedTimestamp”: 935263562, “lastUpdatedByUser”: {“id”: 826, “customerID”: 599, “userName”: “zjackson”, “name”: “Douglas Green”}, “closedTimestamp”: 460807023, “closedByUser”: {“id”: 463, “customerID”: 203, “userName”: “wperkins”, “name”: “Dan Mckinney”}, “publishedTimestamp”: 737814164, “publishedByUser”: {“id”: 845, “customerID”: 246, “userName”: “matthew90”, “name”: “Nicole Colon”}, “flags”: [“MAIL_UPDATE”], “properties”: {“additionalProperties”: “Difficult claim smile activity.”}}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Two administration under none language lose positive bank.”, “messageTemplate”: “Hit young capital bar especially matter usually include.”, “field”: “Machine data fire position however sea.”, “parameter”: {}, “timestamp”: 1156908994}], “currentPage”: 217, “size”: 182}
-
api.cases.v2.case.
change_access_settings
(caseID: int, accessMode: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Change general access settings (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- accessMode (str) – If set, this will alter the access mode of the case.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 895, “limit”: 269, “responseCode”: 200, “count”: 478, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Major operation share choice.”, “messageTemplate”: “Production star executive there.”, “field”: “Ground rock account program star approach several.”, “parameter”: {}, “timestamp”: 1308543028}], “currentPage”: 106, “size”: 179}
-
api.cases.v2.case.
close_case
(caseID: int, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Close an open case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- comment (str) – Closing comment to add to case. May use HTML, will be sanitized.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 622, “limit”: 581, “responseCode”: 200, “count”: 807, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Safe Republican region determine seem.”, “messageTemplate”: “Guy rise can two never.”, “field”: “Voice trip adult quickly tell.”, “parameter”: {}, “timestamp”: 1208754713}], “currentPage”: 499, “size”: 996}
-
api.cases.v2.case.
create_case
(service: str = None, category: str = None, type: str = None, status: str = None, watchers: list = None, fields: list = None, subject: str = None, description: str = None, customerReference: str = None, aclMembers: list = None, originEmailAddress: str = None, publish: bool = 'True', defaultWatchers: bool = 'True', priority: str = 'medium', accessMode: str = 'roleBased', customerID: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Create a new case defined by CaseCreateRequest (PUBLIC)
Return type: dict
Parameters: - service (str) – ID of service to create case for
- category (str) – If set, assign given category to new case (by category shortname).
- type (str) – Type of case to create
- status (str) – Status of case to create. If not set, system will select automatically.
- watchers (list) – Explicit watchers to add to this case.
- fields (list) – Fields to set on case creation. Fields in the policy for requested service and customer specifies fields available. If any of the fields in the policy are required on create, and do not have a default value,those fields must be set in the case create request, or the request will fail.
- subject (str) – Subject of case to create. => [sw{}$-().[]“‘_/,*+#:@!?;]*
- description (str) – Case description. May use HTML, which will be sanitized.
- customerReference (str) – Customer reference for case. => [sw{}$-().[]“‘_/,*+#:@!?;]*
- aclMembers (list) – Explicit ACL members to add to case.
- originEmailAddress (str) – If case is created from an email, specify origin email address here => format:email
- publish (bool) – Whether to publish new case. Creating an unpublished case requires special permission. (default true)
- defaultWatchers (bool) – Whether to enable default watchers for this case. If set to false, default watchers will not be enabled, and will not be notified upon creation of this case. (default true)
- priority (str) – Priority of case to create. (default medium)
- accessMode (str) – Access mode for new case. (default roleBased)
- customerID (int) – ID of customer to create case for (default 0)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 883, “limit”: 75, “responseCode”: 200, “count”: 719, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Fly leg recent your.”, “messageTemplate”: “Bed story drive night modern style successful.”, “field”: “Wonder step century magazine follow gas.”, “parameter”: {}, “timestamp”: 1328845163}], “currentPage”: 344, “size”: 270}
-
api.cases.v2.case.
current_user_watcher_status
(caseID: int, email: bool = 'False', sms: bool = 'False', verbose: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Query and set watcher status for the current user on this case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- email (bool) – If true, enable email notification for current user. If false, disable email. Default is no change.
- sms (bool) – If true, enable SMS notification for current user. If false, disable SMS. Default is no change.
- verbose (bool) – If set, explicitly set verbosity for watcher for enabled contact methods (will override default settings on current user)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 738, “limit”: 876, “responseCode”: 200, “count”: 345, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Top night model three else.”, “messageTemplate”: “Born respond across.”, “field”: “Range good issue leader right from.”, “parameter”: {}, “timestamp”: 605227340}], “currentPage”: 88, “size”: 247}
-
api.cases.v2.case.
delete_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Delete specified attachment from case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- attachmentID (str) – Attachment ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 908, “limit”: 338, “responseCode”: 200, “count”: 154, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Friend American town option.”, “messageTemplate”: “Answer mean measure girl service.”, “field”: “Recent candidate across common at between I.”, “parameter”: {}, “timestamp”: 1369623222}], “currentPage”: 449, “size”: 864}
-
api.cases.v2.case.
delete_case
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Mark existing case as deleted (PUBLIC)
Return type: dict
Parameters: caseID (int) – Case ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 200, “limit”: 816, “responseCode”: 200, “count”: 104, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Clearly smile it must.”, “messageTemplate”: “Region second appear medical simple opportunity could institution.”, “field”: “Condition soon forward red father.”, “parameter”: {}, “timestamp”: 1251190302}], “currentPage”: 816, “size”: 520}
-
api.cases.v2.case.
delete_case_link
(caseID: int, linkID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove existing case link (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- linkID (str) – Link ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 264, “limit”: 564, “responseCode”: 200, “count”: 708, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Follow wide purpose community eat.”, “messageTemplate”: “Spend radio begin son decade world picture.”, “field”: “Available imagine move rate add home perform.”, “parameter”: {}, “timestamp”: 337177742}], “currentPage”: 294, “size”: 158}
-
api.cases.v2.case.
delete_comment
(caseID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Mark existing comment as deleted (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- commentID (str) – Comment ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 404, “limit”: 611, “responseCode”: 200, “count”: 56, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Language law Democrat true international Mr service.”, “messageTemplate”: “Stay actually set.”, “field”: “Human ever which authority.”, “parameter”: {}, “timestamp”: 1099708826}], “currentPage”: 565, “size”: 776}
-
api.cases.v2.case.
download_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Download specific attachment contents. (PUBLIC) Returns data stream with the attachments mimetype, and attachment disposition with filename. Use /cases/v1/case/{caseID}/attachments/{attachmentID} to fetch metadata about this attachment.
Return type: dict
-
api.cases.v2.case.
edit_comment
(caseID: int, commentID: str, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Edit existing comment (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- commentID (str) – Comment ID
- comment (str) – Updated comment
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 584, “limit”: 216, “responseCode”: 200, “count”: 393, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Course again rule wear source.”, “messageTemplate”: “Sure research floor way spring.”, “field”: “Exactly pay make idea customer.”, “parameter”: {}, “timestamp”: 603695322}], “currentPage”: 779, “size”: 356}
-
api.cases.v2.case.
get_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch specific attachment metadata (PUBLIC) Use /cases/v1/case/{caseID}/attachments/{attachmentID}/download to download attachment contents.
Return type: dict
-
api.cases.v2.case.
get_case_comment
(caseID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Fetch specific comment (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- commentID (str) – Comment ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 780, “limit”: 173, “responseCode”: 200, “count”: 134, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Bag time social drive parent important.”, “messageTemplate”: “Our music prove conference effort read attention.”, “field”: “Hour improve mean indicate trade forward put.”, “parameter”: {}, “timestamp”: 383189345}], “currentPage”: 570, “size”: 831}
-
api.cases.v2.case.
get_case_metadata_by_id
(id: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Returns the basic case descriptor for the case identified by ID (PUBLIC)
Return type: dict
Parameters: id (int) – Case ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 421, “limit”: 956, “responseCode”: 200, “count”: 115, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Why take would number not Republican stay.”, “messageTemplate”: “Measure account upon baby sing.”, “field”: “Later think from drive door.”, “parameter”: {}, “timestamp”: 767750574}], “currentPage”: 860, “size”: 749}
-
api.cases.v2.case.
grant_access
(caseID: int, subjectID: int = None, level: str = 'read', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Grant access to a case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- subjectID (int) – ID of subject (user or group) to grant access to.
- level (str) – Level to grant for subject. (default read)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 204, “limit”: 333, “responseCode”: 200, “count”: 863, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Do language cost age ball fact leader.”, “messageTemplate”: “Much reduce act finish house coach network art.”, “field”: “See gun actually protect PM challenge.”, “parameter”: {}, “timestamp”: 37137633}], “currentPage”: 867, “size”: 464}
-
api.cases.v2.case.
list_case_a_c_l
(caseID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List ACL entries for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 849, “limit”: 903, “responseCode”: 200, “count”: 370, “data”: [{“id”: “Push tonight treatment live high.”, “addedTimestamp”: 74920002, “addedByUser”: {“id”: 972, “customerID”: 361, “userName”: “omccullough”, “name”: “Ashley Myers”}, “grantedSubject”: {“id”: 168, “customerID”: 395, “name”: “Matthew Jordan”}, “flags”: [“DELETED”], “level”: “read”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Spring spring year position personal.”, “messageTemplate”: “Without expert interest weight at authority computer reduce.”, “field”: “Environmental get hundred learn.”, “parameter”: {}, “timestamp”: 1513762389}], “currentPage”: 758, “size”: 488}
-
api.cases.v2.case.
list_case_attachments
(caseID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List attachments for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 426, “limit”: 252, “responseCode”: 200, “count”: 100, “data”: [{“id”: “Positive either field beat drive way stand phone.”, “addedTimestamp”: 487589842, “addedByUser”: {“id”: 333, “customerID”: 380, “userName”: “pjackson”, “name”: “Angel Monroe”}, “name”: “Deanna Shepard”, “mimeType”: “Recognize act energy woman heart nice summer.”, “flags”: [“ZIP_ENCRYPTED”], “size”: 875}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Around interest begin brother contain door him.”, “messageTemplate”: “Choice read we according smile.”, “field”: “Question candidate happen upon allow growth forget.”, “parameter”: {}, “timestamp”: 113321254}], “currentPage”: 865, “size”: 304}
-
api.cases.v2.case.
list_case_comments
(caseID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List comments for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 759, “limit”: 182, “responseCode”: 200, “count”: 674, “data”: [{“id”: “Building ten stop serious apply movie.”, “addedTimestamp”: 881326317, “addedByUser”: {“id”: 605, “customerID”: 548, “userName”: “hillnicholas”, “name”: “Eric Sharp”}, “comment”: “Training Mrs machine education choose office head.”, “reference”: “Green individual drive talk idea bar force.”, “flags”: [“UPDATED”], “status”: “pendingVendor”, “priority”: “critical”, “properties”: {“additionalProperties”: “Seek first particular share unit whom letter.”}}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Record receive particular yet idea worker.”, “messageTemplate”: “See instead few speak.”, “field”: “Party generation remember three season loss.”, “parameter”: {}, “timestamp”: 468446083}], “currentPage”: 977, “size”: 733}
-
api.cases.v2.case.
list_case_links
(caseID: int, direction: str = None, type: list = None, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List links for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- direction (str) – Specify direction of links to fetch (default all)
- type (list) – Specify link types to fetch (default all)
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 338, “limit”: 178, “responseCode”: 200, “count”: 714, “data”: [{“id”: “Floor spring western method likely draw decade relationship.”, “addedTimestamp”: 710326173, “addedByUser”: {“id”: 614, “customerID”: 57, “userName”: “fstephenson”, “name”: “Felicia Rodriguez”}, “flags”: [“DELETED”], “direction”: “incoming”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Apply wish six price fish.”, “messageTemplate”: “Nice organization him bag.”, “field”: “Sea buy week movie these behind skill dream.”, “parameter”: {}, “timestamp”: 1214095435}], “currentPage”: 256, “size”: 273}
List tags for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 700, “limit”: 989, “responseCode”: 200, “count”: 112, “data”: [{“id”: “Station message new when hold.”, “addedTimestamp”: 496078468, “addedByUser”: {“id”: 41, “customerID”: 107, “userName”: “cory94”, “name”: “William Nelson”}, “key”: “Large other art threat five.”, “value”: “Girl score seven.”, “flags”: [“DELETED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Water candidate provide general positive part hot.”, “messageTemplate”: “Front thing ability if anyone.”, “field”: “East three hold wife economic necessary enjoy.”, “parameter”: {}, “timestamp”: 367157301}], “currentPage”: 473, “size”: 267}
-
api.cases.v2.case.
list_case_watchers
(caseID: int, offset: int = 0, limit: int = 25, includeExplicit: bool = 'True', includeDefault: bool = 'True', includeDisabled: bool = 'True', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List watchers for an existing case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
- includeExplicit (bool) – Include explicit watchers (default true)
- includeDefault (bool) – Include default watchers (default true)
- includeDisabled (bool) – Include disabled watchers (default false)
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 634, “limit”: 21, “responseCode”: 200, “count”: 943, “data”: [{“id”: “Central beautiful buy PM.”, “addedTimestamp”: 1098578306, “addedByUser”: {“id”: 583, “customerID”: 21, “userName”: “michelle19”, “name”: “Evelyn Bean”}, “flags”: [“MERGED”], “subject”: {“id”: 674, “customerID”: 940, “name”: “Cindy Sutton”}, “contactID”: 560, “role”: “watcher”, “destination”: “National white together best cell memory role.”, “minimumPriority”: “low”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Test allow oil.”, “messageTemplate”: “Learn fire middle develop thank.”, “field”: “Bed born population focus question today question.”, “parameter”: {}, “timestamp”: 164151039}], “currentPage”: 326, “size”: 936}
-
api.cases.v2.case.
list_workflows
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ List workflows for an existing case (PUBLIC)
Return type: dict
Parameters: caseID (int) – Case ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 998, “limit”: 707, “responseCode”: 200, “count”: 743, “data”: [{“id”: “Feel total can of explain study during.”, “addedTimestamp”: 1319951070, “addedByUser”: {“id”: 752, “customerID”: 134, “userName”: “shealuke”, “name”: “Tara Phillips”}, “workflow”: “tuning”, “acknowledgedByUser”: {“id”: 965, “customerID”: 490, “userName”: “dale31”, “name”: “Parker Padilla”}, “acknowledgedTimestamp”: 403956353, “flags”: [“DELETED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Move popular everybody marriage important plant feel look.”, “messageTemplate”: “But structure point world nor entire throw.”, “field”: “Who seat good actually arrive view relate.”, “parameter”: {}, “timestamp”: 191404665}], “currentPage”: 750, “size”: 851}
-
api.cases.v2.case.
merge_cases
(mergeInto: int, mergeFrom: int, description: str = None, priority: str = None, status: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Merge two cases (PUBLIC) This will merge the contents of the mergeFrom case into the mergeInto case.The mergeFrom case will be marked as deleted/merged, and the mergeInto case will continue to exist, but with entries and attachments from the mergeFrom case embedded into it.If nothing else is specified, the status and priority of the mergeInto case will be retained.
Return type: dict
-
api.cases.v2.case.
move_case
(id: int, customerID: int = None, service: str = None, category: str = None, type: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Move a case to a differnet category, service or customer (PUBLIC)
Return type: dict
Parameters: - id (int) – Case ID
- customerID (int) – If set, move case to specified customer.
- service (str) – If set, move case to specified service.
- category (str) – If set, assign given category to specified category (by category shortname). Set value to empty string to unset category.
- type (str) – If set, move case to specified type.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 508, “limit”: 783, “responseCode”: 200, “count”: 922, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Color appear order five.”, “messageTemplate”: “Suggest commercial data understand.”, “field”: “Now significant position mind full.”, “parameter”: {}, “timestamp”: 1235410943}], “currentPage”: 99, “size”: 588}
-
api.cases.v2.case.
publish_case
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Publish existing case not marked as published (PUBLIC)
Return type: dict
Parameters: caseID (int) – Case ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 867, “limit”: 828, “responseCode”: 200, “count”: 128, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Compare second line present local.”, “messageTemplate”: “General visit certain past fall world also time.”, “field”: “Meeting inside production part majority.”, “parameter”: {}, “timestamp”: 1322832557}], “currentPage”: 766, “size”: 780}
-
api.cases.v2.case.
remove_access
(caseID: int, aclEntryID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Revoke access from a case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- aclEntryID (str) – ACL entry to revoke
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 156, “limit”: 886, “responseCode”: 200, “count”: 735, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Modern reduce effort you.”, “messageTemplate”: “Building place ten compare.”, “field”: “Big black worker expert.”, “parameter”: {}, “timestamp”: 820531731}], “currentPage”: 663, “size”: 172}
-
api.cases.v2.case.
remove_case_contact_watcher
(caseID: int, contactID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove a specific contact listed in the default watchers from watching this case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- contactID (int) – Contact ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 730, “limit”: 542, “responseCode”: 200, “count”: 38, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Drop responsibility six.”, “messageTemplate”: “Use send top.”, “field”: “Would money sea might even contain same hear.”, “parameter”: {}, “timestamp”: 173858444}], “currentPage”: 688, “size”: 332}
-
api.cases.v2.case.
remove_case_tag_by_id
(caseID: int, tagID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove existing tag (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- tagID (str) – Tag ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 193, “limit”: 150, “responseCode”: 200, “count”: 688, “data”: [{“id”: “Time environmental build help least.”, “addedTimestamp”: 617922040, “addedByUser”: {“id”: 39, “customerID”: 175, “userName”: “brandy86”, “name”: “Joseph Franklin”}, “key”: “Yourself continue bar alone similar summer.”, “value”: “Surface almost loss society so bad film.”, “flags”: [“DELETED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Especially serious dream size must improve thank.”, “messageTemplate”: “Like film draw.”, “field”: “Visit even operation.”, “parameter”: {}, “timestamp”: 854412977}], “currentPage”: 674, “size”: 370}
-
api.cases.v2.case.
remove_case_tag_by_key_value
(caseID: int, tagKey: str, tagValue: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove existing tag (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- tagKey (str) – Tag Key
- tagValue (str) – Tag Value
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 127, “limit”: 454, “responseCode”: 200, “count”: 941, “data”: [{“id”: “Main artist fear job commercial each.”, “addedTimestamp”: 1421670571, “addedByUser”: {“id”: 571, “customerID”: 785, “userName”: “zacharysalazar”, “name”: “Christina Crawford”}, “key”: “Sport conference hold hospital later real where.”, “value”: “Girl community way.”, “flags”: [“MERGED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Create determine friend scientist wait tell want method.”, “messageTemplate”: “Card unit program eight able discuss.”, “field”: “Work member point run suddenly quite beautiful response.”, “parameter”: {}, “timestamp”: 21395483}], “currentPage”: 682, “size”: 30}
-
api.cases.v2.case.
remove_case_watcher
(caseID: int, watcherID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove specific watcher from a case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- watcherID (str) – Watcher ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 572, “limit”: 892, “responseCode”: 200, “count”: 75, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Teach sit style war would treat.”, “messageTemplate”: “Political cover shake reason.”, “field”: “Conference always strategy law western.”, “parameter”: {}, “timestamp”: 779225580}], “currentPage”: 788, “size”: 613}
-
api.cases.v2.case.
remove_current_user_watcher
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Remove the current user from the watchlist of this case.If the currentuser is a contact, this will override the contact settings for the current user for this case. (PUBLIC)
Return type: dict
Parameters: caseID (int) – Case ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 783, “limit”: 547, “responseCode”: 200, “count”: 708, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “These fall want operation guy tell trade.”, “messageTemplate”: “Carry himself century still.”, “field”: “Miss around yard begin live.”, “parameter”: {}, “timestamp”: 1195491410}], “currentPage”: 438, “size”: 680}
-
api.cases.v2.case.
request_workflow
(caseID: int, workflow: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Request new workflow on case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- workflow (str) – Workflow to request
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 623, “limit”: 284, “responseCode”: 200, “count”: 259, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Everybody more care management raise vote.”, “messageTemplate”: “Protect animal eat service care.”, “field”: “Too do test talk physical himself increase stock.”, “parameter”: {}, “timestamp”: 1065045967}], “currentPage”: 438, “size”: 266}
-
api.cases.v2.case.
search_case_statistics
(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, caseID: list = None, type: list = None, service: list = None, category: list = None, status: list = None, priority: list = None, startTimestamp: int = None, endTimestamp: int = None, assetID: list = None, tag: list = None, workflow: list = None, field: list = None, keywords: list = None, timeFieldStrategy: list = None, timeMatchStrategy: str = None, keywordFieldStrategy: list = None, keywordMatchStrategy: str = None, userID: list = None, userFieldStrategy: list = None, groupBy: list = None, values: list = None, resolution: int = None, cutoff: int = None, cutoffValue: str = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', userAssigned: bool = 'False', techAssigned: bool = 'False', includeOthers: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Returns statistics data matching the defined CaseStatsSearchCriteria (PUBLIC)
Return type: dict
Parameters: - limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
- offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
- subCriteria (list) –
- customerID (list) – Restrict search to data belonging to specified customers.
- caseID (list) – Restrict search to specific cases (by ID).
- type (list) – Restrict search to entries of one of these types.
- service (list) – Restrict search to entries of one of these services (by service shortname or ID).
- category (list) – Restrict search to entries of one of these categories (by category shortname or ID).
- status (list) – Restrict search to entries of one of these statuses.
- priority (list) – Restrict search to entries with given priorties
- startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
- endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
- assetID (list) – Restrict search to cases associated with specified assets (hosts, services or processes)
- tag (list) – Restrict search to entries matching the given tag criteria.
- workflow (list) – Restrict search to entries matching the given workflow criteria.
- field (list) – Restrict search to entries matching the given field criteria.
- keywords (list) – Search for keywords.
- timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).
- timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
- keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
- keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
- userID (list) – Restrict search to cases associated with these users.
- userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).
- groupBy (list) – Specify which fields will be grouped by in stats
- values (list) – Specify which values will be included in stats (default created)
- resolution (int) – Stats resolution period in milliseconds, if is 0 means to generate non-timeline statistics
- cutoff (int) – Reduce stats keys to the cutoff amount of keys that has largest hit count, default 0 means no reduce
- cutoffValue (str) – Specify which value to be cutoff on (default created)
- sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
- includeFlags (list) – Only include objects which have includeFlags set.
- excludeFlags (list) – Exclude objects which have excludeFlags set.
- includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
- exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
- required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
- userAssigned (bool) – If set, limit search to cases where assignedUser field is set/unset
- techAssigned (bool) – If set, limit search to cases where assignedTech field is set/unset
- includeOthers (bool) – If reduce (cutoff>0), true means remaining keys (other than cutoff keys) are collected into an “other” key, default false
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 53, “limit”: 954, “responseCode”: 200, “count”: 686, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Effect answer interest guy base give amount.”, “messageTemplate”: “Move method exactly company enough theory.”, “field”: “Over century interest.”, “parameter”: {}, “timestamp”: 107558034}], “currentPage”: 367, “size”: 373}
-
api.cases.v2.case.
simple_case_search
(customerID: list = None, service: list = None, status: list = None, type: list = None, keywords: list = None, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Returns cases matching the query parameters (PUBLIC)
Return type: dict
Parameters: - customerID (list) – Limit result to specified customers
- service (list) – Limit result to specified services (service shortname)
- status (list) – Limit result to specified statuses
- type (list) – Limit result to specified types
- keywords (list) – Search by keywords
- offset (int) – Skip a number of results
- limit (int) – Maximum number of returned results
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 576, “limit”: 564, “responseCode”: 200, “count”: 283, “data”: [{“id”: 235, “initialStatus”: “workingSoc”, “status”: “closed”, “initialPriority”: “low”, “priority”: “high”, “subject”: “Paper hotel much goal matter.”, “description”: “Energy democratic fill question protect send.”, “customerReference”: “Student several for up fund certain against gun.”, “accessMode”: “explicit”, “reporter”: {“id”: 654, “customerID”: 319, “userName”: “samanthamiller”, “name”: “Timothy Taylor”}, “assignedUser”: {“id”: 951, “customerID”: 30, “userName”: “gponce”, “name”: “Richard Stevens”}, “assignedTech”: {“id”: 27, “customerID”: 221, “userName”: “agentry”, “name”: “Jessica Moore”}, “createdTimestamp”: 1213907281, “createdByUser”: {“id”: 379, “customerID”: 202, “userName”: “perezlynn”, “name”: “Philip House”}, “lastUpdatedTimestamp”: 1506896568, “lastUpdatedByUser”: {“id”: 351, “customerID”: 181, “userName”: “williamsterri”, “name”: “Samuel Robinson”}, “closedTimestamp”: 1380902467, “closedByUser”: {“id”: 927, “customerID”: 806, “userName”: “cisneroskristina”, “name”: “Reginald Ortiz”}, “publishedTimestamp”: 1356150744, “publishedByUser”: {“id”: 468, “customerID”: 550, “userName”: “cindy30”, “name”: “Mrs. Latoya Maldonado MD”}, “flags”: [“DEFAULT_CONTACTS”], “properties”: {“additionalProperties”: “Although fire ever set.”}}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Hotel stop long marriage western book very offer.”, “messageTemplate”: “Success plant recently eat simply.”, “field”: “Interest worker bar general different small.”, “parameter”: {}, “timestamp”: 895131212}], “currentPage”: 46, “size”: 33}
-
api.cases.v2.case.
update_case
(id: int, subject: str = None, description: str = None, status: str = None, priority: str = None, category: str = None, reporterID: int = None, assignedUserID: int = None, assignedTechID: int = None, customerReference: str = None, comment: str = None, originEmailAddress: str = None, internalComment: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Request changes to basic fields of an existing case (PUBLIC)
Return type: dict
Parameters: - id (int) – Case ID
- subject (str) – If set, change subject of case. => [sw{}$-().[]“‘_/,*+#:@!?;]*
- description (str) – If set, change description of case. May use HTML, will be sanitized.
- status (str) – If set, change status of case
- priority (str) – If set, change priority of case.
- category (str) – If set, assign given category to specified category (by category shortname). Set value to empty string to unset category.
- reporterID (int) – If set, set given user as reporter for case.
- assignedUserID (int) – If set, assign given user to case.
- assignedTechID (int) – If set, assign given technical user (solution engineer) to case.
- customerReference (str) – If set, change customer reference for case. => [sw{}$-().[]“‘_/,*+#:@!?;]*
- comment (str) – If set, add comment to case. May use HTML, will be sanitized.
- originEmailAddress (str) – If update is made from an email, specify origin email address here => format:email
- internalComment (bool) – If true, add comment as internal.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 961, “limit”: 11, “responseCode”: 200, “count”: 427, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Leave significant pick voice sign.”, “messageTemplate”: “Establish own before approach despite especially.”, “field”: “Difficult discuss later not everyone recently.”, “parameter”: {}, “timestamp”: 1006748879}], “currentPage”: 234, “size”: 755}
-
api.cases.v2.case.
update_case_watcher
(caseID: int, watcherID: str, verbose: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Update settings for a specific watcher on a case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- watcherID (str) – Watcher ID
- verbose (bool) – If set, will enable/disable verbose status for this watcher.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 377, “limit”: 747, “responseCode”: 200, “count”: 621, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Recognize record protect note.”, “messageTemplate”: “Hand finish successful Republican stand ok family.”, “field”: “Yard minute hold.”, “parameter”: {}, “timestamp”: 1432563888}], “currentPage”: 442, “size”: 750}
-
api.cases.v2.case.
update_watcher_settings
(caseID: int, defaultWatchers: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]¶ Update general watcher settings on a case (PUBLIC)
Return type: dict
Parameters: - caseID (int) – Case ID
- defaultWatchers (bool) – If set, will enable/disable use of default watchers on this case.
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 86, “limit”: 507, “responseCode”: 200, “count”: 453, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Stand city any focus throughout rich.”, “messageTemplate”: “Glass body kid help.”, “field”: “Message well always.”, “parameter”: {}, “timestamp”: 1173196018}], “currentPage”: 428, “size”: 704}
api.cases.v2.category module¶
Autogenerated API
api.cases.v2.service module¶
Autogenerated API
api.cases.v2.servicesubscription module¶
Autogenerated API