sap-jenkins-library/resources/metadata/integrationArtifactDownload.yaml

metadata:
  name: integrationArtifactDownload
  description: Download integration flow runtime artefact
  longDescription: |
    With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).

spec:
  inputs:
    secrets:
      - name: cpiApiServiceKeyCredentialsId
        description: Jenkins secret text credential ID containing the service key to the Process Integration Runtime service instance of plan 'api'
        type: jenkins
    params:
      - name: apiServiceKey
        type: string
        description: Service key JSON string to access the Process Integration Runtime service instance of plan 'api'
        scope:
          - PARAMETERS
        mandatory: true
        secret: true
        resourceRef:
          - name: cpiApiServiceKeyCredentialsId
            type: secret
            param: apiServiceKey
      - name: integrationFlowId
        type: string
        description: Specifies the ID of the Integration Flow artifact
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
      - name: integrationFlowVersion
        type: string
        description: Specifies the version of the Integration Flow artifact
        scope:
          - PARAMETERS
          - GENERAL
          - STAGES
          - STEPS
        mandatory: true
      - name: downloadPath
        type: string
        description: Specifies integration artifact download location.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`metadata:`
			`name: integrationArtifactDownload`
			`description: Download integration flow runtime artefact`
			`longDescription: \|`
Help document fixes (#2793) * byte code Fix * Help Url Fixes * Yaml Changes * Error Message changes Co-authored-by: Oliver Feldmann <oliver.feldmann@sap.com> 2021-04-30 09:43:25 +02:00			`With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00
			`spec:`
			`inputs:`
			`secrets:`
CPI- Refactor Credential ID (#2946) * Change credential name in yaml Change cpiAPIServiceKeyCredentialId to cpiApiServiceKeyCredentialsId in cpi yaml files * Refactor groovy files Change cpiAPIServiceKeyCredentialId to cpiApiServiceKeyCredentialsId in cpi groovy files * Change credential name in md Change cpiAPIServiceKeyCredentialId to cpiApiServiceKeyCredentialsId in cpi md files 2021-06-28 14:54:03 +02:00			`- name: cpiApiServiceKeyCredentialsId`
CPI - Improve serviceKey parameter name and description (#2958) * Make credential id name more descriptive * Improve serviceKey description * Change descriptions to add word service Co-authored-by: Linda Siebert <linda.siebert@sap.com> 2021-07-01 10:07:57 +02:00			`description: Jenkins secret text credential ID containing the service key to the Process Integration Runtime service instance of plan 'api'`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`type: jenkins`
			`params:`
CPI - Introduce service key (#2901) * Switch to service key for CPI GetMplStatus Introduces read method for service key files, mock utils and tests. * Use secret text instead of file * Change serviceKey definition * Update cpiUpload to use Service Key retrieved the host and uaa information from service key * Update cpiDeploy to use service key retrieved the host and uaa information from service key * Update cpiServiceEndpoint to use Service Key retrieved the host and uaa information from service key * Update cpiDownload to use Service Key retrieved the host and uaa information from service key * Update cpiUpdateConfig to use Service Key retrieved the host and uaa information from service key * Refactor serviceKey var name * Fixed references to service key to follow the real format they should be accessed through oauth instead of uaa because of the format of the json * Rename ServiceKey to APIServiceKey To support having a different service key(and for readability), we need to change the name to API. * Add STAGES and STEPS yaml add in to each yaml file of cpi integration * Revert "Add STAGES and STEPS yaml" This reverts commit aa2665d158b0f864cfee95ff999a7dc8ea3477f1. * Change comments/formatting commonUtils Make comments more understandable and follow code climate suggestions * Change documentation files for steps remove OAuth and host and change credentials to be servicekey Co-authored-by: Oliver Feldmann <oliver.feldmann@sap.com> Co-authored-by: Thorsten Duda <thorsten.duda@sap.com> 2021-06-28 10:50:33 +02:00			`- name: apiServiceKey`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`type: string`
CPI - Improve serviceKey parameter name and description (#2958) * Make credential id name more descriptive * Improve serviceKey description * Change descriptions to add word service Co-authored-by: Linda Siebert <linda.siebert@sap.com> 2021-07-01 10:07:57 +02:00			`description: Service key JSON string to access the Process Integration Runtime service instance of plan 'api'`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`scope:`
			`- PARAMETERS`
			`mandatory: true`
			`secret: true`
			`resourceRef:`
CPI- Change resourceRef of apiServiceKey (#2950) * Change name and param in yaml Change name and param in resourceRef of apiServiceKey param * Generate go code 2021-06-28 16:57:37 +02:00			`- name: cpiApiServiceKeyCredentialsId`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`type: secret`
CPI- Change resourceRef of apiServiceKey (#2950) * Change name and param in yaml Change name and param in resourceRef of apiServiceKey param * Generate go code 2021-06-28 16:57:37 +02:00			`param: apiServiceKey`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`- name: integrationFlowId`
			`type: string`
			`description: Specifies the ID of the Integration Flow artifact`
			`scope:`
			`- PARAMETERS`
			`- STAGES`
			`- STEPS`
			`mandatory: true`
			`- name: integrationFlowVersion`
			`type: string`
			`description: Specifies the version of the Integration Flow artifact`
			`scope:`
			`- PARAMETERS`
Put share cpi parameters in general scope (#2948) Co-authored-by: Thorsten Duda <thorsten.duda@sap.com> 2021-06-29 10:09:18 +02:00			`- GENERAL`
IntegrationArtifactDownload Command (#2587) * IntegrationArtifactDownload Command Co-authored-by: Marcus Holl <marcus.holl@sap.com> 2021-02-10 18:08:23 +02:00			`- STAGES`
			`- STEPS`
			`mandatory: true`
			`- name: downloadPath`
			`type: string`
			`description: Specifies integration artifact download location.`
			`scope:`
			`- PARAMETERS`
			`- STAGES`
			`- STEPS`
			`mandatory: true`