Tickets (risksense_api.__subject.__ticket.__ticket)

Ticket module defined for different ticket related api endpoints.

class risksense_api.__subject.__ticket.__ticket.Ticket(profile)[source]

Bases: Subject

Class for ticket function definitions.

Parameters:

profile (object) – Profile Object

To utlise ticket function:

Usage:

self.{risksenseobjectname}.ticket.{function}

Examples

To get connector fields for a ticket using getconnectorfields() function

>>> self.{risksenseobjectname}.ticket.getconnectorfields(args)
__init__(profile)[source]

Initialization of Ticket object.

Parameters:

profile (object) – Profile Object

getconnectorfields(connector_id, client_id=None)[source]

Get connector fields present in ticket form

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.getconnectorfields(123,client_id=123)
gettemplateid(connector_id, client_id=None)[source]

Get available templates

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.gettemplateid(123,client_id=123)
getfieldsfromtemplateid(connector_id, template_id, client_id=None)[source]

Get fields available for a particular template

Parameters:

  • connector_id (int) – Connector Id

  • template_id (int) – Template Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.getfieldsfromtemplateid(123,123,client_id=123)
getcatalogitemfield(connector_id, client_id=None)[source]

Get fields available for a particular catalog item

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.getcatalogitemfield(123,client_id=123)
getissuetypefield(connector_id, client_id=None)[source]

Get available issue types

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.getissuetypefield(123,client_id=123)
getticketinfo(ticket_id, client_id=None)[source]

Get info about a ticket

Parameters:

  • ticket_id (str) – Ticket Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.getticketinfo('TP-123',client_id=123)
deleteticket(ticket_uuid, client_id=None)[source]

Delete ticket

Parameters:

  • ticket_uuid (str) – Ticket UUID

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

bool

Returns:

Deletion status

Examples

>>> apiobj = self.{risksenseobject}.ticket.getconnectorfields('123-456',client_id=123)
create_ticket(tag_id, body, client_id=None)[source]

Create a ticket

Parameters:

  • tag_id (int) – Tag Id

  • body (dict) – API request ticket body

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Note

Intercept this API endpoint /client/{clientId}/ticket/{tag_id} in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

ivanti_itsm_fetch_ticketField_values(connector_id, client_id=None)[source]

Fetch ticket field values for Ivanti ITSM

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_fetch_ticketField_values(123,client_id=123)
ivanti_itsm_retrieve_ticketFields(connector_id, ticket_type, client_id=None)[source]

Retrieve ticket fields for Ivanti ITSM

Parameters:

  • connector_id (int) – Connector Id

  • ticket_type (str) – Type of the ticket to be created.

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_retrieve_ticketFields(123,'incident',client_id=123)
ivanti_itsm_fetch_customers(connector_id, client_id=None)[source]

Fetch available customers for Ivanti ITSM

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_fetch_customers(123,client_id=123)
ivanti_itsm_fetch_fieldValue_wrt_dependentField(ticket_type, connector_id, current_field, dependent_field, dependent_field_value, client_id=None)[source]

Fetch available options for a current Ivanti ITSM field with respect to its dependent Ivanti ITSM field

Parameters:

  • ticket_type (str) – Ticket type

  • connector_id (int) – Connector Id

  • current_field (str) – Field name key of the field to be queried for

  • dependent_field (str) – Dependent field name key

  • dependent_field_value (str) – Value of the dependent field

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_fetch_fieldValue_wrt_dependentField('incident',123,'category','status','test',client_id=123)
ivanti_itsm_fetch_validation(body, client_id=None)[source]

Form validation for ivanti ITSM

Parameters:

  • body (dict) – API request ticket body

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID

Return type:

dict

Returns:

Jsonified response

Note

Intercept this API endpoint /client/{clientId}/connector/{connectorId}/ivanti/formValidation in UI to better understand the body that need to be sent using this function. Then, use this function in your automation.

ivanti_itsm_fetch_releaseLink(connector_id, client_id=None)[source]

Fetch available release links for Ivanti ITSM

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_fetch_releaseLink(123,client_id=123)
ivanti_itsm_fetch_requestorLink(connector_id, client_id=None)[source]

Fetch available requestor links for Ivanti ITSM

Parameters:

  • connector_id (int) – Connector Id

  • client_id (typing.Optional[list]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

Jsonified response

Examples

>>> apiobj = self.{risksenseobject}.ticket.ivanti_itsm_fetch_requestorLink(123,client_id=123)