aboutsummaryrefslogtreecommitdiffstats
path: root/products/onap-dublin/features/vfc/src/main/resources/open-cli-schema/nslcm/vfc-nslcm-get-jobid.yaml
blob: d15cd5cb179a316911031472d4088e57ab106360 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Copyright (c) 2019, CMCC Technologies Co., Ltd.
# Licensed under the Apache License, Version 2.0 (the "License")
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

open_cli_schema_version: 1.0
name: vfc-nslcm-get-jobid
description: vfc nsclm get the jobid of  ns created job

info:
  product: onap-dublin
  service: vfc
  author: ONAP VFC Team (yangyanyj@chinamobile.com)

parameters:
  - name: ns-job-id
    description: ns job id
    type: string
    short_option: i
    long_option: ns-job-id
    is_optional: false

results:
  direction: portrait
  attributes:
    - name: ns-job-id
      description: ns job id
      scope: short
      type: string

    - name: job-status
      description: job status
      scope: short
      type: string

    - name: job-progress
      description: job progress
      scope: short
      type: string

http:
  service:
    auth: none
    mode: direct
  request:
    uri: /api/nslcm/v1/jobs/${ns-job-id}
    method: GET
    context:
      remove_empty_node: true
    body: '{}'
    headers:
      Content-Type: application/json
      Accept: application/json
  success_codes:
    - 200

  result_map:
    ns-job-id: $b{$.jobId}
    job-status: $b{$.responseDescriptor.status}
    job-progress: $b{$.responseDescriptor.progress}