该文档提供有关需要从自定义脚本返回的JSON格式的信息。
一般格式
请求文件的类/脚本应返回一个具有成功/失败状态的JSON,并显示一条消息,该消息将显示在请求的“历史记录”选项卡中。 JSON具有以下格式:
{
"result":"success",
"message":"Message"
}
* 结果表示操作的成功/失败状态。
* 信息是将要显示在请求“历史记录”选项卡中的信息。
支持的操作
某些操作也可以使用该返回JSON执行。调用该操作的JSON结构如下:
{
"message": "Message",
"result": "success",
"operation": [
{
"OPERATIONNAME": "operation_1",
"INPUT_DATA": [
{
}
]
},
{
"OPERATIONNAME": "operation_2",
"INPUT_DATA": [
{
}
]
}
]
}
自定义触发器支持的一些操作如下:
* EDIT_REQUEST
* ADD_NOTE
* ADD_APPROVAL_STAGE
* ADD_APPROVAL
* SET_APPROVAL_STAGE
* SET_APPROVAL
EDIT_REQUEST JSON
更新请求中提到的字段。
{
"message": "Request Updated Successfully",
"result": "success",
"operation": [
{
"OPERATIONNAME": "EDIT_REQUEST",
"INPUT_DATA": [
{
"Asset": "sdp-mac-2",
"Technician": "Heather Graham",
"RequestTempate": "New Hire",
"Job Type": "Developer",
"Experience": "3 years"
}
]
}
]
}
此处列出的所有输入参数都可以通过这种方式进行更新。
ADD_NOTE JSON
为请求添加注释。
{
"result": "success",
"message": "Note Added Successfully",
"operation": [
{
"OPERATIONNAME": "ADD_NOTE",
"INPUT_DATA": [
{
"notes": {
"notesText": "Sample Text"
}
}
]
}
]
}
ADD_APPROVAL_STAGE JSON
除了现有的审批人集之外,还为上述阶段添加新的审批人。
触发第一阶段的审批由send_immediatelyly参数控制。 设置为true时,审批请求将立即发送。 设置为false时,用户必须手动发送审批请求。
{
"message": "Sample Python script for adding new approvers for all stages, in addition to the existing approvers",
"result": "success",
"operation": [
{
"OPERATIONNAME": "ADD_APPROVAL_STAGE",
"send_immediately": "true",
"INPUT_DATA": [
{
"StageOne": [
"Sampleuser.1@xyz.com",
"Sampleuser.2@xyz.com"
]
},
{
"StageTwo": [
"Sampleuser.3@xyz.com",
"Sampleuser.4@xyz.com"
]
},
{
"StageThree": [
"Sampleuser.5@xyz.com",
"Sampleuser.6@xyz.com"
]
},
{
"StageFour": [
"Sampleuser.7@xyz.com",
"Sampleuser.8@xyz.com"
]
},
{
"StageFive": [
"Sampleuser.9@xyz.com",
"Sampleuser.10@xyz.com"
]
}
]
}
]
}
ADD_APPROVAL JSON
除了现有的审批人集之外,还为现阶段添加新的审批人。
触发该阶段的审批由send_immediatelyly参数控制。 设置为true时,审批请求将立即发送。 设置为false时,用户必须手动发送审批请求。
{
"message": "Sample Python script for adding new approvers in current stage, in addition to the existing approvers",
"result": "success",
"operation": [
{
"OPERATIONNAME": "ADD_APPROVAL",
"send_immediately": "true",
"INPUT_DATA": [
"Sampleuser.1@xyz.com",
"Sampleuser.3@xyz.com",
"Sampleuser.5@xyz.com"
]
}
]
}
SET_APPROVAL_STAGE JSON
在添加新的审批人之前,请在删除上述阶段中现有的审批人集。 已经批准的审批人不会从审批人列表中删除。
触发第一阶段的审批由send_immediatelyly参数控制。 设置为true时,审批请求将立即发送。 设置为false时,用户必须手动发送审批请求。
{
"message": "Sample Python script for adding new approvers for all stages, in addition to the existing approvers",
"result": "success",
"operation": [
{
"OPERATIONNAME": "SET_APPROVAL_STAGE",
"send_immediately": "true",
"INPUT_DATA": [
{
"StageOne": [
"Sampleuser.1@xyz.com",
"Sampleuser.2@xyz.com"
]
},
{
"StageTwo": [
"Sampleuser.3@xyz.com",
"Sampleuser.4@xyz.com"
]
},
{
"StageThree": [
"Sampleuser.5@xyz.com",
"Sampleuser.6@xyz.com"
]
},
{
"StageFour": [
"Sampleuser.7@xyz.com",
"Sampleuser.8@xyz.com"
]
},
{
"StageFive": [
"Sampleuser.9@xyz.com",
"Sampleuser.10@xyz.com"
]
}
]
}
]
}
SET_APPROVAL JSON
删除在当前阶段现有的审批人集,并添加新的审批人。 已经批准的审批人不会从审批人列表中删除。
触发此阶段的审批是由send_inmediatelyly参数控制的。 设置为true时,审批请求将立即发送。 设置为false时,用户必须手动发送审批请求。
{
"message": "Sample Python script for adding new approvers in current stage, in addition to the existing approvers",
"result": "success",
"operation": [
{
"OPERATIONNAME": "SET_APPROVAL",
"send_immediately": "true",
"INPUT_DATA": [
"Sampleuser.1@xyz.com",
"Sampleuser.3@xyz.com",
"Sampleuser.5@xyz.com"
]
}
]
}