添付ファイル API を使用して変更要求に添付ファイルを追加する
添付ファイル API を使用して、テストレポート XML を DevOps 変更要求に添付ファイルとして追加します。
API の詳細については、「 Attachment - POST /now/attachment/file」を参照してください。
添付ファイルの API URL は次のとおりです。
https://<your_instance>.service-now.com/api/now/attachment/file?table_name=change_request&table_sys_id=$(getServerChange.sys_id)&file_name=<attached_filename.xml>、ここで- table_name = 'change_request'
- table_sys_id = <chg record sys_id>
- file_name = 添付ファイルの任意の名前
Azure DevOps
前提条件
- [Web サービスへのアクセスのみ] オプションを選択してアクティブなユーザーを作成します。ユーザーの作成方法については、「 Create a user」を参照してください。
-
ユーザーに ロールsn_change_write を割り当てます。ロールのアサイン方法については、「 Assign a role to a user」を参照してください。
- システムプロパティ sn_devops.enable_ado_generic_connection を有効にする必要があります。
- Azure DevOpsプロジェクトを構成する際に、変更テーブルにアップロードするには、使用する汎用接続にsn_change_writeロールを持つユーザーが必要です。
Azure DevOpsパイプラインの場合は、ここに示す形式を使用して、変更要求に添付ファイルを追加します。
サンプルパイプライン:
stage: PostDeploy
jobs:
- job: 'pd1'
pool: server
steps:
- task: ServiceNow-DevOps-Server-Get-Change@1
inputs:
connectedServiceName: 'v01-Software Quality Scans-ServiceNow DevOps Service Connection'
projectName: '$(system.teamProject)'
pipelineName: '$(build.definitionName)'
stageName: 'Deploy'
jobName: 'd1'
buildNumber: '$(build.buildId)'
branchName: '$(Build.SourceBranchName)'
name: getServerChange
- task: InvokeRESTAPI@1
inputs:
connectionType: 'connectedServiceName'
serviceConnection: 'v01 - new'
method: 'POST'
body: '<root><name>john2</name><age>34</age></root>'
urlSuffix: 'api/now/attachment/file?table_name=change_request&table_sys_id=$(getServerChange.changeSysId)&file_name=test3.xml'
waitForCompletion: 'false'GitHub
GitHubパイプラインの場合は、ここに示す形式を使用して、変更要求に添付ファイルを追加します。
サンプルパイプライン:
Now インスタンスの変更要求フォームの添付ファイル:
Jenkins
Jenkinsパイプラインの場合は、ここに示す形式を使用して、変更要求に添付ファイルを追加します。
サンプルパイプライン:
pipeline {
agent any
stages {
stage('POST API Call') {
steps {
script {
def apiUrl = 'https://<your_instance>.service-now.com/api/sn_devops/v1/devops/tool/test?toolId=<devops_ToolId>&testType=Smoke'
def requestBody = [
name: "Smoke tests",
duration: 0.0,
passedTests: 1,
failedTests: 1,
skippedTests: 1,
blockedTests: 1,
totalTests: 4,
startTime: "2023-12-14T23:31:31z",
finishTime: "2023-12-15T23:31:31z",
buildNumber: env.BUILD_NUMBER,
stageName: "POST API Call",
pipelineName: "TestPipelineKL"
]
def auth = "<password>" // devops.integration.user:<password> in base64 encoded.
def authHeader = "Basic " + auth
def response = httpRequest(
contentType: 'APPLICATION_JSON',
httpMode: 'POST',
requestBody: groovy.json.JsonOutput.toJson(requestBody),
url: apiUrl,
customHeaders: [[name: 'Authorization', value: authHeader]]
)
if (response.status == 200 || response.status == 201) {
echo "API call successful!"
echo "Response: ${response.content}"
} else {
error "API call failed with status ${response.status}"
}
}
}
}
stage('UAT deploy') {
steps {
script {
def chg_output = snDevOpsChange()
def changeRequestNumber = snDevOpsGetChangeNumber(changeDetails: """{"build_number":"${env.BUILD_NUMBER}", "pipeline_name": "TestPipelineKL", "stage_name": "UAT deploy"}""")
echo "${changeRequestNumber}"
echo "Output of snDevOpsChange(): ${chg_output}"
}
}
}
stage('Example') {
steps {
script {
def API_URL = 'https://<your_instance>.service-now.com/api/sn_devops/devops/orchestration/changeInfo?pipelineName=TestPipelineKL&toolId=<devops_ToolId>&buildNumber=' + env.BUILD_NUMBER + '&stageName=UAT%20deploy'
def AUTH = 'Basic <password>'
// Call the API
def response = sh(script: "curl -X GET -H 'Authorization: ${AUTH}' -H 'Content-Type: application/json' '${API_URL}'", returnStdout: true).trim()
echo "Response: ${response}"
// Store the JSON response into a variable
def slurper = new groovy.json.JsonSlurper()
def jsonResponse = slurper.parseText(response)
echo "Stored JSON Response: ${jsonResponse}"
// Store the specific field value from JSON response into a variable
def changeId = jsonResponse.result.sys_id
echo "Change ID: ${changeId}"
// Call the second API to post attachment
def xmlData = '<root><name>john2</name><age>34</age></root>'
def AUTH2 = 'Basic <password>='
def postResponse = sh(script: "curl -X POST -H 'Authorization: ${AUTH2}' -H 'Content-Type: application/xml' -d '${xmlData}' 'https://<your_instance>.service-now.com/api/now/attachment/file?table_name=change_request&table_sys_id=${changeId}&file_name=test10111.xml'", returnStdout: true).trim()
}
}
}
}
}
添付ファイル API の制限事項
- 添付ファイルの xml ファイルのテキスト サイズは、オーケストレーション ツールで許容範囲内である必要があります。
- Azure DevOpsの場合、ファイルを変更レコードにアップロードするために、添付ファイル API の認証にsn_change_writeロールが必要です。