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 = None, 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’: 389, ‘limit’: 243, ‘responseCode’: 200, ‘count’: 340, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Really fill once his shoulder second generation.’, ‘messageTemplate’: ‘Investment project coach ground.’, ‘field’: ‘Loss office production their.’, ‘parameter’: {}, ‘timestamp’: 210417303}], ‘currentPage’: 868, ‘size’: 319}
-
api.cases.v2.case.
add_attachment
(caseID: int, name: str = None, mimeType: str = None, data: str = None, encryptedZip: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Add new attachment (PUBLIC) Upload new attachment as JSON object with base64-encoded data :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type encryptedZip:bool
:type data:str
:type mimeType:str
:type name:str
:type caseID:int
param int caseID: Case ID param str name: Name of attachment to add. => [sw{}$-().[]“‘_/,*+#:@!?;]* param str mimeType: MimeType for attachment to add. => Sanitize by regex [^ /]+/[^ /]+ param str data: Attachment bytes param bool encryptedZip: If set, mark this attachment as an encrypted zip (should have password ‘argus’). NOTE: the service does not encrypt or zip the attachment, this should be done by the client. (default false) raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 raises ObjectNotFoundException: on 404 returns: {‘offset’: 914, ‘limit’: 137, ‘responseCode’: 200, ‘count’: 588, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Environmental myself note especially.’, ‘messageTemplate’: ‘Recognize do single western.’, ‘field’: ‘Before performance over.’, ‘parameter’: {}, ‘timestamp’: 644748327}], ‘currentPage’: 808, ‘size’: 299}
-
api.cases.v2.case.
add_case_link
(caseID: int, linkToCaseID: int, type: str = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 780, ‘limit’: 787, ‘responseCode’: 200, ‘count’: 427, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘View assume national building eat according interview tonight.’, ‘messageTemplate’: ‘Third second respond.’, ‘field’: ‘Professor trial school medical low us life.’, ‘parameter’: {}, ‘timestamp’: 425957160}], ‘currentPage’: 655, ‘size’: 922}
-
api.cases.v2.case.
add_case_tag
(caseID: int, tags: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 120, ‘limit’: 945, ‘responseCode’: 200, ‘count’: 316, ‘data’: [{‘id’: ‘After shoulder expect learn reflect prepare sister.’, ‘addedTimestamp’: 479061527, ‘addedByUser’: {‘id’: 978, ‘customerID’: 391, ‘userName’: ‘hfrench’, ‘name’: ‘Randall Potter’}, ‘key’: ‘No in these specific tree chair.’, ‘value’: ‘Since work act save but eat catch.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Wide meeting lot must debate government.’, ‘messageTemplate’: ‘Music word laugh film practice such when what.’, ‘field’: ‘Painting answer blood hard environmental.’, ‘parameter’: {}, ‘timestamp’: 1155652245}], ‘currentPage’: 953, ‘size’: 812}
-
api.cases.v2.case.
add_case_watcher
(caseID: int, subjectID: int = None, destination: str = None, type: str = 'email', verbose: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 851, ‘limit’: 675, ‘responseCode’: 200, ‘count’: 368, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Discussion real trade wrong.’, ‘messageTemplate’: ‘Response though well arm behavior they this.’, ‘field’: ‘Lay southern international place current treatment difference.’, ‘parameter’: {}, ‘timestamp’: 1346362915}], ‘currentPage’: 725, ‘size’: 725}
-
api.cases.v2.case.
add_comment
(caseID: int, asReplyTo: str = None, comment: str = None, originEmailAddress: str = None, internal: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 244, ‘limit’: 811, ‘responseCode’: 200, ‘count’: 97, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Newspaper language day guy.’, ‘messageTemplate’: ‘Then your however let follow.’, ‘field’: ‘Improve movie easy.’, ‘parameter’: {}, ‘timestamp’: 1112363513}], ‘currentPage’: 466, ‘size’: 552}
-
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 = None, exclude: bool = None, required: bool = None, userAssigned: bool = None, techAssigned: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 839, ‘limit’: 101, ‘responseCode’: 200, ‘count’: 68, ‘data’: [{‘id’: 781, ‘initialStatus’: ‘workingCustomer’, ‘status’: ‘pendingSoc’, ‘initialPriority’: ‘high’, ‘priority’: ‘low’, ‘subject’: ‘Social could society treatment somebody artist.’, ‘description’: ‘Put police begin expert value window improve.’, ‘customerReference’: ‘Similar career forget century she offer.’, ‘accessMode’: ‘readRestricted’, ‘reporter’: {‘id’: 142, ‘customerID’: 97, ‘userName’: ‘isaacrussell’, ‘name’: ‘Edgar Vance’}, ‘assignedUser’: {‘id’: 275, ‘customerID’: 192, ‘userName’: ‘branchmelanie’, ‘name’: ‘Sarah Andrews’}, ‘assignedTech’: {‘id’: 239, ‘customerID’: 320, ‘userName’: ‘darrylconner’, ‘name’: ‘Justin Craig’}, ‘createdTimestamp’: 121493929, ‘createdByUser’: {‘id’: 484, ‘customerID’: 238, ‘userName’: ‘michaelsmith’, ‘name’: ‘Francis Murillo’}, ‘lastUpdatedTimestamp’: 469689346, ‘lastUpdatedByUser’: {‘id’: 635, ‘customerID’: 768, ‘userName’: ‘psimpson’, ‘name’: ‘David Bush’}, ‘closedTimestamp’: 720542354, ‘closedByUser’: {‘id’: 236, ‘customerID’: 162, ‘userName’: ‘vaughancarlos’, ‘name’: ‘Eric Gonzalez’}, ‘publishedTimestamp’: 1125981800, ‘publishedByUser’: {‘id’: 957, ‘customerID’: 913, ‘userName’: ‘alison33’, ‘name’: ‘Tara Weaver’}, ‘flags’: [‘HAS_ATTACHMENT’], ‘properties’: {‘additionalProperties’: ‘Site per next operation.’}}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘More return help send star teacher available cut.’, ‘messageTemplate’: ‘Record least technology.’, ‘field’: ‘Drug beat firm that whatever order first.’, ‘parameter’: {}, ‘timestamp’: 1308258616}], ‘currentPage’: 273, ‘size’: 461}
-
api.cases.v2.case.
change_access_settings
(caseID: int, accessMode: str = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 925, ‘limit’: 580, ‘responseCode’: 200, ‘count’: 8, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Former sport ability direction.’, ‘messageTemplate’: ‘Stock when full especially discussion.’, ‘field’: ‘Major create consider talk plan among style.’, ‘parameter’: {}, ‘timestamp’: 599540245}], ‘currentPage’: 75, ‘size’: 395}
-
api.cases.v2.case.
close_case
(caseID: int, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 197, ‘limit’: 316, ‘responseCode’: 200, ‘count’: 816, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Good bar know suffer seek.’, ‘messageTemplate’: ‘Production establish really answer share tree Congress.’, ‘field’: ‘Great present else.’, ‘parameter’: {}, ‘timestamp’: 1011494538}], ‘currentPage’: 497, ‘size’: 398}
-
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 = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 875, ‘limit’: 163, ‘responseCode’: 200, ‘count’: 751, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Per people push create officer direction hard at.’, ‘messageTemplate’: ‘Tree everyone weight know condition sometimes remember.’, ‘field’: ‘Explain argue nation strategy guess.’, ‘parameter’: {}, ‘timestamp’: 1438119499}], ‘currentPage’: 42, ‘size’: 617}
-
api.cases.v2.case.
current_user_watcher_status
(caseID: int, email: bool = None, sms: bool = None, verbose: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 660, ‘limit’: 738, ‘responseCode’: 200, ‘count’: 455, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘At difference she woman.’, ‘messageTemplate’: ‘Sound future follow your the back home.’, ‘field’: ‘Dog trial majority.’, ‘parameter’: {}, ‘timestamp’: 628588417}], ‘currentPage’: 250, ‘size’: 567}
-
api.cases.v2.case.
delete_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 367, ‘limit’: 750, ‘responseCode’: 200, ‘count’: 110, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Cup drive most manager difference.’, ‘messageTemplate’: ‘Couple yes safe always simply something heart.’, ‘field’: ‘Guess president still total leg.’, ‘parameter’: {}, ‘timestamp’: 548962518}], ‘currentPage’: 908, ‘size’: 718}
-
api.cases.v2.case.
delete_case
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 763, ‘limit’: 545, ‘responseCode’: 200, ‘count’: 432, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Dinner audience war mean baby both nature another.’, ‘messageTemplate’: ‘Stop important able sometimes through.’, ‘field’: ‘Employee summer smile special.’, ‘parameter’: {}, ‘timestamp’: 806816402}], ‘currentPage’: 508, ‘size’: 257}
-
api.cases.v2.case.
delete_case_link
(caseID: int, linkID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 895, ‘limit’: 244, ‘responseCode’: 200, ‘count’: 458, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Once drive season west ever charge.’, ‘messageTemplate’: ‘Rich stay never rule sure news.’, ‘field’: ‘Sign color figure author can yet sit.’, ‘parameter’: {}, ‘timestamp’: 228754561}], ‘currentPage’: 343, ‘size’: 100}
-
api.cases.v2.case.
delete_comment
(caseID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 402, ‘limit’: 81, ‘responseCode’: 200, ‘count’: 553, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Must doctor sea all citizen authority walk.’, ‘messageTemplate’: ‘Policy beautiful blue grow whom issue meet.’, ‘field’: ‘Perhaps toward role each nothing week certainly.’, ‘parameter’: {}, ‘timestamp’: 545433885}], ‘currentPage’: 852, ‘size’: 251}
-
api.cases.v2.case.
download_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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. :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type attachmentID:str
:type caseID:int
param int caseID: Case ID param str attachmentID: Attachment ID raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 raises ObjectNotFoundException: on 404 returns: {}
-
api.cases.v2.case.
edit_comment
(caseID: int, commentID: str, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 446, ‘responseCode’: 200, ‘count’: 587, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Tell medical sing foreign reveal film.’, ‘messageTemplate’: ‘Actually pull shake follow time.’, ‘field’: ‘Over set thought exactly may western commercial four.’, ‘parameter’: {}, ‘timestamp’: 979042969}], ‘currentPage’: 908, ‘size’: 847}
-
api.cases.v2.case.
get_attachment
(caseID: int, attachmentID: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Fetch specific attachment metadata (PUBLIC) Use /cases/v1/case/{caseID}/attachments/{attachmentID}/download to download attachment contents. :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type attachmentID:str
:type caseID:int
param int caseID: Case ID param str attachmentID: Attachment ID raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 raises ObjectNotFoundException: on 404 returns: {‘offset’: 701, ‘limit’: 873, ‘responseCode’: 200, ‘count’: 906, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Dog through sing fly begin natural laugh they.’, ‘messageTemplate’: ‘Allow low news line.’, ‘field’: ‘Will no chance score nor late for.’, ‘parameter’: {}, ‘timestamp’: 1122867823}], ‘currentPage’: 917, ‘size’: 884}
-
api.cases.v2.case.
get_case_comment
(caseID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 145, ‘limit’: 998, ‘responseCode’: 200, ‘count’: 351, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Skin speech surface my feeling change there decide.’, ‘messageTemplate’: ‘Speak service drop agency.’, ‘field’: ‘Gun news item heavy board Mr edge major.’, ‘parameter’: {}, ‘timestamp’: 1357156381}], ‘currentPage’: 14, ‘size’: 840}
-
api.cases.v2.case.
get_case_metadata_by_id
(id: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 452, ‘limit’: 985, ‘responseCode’: 200, ‘count’: 414, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Feeling offer standard pattern support total early.’, ‘messageTemplate’: ‘Air lay measure effort everything stuff still.’, ‘field’: ‘Indeed pressure gas require.’, ‘parameter’: {}, ‘timestamp’: 148752906}], ‘currentPage’: 894, ‘size’: 641}
-
api.cases.v2.case.
grant_access
(caseID: int, subjectID: int = None, level: str = 'read', json: bool = True, verify: bool = True, apiKey: str = None, 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’: 134, ‘limit’: 351, ‘responseCode’: 200, ‘count’: 83, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Share job action.’, ‘messageTemplate’: ‘Five start itself few may either.’, ‘field’: ‘Break pretty opportunity either.’, ‘parameter’: {}, ‘timestamp’: 805365964}], ‘currentPage’: 199, ‘size’: 485}
-
api.cases.v2.case.
list_case_a_c_l
(caseID: int, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 504, ‘limit’: 107, ‘responseCode’: 200, ‘count’: 50, ‘data’: [{‘id’: ‘Question my color husband bring science enjoy.’, ‘addedTimestamp’: 1259856747, ‘addedByUser’: {‘id’: 807, ‘customerID’: 464, ‘userName’: ‘denise84’, ‘name’: ‘Kenneth Reeves’}, ‘grantedSubject’: {‘id’: 22, ‘customerID’: 202, ‘name’: ‘David Stevens’}, ‘flags’: [‘DELETED’], ‘level’: ‘owner’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Keep including carry never list give perhaps wind.’, ‘messageTemplate’: ‘Mean accept imagine ago full.’, ‘field’: ‘So often main which rest.’, ‘parameter’: {}, ‘timestamp’: 1378971088}], ‘currentPage’: 751, ‘size’: 346}
-
api.cases.v2.case.
list_case_attachments
(caseID: int, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 243, ‘limit’: 967, ‘responseCode’: 200, ‘count’: 612, ‘data’: [{‘id’: ‘Guess agreement once account pressure often particular.’, ‘addedTimestamp’: 240846390, ‘addedByUser’: {‘id’: 861, ‘customerID’: 549, ‘userName’: ‘heatherzhang’, ‘name’: ‘Francisco Morrison’}, ‘name’: ‘Cynthia Santana’, ‘mimeType’: ‘Drug protect five modern until according.’, ‘flags’: [‘ZIP_ENCRYPTED’], ‘size’: 814}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Involve room one here front man to.’, ‘messageTemplate’: ‘About already who discuss.’, ‘field’: ‘Trouble everyone place move could.’, ‘parameter’: {}, ‘timestamp’: 577713055}], ‘currentPage’: 543, ‘size’: 823}
-
api.cases.v2.case.
list_case_comments
(caseID: int, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 844, ‘limit’: 926, ‘responseCode’: 200, ‘count’: 698, ‘data’: [{‘id’: ‘Strong and loss matter others administration.’, ‘addedTimestamp’: 143631758, ‘addedByUser’: {‘id’: 319, ‘customerID’: 218, ‘userName’: ‘christinachang’, ‘name’: ‘Mary Stewart’}, ‘comment’: ‘Start chair goal environmental image per glass third.’, ‘reference’: ‘Mission face reveal record eight father might you.’, ‘flags’: [‘INTERNAL’], ‘status’: ‘workingCustomer’, ‘priority’: ‘medium’, ‘properties’: {‘additionalProperties’: ‘Soon pretty speak Congress remain own again.’}}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Leader probably little voice herself sea into executive.’, ‘messageTemplate’: ‘Explain store right agreement cost apply high pretty.’, ‘field’: ‘Discuss government process sign building interview.’, ‘parameter’: {}, ‘timestamp’: 41117217}], ‘currentPage’: 258, ‘size’: 17}
-
api.cases.v2.case.
list_case_links
(caseID: int, direction: str = None, type: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 535, ‘limit’: 214, ‘responseCode’: 200, ‘count’: 988, ‘data’: [{‘id’: ‘College newspaper stock authority thought.’, ‘addedTimestamp’: 975102894, ‘addedByUser’: {‘id’: 142, ‘customerID’: 618, ‘userName’: ‘blackwelltanya’, ‘name’: ‘Stephanie Brown’}, ‘flags’: [‘MERGED’], ‘direction’: ‘outgoing’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Able individual game however.’, ‘messageTemplate’: ‘Much need standard.’, ‘field’: ‘Shoulder value close nor.’, ‘parameter’: {}, ‘timestamp’: 1375968388}], ‘currentPage’: 356, ‘size’: 189}
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’: 891, ‘limit’: 862, ‘responseCode’: 200, ‘count’: 184, ‘data’: [{‘id’: ‘Pattern fast early best.’, ‘addedTimestamp’: 695948043, ‘addedByUser’: {‘id’: 736, ‘customerID’: 691, ‘userName’: ‘richard00’, ‘name’: ‘Mary Johns’}, ‘key’: ‘Simply wear yeah remain.’, ‘value’: ‘Head part mind decision.’, ‘flags’: [‘MERGED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Scientist down cultural media situation win participant.’, ‘messageTemplate’: ‘Month wrong bar future me peace what.’, ‘field’: ‘Everybody expect movie network question specific remain.’, ‘parameter’: {}, ‘timestamp’: 868981240}], ‘currentPage’: 567, ‘size’: 573}
-
api.cases.v2.case.
list_case_watchers
(caseID: int, offset: int = None, limit: int = 25, includeExplicit: bool = True, includeDefault: bool = True, includeDisabled: bool = True, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 286, ‘limit’: 952, ‘responseCode’: 200, ‘count’: 461, ‘data’: [{‘id’: ‘Among board set admit couple.’, ‘addedTimestamp’: 760141797, ‘addedByUser’: {‘id’: 229, ‘customerID’: 893, ‘userName’: ‘nataliejones’, ‘name’: ‘Cynthia Perkins’}, ‘flags’: [‘DELETED’], ‘subject’: {‘id’: 231, ‘customerID’: 123, ‘name’: ‘Brandon Lopez’}, ‘contactID’: 813, ‘role’: ‘watcher’, ‘destination’: ‘Fall serve they provide police budget.’, ‘minimumPriority’: ‘low’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘All for interview the son same treat.’, ‘messageTemplate’: ‘Toward worry cold different together claim.’, ‘field’: ‘Site necessary various nation.’, ‘parameter’: {}, ‘timestamp’: 449200271}], ‘currentPage’: 802, ‘size’: 268}
-
api.cases.v2.case.
list_workflows
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 667, ‘limit’: 45, ‘responseCode’: 200, ‘count’: 14, ‘data’: [{‘id’: ‘Skin will than authority city.’, ‘addedTimestamp’: 12217415, ‘addedByUser’: {‘id’: 171, ‘customerID’: 573, ‘userName’: ‘psimpson’, ‘name’: ‘Jennifer Murray’}, ‘workflow’: ‘tuning’, ‘acknowledgedByUser’: {‘id’: 938, ‘customerID’: 222, ‘userName’: ‘pamelaphelps’, ‘name’: ‘Daniel Preston’}, ‘acknowledgedTimestamp’: 1408504200, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Mother admit everything I vote likely beautiful.’, ‘messageTemplate’: ‘Several fund everything around plant second.’, ‘field’: ‘Price foreign will sea parent.’, ‘parameter’: {}, ‘timestamp’: 792575203}], ‘currentPage’: 402, ‘size’: 155}
-
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 = None, 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. :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type status:str
:type priority:str
:type description:str
:type mergeFrom:int
:type mergeInto:int
param int mergeInto: ID of case to merge into param int mergeFrom: ID of case to merge param str description: Case description of merged case. May use HTML, which will be sanitized. If not set, the description of both cases will be combined. param str priority: Priority of merged case. If not set, keep priority of mergeInto case. param str status: Status of merged case. If not set, keep status of mergeInto case. raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 returns: {‘offset’: 452, ‘limit’: 990, ‘responseCode’: 200, ‘count’: 929, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Network black ability whole.’, ‘messageTemplate’: ‘Body put adult grow.’, ‘field’: ‘Huge yes stage especially total various collection.’, ‘parameter’: {}, ‘timestamp’: 1375356575}], ‘currentPage’: 625, ‘size’: 265}
-
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 = None, 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’: 943, ‘limit’: 695, ‘responseCode’: 200, ‘count’: 436, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Grow pretty hundred happen.’, ‘messageTemplate’: ‘Beautiful prepare rest friend audience little.’, ‘field’: ‘Meeting teach same occur.’, ‘parameter’: {}, ‘timestamp’: 424671079}], ‘currentPage’: 206, ‘size’: 88}
-
api.cases.v2.case.
publish_case
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 793, ‘limit’: 866, ‘responseCode’: 200, ‘count’: 161, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Official teach project reality.’, ‘messageTemplate’: ‘For maybe color simply program production.’, ‘field’: ‘Seek career deal send hit summer policy international.’, ‘parameter’: {}, ‘timestamp’: 7128057}], ‘currentPage’: 174, ‘size’: 239}
-
api.cases.v2.case.
remove_access
(caseID: int, aclEntryID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 662, ‘limit’: 631, ‘responseCode’: 200, ‘count’: 257, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Arm finally anything thus scene.’, ‘messageTemplate’: ‘Speak north prevent far exactly personal when relate.’, ‘field’: ‘Wide blood blue field thousand.’, ‘parameter’: {}, ‘timestamp’: 863436746}], ‘currentPage’: 620, ‘size’: 701}
-
api.cases.v2.case.
remove_case_contact_watcher
(caseID: int, contactID: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 751, ‘limit’: 145, ‘responseCode’: 200, ‘count’: 981, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Require lot probably modern interest heavy mention.’, ‘messageTemplate’: ‘Bit interesting enjoy material as study wear.’, ‘field’: ‘Interview surface enjoy fear soon.’, ‘parameter’: {}, ‘timestamp’: 69939129}], ‘currentPage’: 331, ‘size’: 259}
-
api.cases.v2.case.
remove_case_tag_by_id
(caseID: int, tagID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 21, ‘limit’: 458, ‘responseCode’: 200, ‘count’: 202, ‘data’: [{‘id’: ‘Pass total every among produce other final.’, ‘addedTimestamp’: 494931411, ‘addedByUser’: {‘id’: 338, ‘customerID’: 93, ‘userName’: ‘joelkaiser’, ‘name’: ‘Chris Stuart’}, ‘key’: ‘Difference move man view bed offer short.’, ‘value’: ‘Attack professional cut apply under worker.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Number professor six executive history.’, ‘messageTemplate’: ‘Our fall personal sure economy.’, ‘field’: ‘Certain process view discuss same foot.’, ‘parameter’: {}, ‘timestamp’: 1235401959}], ‘currentPage’: 288, ‘size’: 604}
-
api.cases.v2.case.
remove_case_tag_by_key_value
(caseID: int, tagKey: str, tagValue: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 954, ‘limit’: 759, ‘responseCode’: 200, ‘count’: 988, ‘data’: [{‘id’: ‘Go science Republican body population continue over.’, ‘addedTimestamp’: 593106208, ‘addedByUser’: {‘id’: 219, ‘customerID’: 711, ‘userName’: ‘randy59’, ‘name’: ‘Eric Alvarez’}, ‘key’: ‘High hard series their.’, ‘value’: ‘Interview heavy dinner interview line.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Control base why miss real.’, ‘messageTemplate’: ‘Behind dinner weight next.’, ‘field’: ‘Upon choice poor cut add lead instead.’, ‘parameter’: {}, ‘timestamp’: 1368707931}], ‘currentPage’: 572, ‘size’: 58}
-
api.cases.v2.case.
remove_case_watcher
(caseID: int, watcherID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 592, ‘limit’: 493, ‘responseCode’: 200, ‘count’: 342, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Until good mother think argue run site.’, ‘messageTemplate’: ‘Away various common realize station usually.’, ‘field’: ‘Sometimes sport shake information occur course rather.’, ‘parameter’: {}, ‘timestamp’: 1442078934}], ‘currentPage’: 778, ‘size’: 606}
-
api.cases.v2.case.
remove_current_user_watcher
(caseID: int, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 200, ‘limit’: 196, ‘responseCode’: 200, ‘count’: 358, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Stage class prove drive physical kind.’, ‘messageTemplate’: ‘Property this than year top.’, ‘field’: ‘White fund high throughout individual role support later.’, ‘parameter’: {}, ‘timestamp’: 496265199}], ‘currentPage’: 143, ‘size’: 804}
-
api.cases.v2.case.
request_workflow
(caseID: int, workflow: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 751, ‘limit’: 640, ‘responseCode’: 200, ‘count’: 278, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Yeah remain matter black add scientist.’, ‘messageTemplate’: ‘Reality sit social.’, ‘field’: ‘Stand realize listen.’, ‘parameter’: {}, ‘timestamp’: 1096762214}], ‘currentPage’: 246, ‘size’: 461}
-
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 = None, exclude: bool = None, required: bool = None, userAssigned: bool = None, techAssigned: bool = None, includeOthers: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 225, ‘limit’: 414, ‘responseCode’: 200, ‘count’: 537, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘When for able.’, ‘messageTemplate’: ‘Fund court individual pay.’, ‘field’: ‘Much word American country determine agreement still crime.’, ‘parameter’: {}, ‘timestamp’: 1480699472}], ‘currentPage’: 783, ‘size’: 249}
-
api.cases.v2.case.
simple_case_search
(customerID: list = None, service: list = None, status: list = None, type: list = None, keywords: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 451, ‘limit’: 201, ‘responseCode’: 200, ‘count’: 723, ‘data’: [{‘id’: 173, ‘initialStatus’: ‘pendingCustomer’, ‘status’: ‘workingSoc’, ‘initialPriority’: ‘low’, ‘priority’: ‘low’, ‘subject’: ‘News set join during be nation table.’, ‘description’: ‘Through mind charge ten she behind appear.’, ‘customerReference’: ‘Seat indeed big its.’, ‘accessMode’: ‘writeRestricted’, ‘reporter’: {‘id’: 283, ‘customerID’: 738, ‘userName’: ‘ojohnson’, ‘name’: ‘Toni Williams’}, ‘assignedUser’: {‘id’: 117, ‘customerID’: 584, ‘userName’: ‘cruiz’, ‘name’: ‘Randall Rodriguez’}, ‘assignedTech’: {‘id’: 471, ‘customerID’: 316, ‘userName’: ‘lutzronald’, ‘name’: ‘Katie Graves’}, ‘createdTimestamp’: 1480647105, ‘createdByUser’: {‘id’: 150, ‘customerID’: 271, ‘userName’: ‘zachary25’, ‘name’: ‘Michael Santiago’}, ‘lastUpdatedTimestamp’: 1217090432, ‘lastUpdatedByUser’: {‘id’: 856, ‘customerID’: 800, ‘userName’: ‘traci46’, ‘name’: ‘Ryan Wright’}, ‘closedTimestamp’: 1374996013, ‘closedByUser’: {‘id’: 813, ‘customerID’: 141, ‘userName’: ‘kingjuan’, ‘name’: ‘Danielle Jenkins’}, ‘publishedTimestamp’: 633802212, ‘publishedByUser’: {‘id’: 220, ‘customerID’: 784, ‘userName’: ‘brianbullock’, ‘name’: ‘Rodney Williams’}, ‘flags’: [‘MERGED’], ‘properties’: {‘additionalProperties’: ‘Money color either political power among.’}}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Easy look white or special force beautiful raise.’, ‘messageTemplate’: ‘Difficult change bring personal.’, ‘field’: ‘Remember church benefit school.’, ‘parameter’: {}, ‘timestamp’: 438048570}], ‘currentPage’: 438, ‘size’: 413}
-
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 = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 693, ‘limit’: 839, ‘responseCode’: 200, ‘count’: 203, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Because southern action unit expert human.’, ‘messageTemplate’: ‘May control knowledge manage child.’, ‘field’: ‘Speak role in until.’, ‘parameter’: {}, ‘timestamp’: 481836162}], ‘currentPage’: 613, ‘size’: 897}
-
api.cases.v2.case.
update_case_watcher
(caseID: int, watcherID: str, verbose: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 958, ‘limit’: 661, ‘responseCode’: 200, ‘count’: 630, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Only evening stand item bring player management.’, ‘messageTemplate’: ‘Vote along whether.’, ‘field’: ‘Hard high dark just decide.’, ‘parameter’: {}, ‘timestamp’: 328133486}], ‘currentPage’: 974, ‘size’: 596}
-
api.cases.v2.case.
update_watcher_settings
(caseID: int, defaultWatchers: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 180, ‘limit’: 607, ‘responseCode’: 200, ‘count’: 367, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘She Republican little.’, ‘messageTemplate’: ‘Attorney learn challenge network morning Mrs.’, ‘field’: ‘Approach Mr authority involve thousand senior day.’, ‘parameter’: {}, ‘timestamp’: 726829059}], ‘currentPage’: 251, ‘size’: 129}
api.cases.v2.category module¶
Autogenerated API
api.cases.v2.service module¶
Autogenerated API
api.cases.v2.servicesubscription module¶
Autogenerated API