case#

Autogenerated API

argus_api.lib.cases.v2.case.abort_fragmented_upload(caseID: int, attachmentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Abort fragmented upload of an attachment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.abort_prepared_case(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Abort a prepared case. This removes the prepared (non-created) case entry from the database. (PUBLIC)

Parameters

  • caseID (int) – ID of prepared case

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.acknowledge_workflow(caseID: int, workflow: str, comment: str = None, publicComment: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Acknowledge workflow on case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • workflow (str) – Workflow to acknowledge

  • comment (str) – Optional acknowledgement comment to add. Html is allowed, will be sanitized.

  • publicComment (bool) – If true, the comment is marked as public, and is made visible to customer.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.add_attachment(caseID: int, name: str = None, mimeType: str = None, data: str = None, encryptedZip: bool = None, encryptedZipMode: str = None, encryptedZipPassword: str = None, originEmailAddress: str = None, notification: dict = None, internal: bool = None, prepared: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add new attachment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • name (str) – Name of attachment to add. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • mimeType (str) – MimeType for attachment to add. => Sanitize by regex [^ /]+/[^ /]+

  • data (str) – Attachment bytes

  • encryptedZip (bool) – DEPRECATED: This option is deprecated, use encryptedZipMode instead

  • encryptedZipMode (str) – If set to ‘server’, the server will zip-encrypt the file using encryptedZipPassword, and set the outer mimetype to application/zip.If set to ‘client’, the server will mark this attachment as already encrypted zip (document the password using property encryptedZipPassword). (default none)

  • encryptedZipPassword (str) – If encryptedZipMode is set, use this property to encrypt/document the password set on the zipfile. (default argus)

  • originEmailAddress (str) – If update is made from an email, specify origin email address here => format:email

  • notification (dict) –

  • internal (bool) – If set, the attachment will be marked as internal. This is only allowed by tech users. Internal attachements are only readable by tech users.

  • prepared (bool) – If set the attachment will be uploaded in a “prepared” state, in which they are not visible to other users until the connected comment is published. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Add link to case (PUBLIC)

Parameters

  • caseID (int) – ID of case to link from

  • linkToCaseID (int) – ID of case to link to

  • type (str) – Type of link to add

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.add_case_tag(caseID: int, tags: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add tag to case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • tags (list) – Add multiple tags as key/value strings or JSON objects

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.add_case_watcher(caseID: int, subjectID: int = None, type: str = None, userOrGroup: str = None, destination: str = None, verbose: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add watcher to case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • subjectID (int) –

  • type (str) – Type of watcher to add (default email)

  • userOrGroup (str) – User or group to add watcher for, by ID or shortname. Shortname will be resolved in current users domain.

  • destination (str) – Contact information to add as watcher (email address or phone number). If subject is specified, this is ignored.

  • verbose (bool) – If set, explicitly set verbosity for watcher (will override default settings on subject)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.add_comment(caseID: int, asReplyTo: str = None, comment: str = None, internal: bool = None, originEmailAddress: str = None, notification: dict = None, associatedAttachmentID: str = None, textFormat: str = None, status: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Submit new comment to case (PUBLIC)

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.

  • internal (bool) – If true, mark comment as internal, only visible to service techs. Default is false.

  • originEmailAddress (str) – If comment is added from an email, specify origin email address here. => format:email

  • notification (dict) –

  • associatedAttachmentID (list) – If set, associate this comment with the listed attachments.

  • textFormat (str) – Specify the text format of this comment. Setting plainText gives other consumers a hint that contents does not require a HTML renderer. (default html)

  • status (str) – If set, change the status of the case.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Returns cases matching the defined CaseSearchCriteria (PUBLIC)

Parameters

  • sortBy (list) –

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • caseID (list) – Restrict search to specific cases (by ID).

  • customer (list) – Restrict search to specific customers (by ID or shortname).

  • type (list) – Restrict search to entries of one of these types.

  • service (list) – DEPRECATED: This option is deprecated, use serviceCriteria instead.

  • serviceCriteria (dict) –

  • 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.

  • initialStatus (list) – Restrict search to entries where the initial status is one of these statuses.

  • priority (list) – Restrict search to entries with given priorties

  • initialPriority (list) – Restrict search to entries where the initial priority is one of these priorties

  • startTimestamp (str) – Restrict search to data after this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to data before this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • 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 all).

  • 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).

  • user (list) – Restrict search to cases associated with these users or user groups (by ID or shortname).

  • userID (list) – This field is deprecated. Use field ‘user’ instead.

  • userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).

  • 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

  • includeWorkflows (bool) – If true, include list of workflows in result. Default is false (not present).

  • includeDescription (bool) – If false, omit description from response. Default is true (description is present).

  • accessMode (list) – If set, only match cases which is set to one of these access modes

  • explicitAccess (list) – If set, only match cases which have explicit access grants matching the specified criteria

  • includeTestData (bool) – If true, also include cases marked as TEST_DATA in search result. This option is restricted to users with permission viewCaseTestData. Default is false (excluded).

  • productionCustomers (bool) – If set, apply a customer filter for customers marked as ‘not in production’. If true, EXCLUDE customers ‘not in production’. If false, REQUIRE customers ‘not in production’. Default is unset (no filter on production customers).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.cases.v2.case.answer_enquiry(caseID: int, enquiryID: str, answer: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Answer a case enquiry (DEV)

Parameters

  • caseID (int) – Case ID

  • enquiryID (str) – Enquiry ID

  • answer (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.change_access_settings(caseID: int, accessMode: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Change general access settings (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • accessMode (str) – If set, this will alter the access mode of the case.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.clear_field(caseID: int, field: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Clear specific field for a case, by either field ID or field name. For multivalue fields, the field may contain multiple values. (INTERNAL)

Parameters

  • caseID (int) – ID of the case to clear fields for

  • field (str) – ID or fieldName of the field to clear

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.close_case(caseID: int, comment: str = None, internalComment: bool = None, notification: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Close an open case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • comment (str) – Closing comment to add to case. May use HTML, will be sanitized.

  • internalComment (bool) – If true, mark comment as internal, only visible to service techs. Default is false.

  • notification (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.complete_fragmented_upload(caseID: int, attachmentID: str, sha256: str = None, notification: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Complete fragmented upload of an attachment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • sha256 (str) – The sha256 of the entire document.

  • notification (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.create_case(customerID: int = None, customer: str = None, service: str = None, category: str = None, type: str = None, status: str = None, watchers: dict = None, fields: dict = None, tags: dict = None, subject: str = None, description: str = None, customerReference: str = None, priority: str = None, accessMode: str = None, aclMembers: dict = None, notification: dict = None, originEmailAddress: str = None, triggers: dict = None, assignedUser: str = None, assignedTech: str = None, testData: bool = None, descriptionTextFormat: str = None, publish: bool = True, defaultWatchers: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a new case defined by CaseCreateRequest (PUBLIC)

Parameters

  • customerID (int) – DEPRECATED. Use customer instead

  • customer (str) – ID or shortname of customer to create case for. Defaults to current users customer

  • 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. Creating a new case with status closed is not permitted.

  • 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.

  • tags (list) – Tags to add on case creation.

  • subject (str) – Subject of case to create.

  • description (str) – Case description. May use HTML, which will be sanitized.

  • customerReference (str) – Customer reference for case.

  • priority (str) – Priority of case to create. (default medium)

  • accessMode (str) – Access mode for new case. (default roleBased)

  • aclMembers (list) – Explicit ACL members to add to case.

  • notification (dict) –

  • originEmailAddress (str) – If case is created from an email, specify origin email address here => format:email

  • triggers (dict) –

  • assignedUser (str) – If set, assign given user to case (by ID or shortname). Shortname will be resolved in the current users domain.

  • assignedTech (str) – If set, assign given technical user (solution engineer) to case (by ID or shortname). Shortname will be resolved in the current users domain.

  • testData (bool) – If true, this case will be marked as TEST_DATA. TEST_DATA cases are excluded from search results by default.

  • descriptionTextFormat (str) – Set the text format of the description. Setting plainText gives other consumers a hint that contents does not require a HTML renderer. (default html)

  • 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)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.create_enquiry(caseID: int, title: str = None, flowName: str = None, readRole: str = None, writeRole: str = None, querySchema: dict = None, queryLayout: dict = None, mandatory: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a new case enquiry (DEV)

Parameters

  • caseID (int) – Case ID

  • title (str) – Human readable title of the case enquiry => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • flowName (str) – Machine readable shortname to identify the case enquiry => [a-zA-Z0-9_:\-.]*

  • readRole (str) – Required role for read access to the case enquiry (default tech)

  • writeRole (str) – Required role for write access to the case enquiry (default tech)

  • querySchema (dict) –

  • queryLayout (list) – List of layout elements/widgets of this case enquiry

  • mandatory (bool) – Boolean flag that indicates whether the case enquiry is mandatory or not (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.create_prepared_case(caseID: int, customerID: int = None, customer: str = None, service: str = None, category: str = None, type: str = None, status: str = None, watchers: dict = None, fields: dict = None, tags: dict = None, subject: str = None, description: str = None, customerReference: str = None, priority: str = None, accessMode: str = None, aclMembers: dict = None, notification: dict = None, originEmailAddress: str = None, triggers: dict = None, assignedUser: str = None, assignedTech: str = None, testData: bool = None, descriptionTextFormat: str = None, publish: bool = True, defaultWatchers: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a prepared case. This finalizes the creation of the case prepared using /case/prepare (PUBLIC)

Parameters

  • caseID (int) – ID of prepared case

  • customerID (int) – DEPRECATED. Use customer instead

  • customer (str) – ID or shortname of customer to create case for. Defaults to current users customer

  • 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. Creating a new case with status closed is not permitted.

  • 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.

  • tags (list) – Tags to add on case creation.

  • subject (str) – Subject of case to create.

  • description (str) – Case description. May use HTML, which will be sanitized.

  • customerReference (str) – Customer reference for case.

  • priority (str) – Priority of case to create. (default medium)

  • accessMode (str) – Access mode for new case. (default roleBased)

  • aclMembers (list) – Explicit ACL members to add to case.

  • notification (dict) –

  • originEmailAddress (str) – If case is created from an email, specify origin email address here => format:email

  • triggers (dict) –

  • assignedUser (str) – If set, assign given user to case (by ID or shortname). Shortname will be resolved in the current users domain.

  • assignedTech (str) – If set, assign given technical user (solution engineer) to case (by ID or shortname). Shortname will be resolved in the current users domain.

  • testData (bool) – If true, this case will be marked as TEST_DATA. TEST_DATA cases are excluded from search results by default.

  • descriptionTextFormat (str) – Set the text format of the description. Setting plainText gives other consumers a hint that contents does not require a HTML renderer. (default html)

  • 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)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.current_user_watcher_status(caseID: int, email: bool = None, sms: bool = None, verbose: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Query and set watcher status for the current user on this case (PUBLIC)

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)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.delete_attachment(caseID: int, attachmentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete specified attachment from case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.delete_case(caseID: int, comment: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Mark existing case as deleted (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • comment (str) – Optional comment to add to the case as internal comment. Will be appended to associated events.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Remove existing case link (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • linkID (str) – Link ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.delete_comment(caseID: int, commentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Mark existing comment as deleted (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • commentID (str) – Comment ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.delete_enquiry(caseID: int, enquiryID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete a case enquiry (DEV)

Parameters

  • caseID (int) – Case ID

  • enquiryID (str) – Enquiry ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.download_attachment(caseID: int, attachmentID: str, inline: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → requests.models.Response#

Download specific attachment contents. (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • inline (bool) – Content Disposition Inline

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object

argus_api.lib.cases.v2.case.edit_comment(caseID: int, commentID: str, comment: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Edit existing comment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • commentID (str) – Comment ID

  • comment (str) – Updated comment

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_attachment(caseID: int, attachmentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch specific attachment metadata (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_case_comment(caseID: int, commentID: str, resolveLatest: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch specific comment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • commentID (str) – Comment ID

  • resolveLatest (bool) – If true, attempt to resolve latest version of comment, if it has been updated

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_case_comment_notifications(caseID: int, commentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch notifications recorded for specified comment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • commentID (str) – Comment ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_case_metadata_by_id(id: int, skipRedirect: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns the basic case descriptor for the case identified by ID (PUBLIC)

Parameters

  • id (int) – Case ID

  • skipRedirect (bool) – If true, skip automatic redirect (for merged cases)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_case_service(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns the service descriptor for the case identified by ID (PUBLIC)

Parameters

  • id (int) – Case ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_case_transaction(caseID: int, transactionID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a single case transaction transactions (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • transactionID (str) – Transaction ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_enquiry(caseID: int, enquiryID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetches a case enquiry (DEV)

Parameters

  • caseID (int) – Case ID

  • enquiryID (str) – Enquiry ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_field(caseID: int, field: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch specific field for a case, by either field ID or field name. For multivalue fields, the field may contain multiple values. (INTERNAL)

Parameters

  • caseID (int) – ID of the case to fetch fields for

  • field (str) – ID or fieldName of the field to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.get_field_policy_by_case(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch field policy for a specific case (INTERNAL)

Parameters

  • caseID (int) – ID of case to fetch policy for

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.grant_access(caseID: int, userOrGroup: str = None, subjectID: int = None, level: str = None, addWatcher: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Grant access to a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • userOrGroup (str) – ID or shortname of user or group to grant access to. Shortname will be resolved in current users domain.

  • subjectID (int) – This field is deprecated. Use field ‘userOrGroup’ instead.

  • level (str) – Level to grant for subject. (default read)

  • addWatcher (bool) – If true, also add the granted subject as watcher for this case. (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_a_c_l(caseID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : list_case_a_c_l is an alias for list_case_acl. Exists only for backward compatibility - do not use - use list_case_acl instead.

argus_api.lib.cases.v2.case.list_case_acl(caseID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List ACL entries for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_attachments(caseID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List attachments for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_comments(caseID: int, beforeComment: str = None, afterComment: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List comments for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • beforeComment (str) – Limit to comments before this comment ID (in sort order)

  • afterComment (str) – Limit to comments after this comment ID (in sort order)

  • sortBy (list) – Sort ordering. Default is addedTimestamp (ascending)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_history(caseID: int, type: str = None, operation: str = None, field: str = None, userID: int = None, user: str = None, transactionID: str = None, beforeTransaction: str = None, afterTransaction: str = None, startTimestamp: str = None, endTimestamp: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns the history of case transactions (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • type (list) – Transaction types to fetch

  • operation (list) – Include operations

  • field (list) – Include fields

  • userID (list) – Use the ‘user’ parameter instead

  • user (list) – Filter out transactions by specified users

  • transactionID (list) – Filter out specific transactions

  • beforeTransaction (str) – Limit to transactions before this transaction (in sort order)

  • afterTransaction (str) – Limit to transactions after this transaction (in sort order)

  • startTimestamp (str) – Limit to transactions after this timestamp

  • endTimestamp (str) – Limit to transactions before this timestamp

  • sortBy (list) – Sort ordering. Default is timestamp (ascending)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

List links for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • direction (str) – Specify direction of links to fetch (default all)

  • type (list) – Specify link types to fetch (default all)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_seen(caseID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List ‘last seen’ status for a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_tags(caseID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List tags for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_case_watchers(caseID: int, limit: int = 25, includeExplicit: bool = True, includeDefault: bool = True, offset: int = None, includeDisabled: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List watchers for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • limit (int) – Maximum number of returned results

  • includeExplicit (bool) – Include explicit watchers (default true)

  • includeDefault (bool) – Include default watchers (default true)

  • offset (int) – Skip a number of results

  • includeDisabled (bool) – Include disabled watchers (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_enquiries(caseID: int, state: str = None, includeFlags: str = None, excludeFlags: str = None, limit: int = 25, includeDeleted: bool = None, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetches case enquiries (DEV)

Parameters

  • caseID (int) – Case ID

  • state (list) – Filter enquiries by state

  • includeFlags (list) – Filter enquiries by include flags (all of the specified flags have to be present)

  • excludeFlags (list) – Filter enquiries by exclude flags (none of the specified flags have to be present)

  • limit (int) – Maximum amount of items to return (0 means no limit)

  • includeDeleted (bool) – Whether to include deleted enquiries

  • offset (int) – The amount of items to skip from the beginning

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_fields(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List fields on case. Each field represents a defined field which has a value set for this case. For multivalue fields, the field may contain multiple values. (INTERNAL)

Parameters

  • caseID (int) – ID of the case to fetch fields for

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_transaction_notifications(caseID: int, transactionID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns the notifications of a specified transaction (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • transactionID (str) – Transaction ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.list_workflows(caseID: int, includeDeleted: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List workflows for an existing case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • includeDeleted (bool) – If true, include deleted workflows

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.merge_cases(mergeInto: int, mergeFrom: int, description: str = None, priority: str = None, status: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Merge two cases (PUBLIC)

Parameters

  • mergeInto (int) – ID of case to merge into

  • mergeFrom (int) – ID of case to merge

  • description (str) – Case description of merged case. May use HTML, which will be sanitized. If not set, the description of both cases will be combined.

  • priority (str) – Priority of merged case. If not set, keep priority of mergeInto case.

  • status (str) – Status of merged case. If not set, keep status of mergeInto case.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.move_case(id: int, customerID: int = None, customer: str = None, service: str = None, category: str = None, type: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Move a case to a differnet category, service or customer (PUBLIC)

Parameters

  • id (int) – Case ID

  • customerID (int) – DEPRECATED. Use customer instead

  • customer (str) – If set, move case to specified customer (id or shortname).

  • service (str) – If set, move case to specified service (id or shortname).

  • category (str) – If set, assign given category to specified category (by category id or shortname). Set value to empty string to unset category.

  • type (str) – If set, move case to specified type.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.prepare_attachment_upload(caseID: int, name: str = None, mimeType: str = None, encryptedZip: bool = None, encryptedZipMode: str = None, encryptedZipPassword: str = None, originEmailAddress: str = None, internal: bool = None, prepared: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Prepare new fragmentedattachment upload (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • name (str) – Name of attachment to add. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • mimeType (str) – MimeType for attachment to add. => Sanitize by regex [^ /]+/[^ /]+

  • encryptedZip (bool) – DEPRECATED: This option is deprecated, use encryptedZipMode instead

  • encryptedZipMode (str) – If set to ‘server’, the server will zip-encrypt the file using encryptedZipPassword, and set the outer mimetype to application/zip.If set to ‘client’, the server will mark this attachment as already encrypted zip (document the password using property encryptedZipPassword). (default none)

  • encryptedZipPassword (str) – If encryptedZipMode is set, use this property to encrypt/document the password set on the zipfile. (default argus)

  • originEmailAddress (str) – If update is made from an email, specify origin email address here => format:email

  • internal (bool) – If set, the attachment will be marked as internal. This is only allowed by tech users. Internal attachements are only readable by tech users.

  • prepared (bool) – If set the attachment will be uploaded in a “prepared” state, in which they are not visible to other users until the connected comment is published. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.prepare_case(json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Prepare a new case object, to allow adding collections before properly creating it (PUBLIC)

Parameters

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.publish_case(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Publish existing case not marked as published (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.register_case_seen(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Register ‘last seen’ status for a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.reindex_case(caseID: int, refresh: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Force reindexing of case (INTERNAL)

Parameters

  • caseID (int) – Case ID

  • refresh (bool) – If true, force immediate refresh before returning

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.reject_enquiry(caseID: int, enquiryID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Reject a case enquiry (DEV)

Parameters

  • caseID (int) – Case ID

  • enquiryID (str) – Enquiry ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_access(caseID: int, aclEntryID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Revoke access from a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • aclEntryID (str) – ACL entry to revoke

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_case_contact_watcher(caseID: int, contactID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Remove a specific contact listed in the default watchers from watching this case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • contactID (int) – Contact ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_case_tag_by_id(caseID: int, tagID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Remove existing tag (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • tagID (str) – Tag ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_case_tag_by_key_value(caseID: int, tagKey: str, tagValue: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Remove existing tag (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • tagKey (str) – Tag Key

  • tagValue (str) – Tag Value

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_case_watcher(caseID: int, watcherID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Remove specific watcher from a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • watcherID (str) – Watcher ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.remove_current_user_watcher(caseID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

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)

Parameters

  • caseID (int) – Case ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.request_workflow(caseID: int, workflow: str, comment: str = None, externalReference: str = None, publicComment: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Request new workflow on case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • workflow (str) – Workflow to request

  • comment (str) – Optional comment to add. Html is allowed, will be sanitized.

  • externalReference (str) – Optional external reference to add. Should be a link or an issue number.

  • publicComment (bool) – If true, the comment is marked as public, and is made visible to customer.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.search_case_statistics(sortBy: str = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, caseID: int = None, customer: str = None, type: str = None, service: str = None, serviceCriteria: dict = None, category: str = None, status: str = None, initialStatus: str = None, priority: str = None, initialPriority: str = None, startTimestamp: str = None, endTimestamp: str = None, assetID: str = None, tag: dict = None, workflow: dict = None, field: dict = None, keywords: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, user: str = None, userID: int = None, userFieldStrategy: str = None, userAssigned: bool = None, techAssigned: bool = None, includeWorkflows: bool = None, includeDescription: bool = None, accessMode: str = None, explicitAccess: dict = None, includeTestData: bool = None, productionCustomers: bool = None, groupBy: str = None, values: str = None, resolution: int = None, resolutionUnit: str = None, cutoff: int = None, cutoffFields: dict = None, cutoffValue: str = None, includeOthers: bool = None, sortByField: str = None, sortByValue: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns statistics data matching the defined CaseStatsSearchCriteria (PUBLIC)

Parameters

  • sortBy (list) –

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • caseID (list) – Restrict search to specific cases (by ID).

  • customer (list) – Restrict search to specific customers (by ID or shortname).

  • type (list) – Restrict search to entries of one of these types.

  • service (list) – DEPRECATED: This option is deprecated, use serviceCriteria instead.

  • serviceCriteria (dict) –

  • 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.

  • initialStatus (list) – Restrict search to entries where the initial status is one of these statuses.

  • priority (list) – Restrict search to entries with given priorties

  • initialPriority (list) – Restrict search to entries where the initial priority is one of these priorties

  • startTimestamp (str) – Restrict search to data after this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to data before this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • 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 all).

  • 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).

  • user (list) – Restrict search to cases associated with these users or user groups (by ID or shortname).

  • userID (list) – This field is deprecated. Use field ‘user’ instead.

  • userFieldStrategy (list) – Defines which user fields will be searched (default match all user fields).

  • 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

  • includeWorkflows (bool) – If true, include list of workflows in result. Default is false (not present).

  • includeDescription (bool) – If false, omit description from response. Default is true (description is present).

  • accessMode (list) – If set, only match cases which is set to one of these access modes

  • explicitAccess (list) – If set, only match cases which have explicit access grants matching the specified criteria

  • includeTestData (bool) – If true, also include cases marked as TEST_DATA in search result. This option is restricted to users with permission viewCaseTestData. Default is false (excluded).

  • productionCustomers (bool) – If set, apply a customer filter for customers marked as ‘not in production’. If true, EXCLUDE customers ‘not in production’. If false, REQUIRE customers ‘not in production’. Default is unset (no filter on production customers).

  • 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 (unit specified by resolutionUnit), if is 0 means to generate non-timeline statistics

  • resolutionUnit (str) – Stats resolution period time unit. (default milliseconds)

  • cutoff (int) – This option is deprecated. Use cutoffFields instead.

  • cutoffFields (dict) – Reduce stats keys to max amount of distinct values per field. Fields which are not listed will not be reduced.

  • cutoffValue (str) – Specify which value to be cutoff on (default created)

  • includeOthers (bool) – If reduce (cutoff>0), true means remaining keys (other than cutoff keys) are collected into an “other” key, default false

  • sortByField (str) – If set, sort by this field. The returned field must be in the groupBy list. If not set, the container will be sorted by value.

  • sortByValue (str) – If set, sort by this value (descending by value). The specified value must be in the values list. If not set, it defaults to the first returned value. This field cannot be set if sortByField id set..

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.set_field(caseID: int, field: str, source: str = None, valuesToAdd: str = None, valuesToSet: str = None, valuesToRemove: str = None, value: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Set specific field for a case, by either field ID or field name. For multivalue fields, the field may contain multiple values. (INTERNAL)

Parameters

  • caseID (int) – ID of the case to set fields for

  • field (str) – ID or fieldName of the field to set

  • source (str) – An origin source string to set on the added value(s).

  • valuesToAdd (list) – Value to add to a multivalue field. Existing values will be retained. Singlevalue fields will reject requests using this parameter.

  • valuesToSet (list) – Value to set on a multivalue field. Existing values will be discarded. Singlevalue fields will reject requests using this parameter.

  • valuesToRemove (list) – Value to remove from a multivalue field. Singlevalue fields will reject requests using this parameter. May be the exact value, or reference using the value ID.

  • value (str) – Value to set on field. Multivalue fields will reject requests using this parameter.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Returns cases matching the query parameters (PUBLIC)

Parameters

  • customerID (list) – DEPRECATED. Use customer instead

  • customer (list) – Limit result to specified customers (by id or shortname)

  • 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

  • sortBy (list) – Sort order (see /cases/v2/case/search documentation for details)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.cases.v2.case.update_case(id: int, customerDueTimestamp: int = None, techDueTimestamp: int = None, subject: str = None, description: str = None, status: str = None, priority: str = None, category: str = None, reporter: str = None, assignedUser: str = None, assignedTech: str = None, customerReference: str = None, comment: str = None, notification: dict = None, originEmailAddress: str = None, hasEvents: bool = None, textFormat: str = None, internalComment: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Request changes to basic fields of an existing case (PUBLIC)

Parameters

  • id (int) – Case ID

  • customerDueTimestamp (int) –

  • techDueTimestamp (int) –

  • subject (str) – If set, change subject of case.

  • 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.

  • reporter (str) – If set, set given user as reporter for case (by ID or shortname). Shortname will be resolved in the current users domain.

  • assignedUser (str) – If set, assign given user to case (by ID or shortname). Shortname will be resolved in the current users domain. If blank, this will unset assignedUser.

  • assignedTech (str) – If set, assign given technical user (solution engineer) to case (by ID or shortname). Shortname will be resolved in the current users domain. If blank, this will unset assignedTech.

  • customerReference (str) – If set, change customer reference for case.

  • comment (str) – If set, add comment to case. May use HTML, will be sanitized.

  • notification (dict) –

  • originEmailAddress (str) – If update is made from an email, specify origin email address here => format:email

  • hasEvents (bool) – If set, update the hasEvents flag for this case, signalling that this case may have events associated to it.

  • textFormat (str) – Specify the text format of this comment. Setting plainText gives other consumers a hint that contents does not require a HTML renderer. (default html)

  • internalComment (bool) – If true, add comment as internal. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.update_case_watcher(caseID: int, watcherID: str, verbose: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update settings for a specific watcher on a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • watcherID (str) – Watcher ID

  • verbose (bool) – If set, will enable/disable verbose status for this watcher.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.update_watcher_settings(caseID: int, defaultWatchers: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update general watcher settings on a case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • defaultWatchers (bool) – If set, will enable/disable use of default watchers on this case.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.update_workflow(caseID: int, workflow: str, requestComment: str = None, acknowledgedComment: str = None, externalReference: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update workflow on case (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • workflow (str) – Workflow to update

  • requestComment (str) – If set, modify request comment. Html is allowed, will be sanitized. => format:html

  • acknowledgedComment (str) – If set, modify acknowledged comment. Html is allowed, will be sanitized. => format:html

  • externalReference (str) – If set, modify external reference. Should be a link or an issue number. Empty string will delete existing reference.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.upload_attachment_fragment(caseID: int, attachmentID: str, idx: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Upload fragment of an attachment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • attachmentID (str) – Attachment ID

  • idx (int) – Attachment Fragment Index

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.case.upload_streaming_attachment(caseID: int, filename: str, encryptedZip: bool = None, skipNotification: bool = None, originEmailAddress: str = None, encryptedZipMode: str = 'none', encryptedZipPassword: str = 'argus', json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add new attachment (PUBLIC)

Parameters

  • caseID (int) – Case ID

  • filename (str) – Attachment filename

  • encryptedZip (bool) – This option is deprecated, use encryptedZipMode instead

  • skipNotification (bool) – If true, skip notification

  • originEmailAddress (str) – If set, mark attachment with this origin email address

  • encryptedZipMode (str) – Use mode ‘client’ to mark attachment as an encrypted zipfile. Use mode ‘server’ to request server-side encryption

  • encryptedZipPassword (str) – Use this to document the password used for zip encryption

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON