Fügen Sie Change-Anforderungen mithilfe der Anhang-API Anhänge hinzu

Fügen Sie Testbericht-XMLS als Anhänge zu DevOps-Change-Anforderungen mithilfe der Anhang-API hinzu.

Weitere Informationen zur API finden Sie unter Attachment - POST /now/attachment/file.

Die Anhang-API-URL lautet:

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> , Wo

• Table_Name = 'Change_Request'
• Table_sys_ID = <SYS_ID des chg-Datensatzes>
• File_Name = beliebiger Name für den Anhang

Azure DevOps

Voraussetzungen

• Erstellen Sie einen aktiven Anwender mit der Option Nur Webservice-Zugriff Ausgewählt. Informationen zum Erstellen eines Anwenders finden Sie unter Create a user.

• Weisen Sie die Rolle zu sn_Change_write An den Anwender. Informationen zum Zuweisen der Rolle finden Sie unter Assign a role to a user.

  

• Die Systemeigenschaft sn_devops.enable_ADO_generic_connection Muss aktiviert sein.
• Beim Konfigurieren von Azure DevOps Projekt, zum Hochladen in chg. Tabelle muss für die verwendete generische Verbindung ein Anwender mit der Rolle vorhanden sein sn_Change_write .

Für Azure DevOps Pipelines verwenden Sie das hier angegebene Format, um Anhänge zu Change-Anforderungen hinzuzufügen.

Beispiel-Pipeline:

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

Für GitHub Pipelines verwenden Sie das hier angegebene Format, um Anhänge zu Change-Anforderungen hinzuzufügen.

Beispiel-Pipeline:

Anhang im Formular „Change-Anforderung“ in der Now-Instanz :

Jenkins

Für Jenkins Pipelines verwenden Sie das hier angegebene Format, um Anhänge zu Change-Anforderungen hinzuzufügen.

Beispiel-Pipeline:

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()
                }
            }
        }
    }
}

Einschränkungen der Anhang-API

• Die Textgröße der Anhang-XML-Datei muss für das Orchestration-Tool akzeptabel sein.
• Für Azure DevOps, sn_change_writeDie Rolle ist für die Authentifizierung der Anhang-API erforderlich, um die Datei in den Change-Datensatz hochzuladen.