用于创建ServiceNow票证的Django包
django-snow的Python项目详细描述
安装
pip install django-snow
配置
django snow需要在django设置中设置以下设置:
- SNOW_INSTANCE-应该在其中创建票证的ServiceNow实例
- SNOW_API_USER-ServiceNow API用户
- SNOW_API_PASS-ServiceNow API用户密码
- SNOW_ASSIGNMENT_GROUP(可选)-应将票证分配给的组。 如果未提供此选项,则创建票证的每个调用都应提供一个赋值组参数。 有关详细信息,请参见API文档
- SNOW_DEFAULT_CHANGE_TYPE(可选)-默认更改请求类型。如果没有提供, 标准将被视为默认类型。
用法
创建
ChangeRequestHandler.create_change_request具有以下参数和返回值:
参数
- title-更改请求的标题
- description-更改请求的说明
- assignment_group-要将更改请求分配给的组。 这是可选的如果SNOW_ASSIGNMENT_GROUPdjango设置可用,则是必需的
- payload(可选)-用于创建更改请求的负载。
返回
ChangeRequestmodel-根据创建的变更单创建的模型。
示例
fromdjango_snow.helpersimportChangeRequestHandlerdefchange_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的负载。
示例
fromdjango_snow.modelsimportChangeRequestfromdjango_snow.helpersimportChangeRequestHandlerdefchange_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模型。
示例
fromdjango_snow.modelsimportChangeRequestfromdjango_snow.helpersimportChangeRequestHandlerdefchange_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的负载。
示例
fromdjango_snow.modelsimportChangeRequestfromdjango_snow.helpersimportChangeRequestHandlerdefchange_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-更改请求的系统ID。
- number-更改请求号。
- title-更改请求的标题,也就是简短的说明。
- 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'
支持的票证类型
- 更改请求