跳转到主要内容

Django包,用于创建ServiceNow工单

项目描述

django-snow

Latest Version Test/build status Code coverage

django-snow 是一个django应用程序,用于在django项目中管理ServiceNow工单。

安装

pip install django-snow

配置

django-snow 需要在您的Django设置中设置以下设置

  • SNOW_INSTANCE - 应该创建工单的ServiceNow实例

  • SNOW_API_USER - ServiceNow API用户

  • SNOW_API_PASS - ServiceNow API用户的密码

  • SNOW_ASSIGNMENT_GROUP(可选)- 应将票分配到的组。如果没有提供,则应在创建票的每次调用中提供 assignment_group 参数。有关更多详细信息,请参阅API文档。

  • SNOW_DEFAULT_CHANGE_TYPE(可选)- 默认变更请求类型。如果没有提供,则将 standard 考虑为默认类型。

用法

创建

ChangeRequestHandler.create_change_request 具有以下参数和返回值

参数

  • title - 变更请求的标题

  • description - 变更请求的描述

  • assignment_group - 变更请求要分配到的组。如果 SNOW_ASSIGNMENT_GROUP django 设置可用,则此为 可选,否则为 必填

  • payload(可选)- 创建变更请求的负载。

返回

ChangeRequest 模型 - 从创建的变更订单创建的模型。

示例

from django_snow.helpers import ChangeRequestHandler

def change_data(self):
    co_handler = ChangeRequestHandler()
    change_request = co_handler.create_change_request('Title', 'Description', 'assignment_group')

更新

ChangeRequestHandler.update_change_request 方法签名

参数

  • change_request - 代表要更新的变更请求的 ChangeRequest 模型

  • payload - 要传递给ServiceNow REST API的负载。

示例

from django_snow.models import ChangeRequest
from django_snow.helpers import ChangeRequestHandler

def change_data(self):
    change_request = ChangeRequest.objects.filter(...)
    co_handler = ChangeRequestHandler()

    payload = {
                'description': 'updated description',
                'state': ChangeRequest.TICKET_STATE_IN_PROGRESS
              }

    co_handler.update_change_request(change_request, payload)

关闭

ChangeRequestHandler.close_change_request 具有以下签名

参数

  • change_request - 代表要关闭的变更订单的 ChangeRequest 模型

示例

from django_snow.models import ChangeRequest
from django_snow.helpers import ChangeRequestHandler

def change_data(self):
    change_request = ChangeRequest.objects.filter(...)
    co_handler = ChangeRequestHandler()

    co_handler.close_change_request(change_request)

带错误关闭

ChangeRequestHandler.close_change_request_with_error 方法签名

参数

  • change_request - 代表要带错误关闭的变更订单的 ChangeRequest 模型

  • payload - 要传递给ServiceNow REST API的负载。

示例

from django_snow.models import ChangeRequest
from django_snow.helpers import ChangeRequestHandler

def change_data(self):
    change_request = ChangeRequest.objects.filter(...)
    co_handler = ChangeRequestHandler()

    payload = {
                'description': 'updated description',
                'title': 'foo'
              }

    co_handler.close_change_request_with_error(change_request, payload)

模型

ChangeRequest

ChangeRequest 模型具有以下属性

  • sys_id - 变更请求的 sys_id。

  • number - 变更请求编号。

  • title - 变更请求的标题,即 short_description。

  • description - 变更请求的描述

  • assignment_group_guid - 变更请求分配到的组的GUID

  • state - 变更请求的状态。可以是以下 ChangeRequest 常量之一

    • TICKET_STATE_OPEN - ‘1’

    • TICKET_STATE_IN_PROGRESS - ‘2’

    • TICKET_STATE_COMPLETE - ‘3’

    • TICKET_STATE_COMPLETE_WITH_ERRORS - ‘4’

支持的票证类型

  • 变更请求

项目详细信息


下载文件

下载您平台上的文件。如果您不确定要选择哪个,请了解有关 安装包 的更多信息。

源分布

django-snow-1.2.0.tar.gz (9.4 kB 查看哈希值)

上传时间

支持者