Services.GET.yaml 2.1 KB
Newer Older
1
description: This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure 
2
operationId: Services_GET
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
produces:
- application/json
parameters:
- $ref: '#/parameters/Query.Ser_instance_id'
- $ref: '#/parameters/Query.Ser_name'
- $ref: '#/parameters/Query.Ser_category_id'

responses:
  200:
    description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
    schema:
      type: array
      items:
        type: object
        properties:
          ServiceInfo:
19
20
21
            $ref: '#/definitions/ServiceInfo'
    examples:
      application/json:
22
        - ServiceInfo:
23
24
            serInstanceId: 'ServiceInstance123'
            serName: 'ExampleService'
25
            serCategory:
26
27
28
29
30
31
32
              href: 'catItem1'
              id: 'id12345'
              name: 'RNI'
              version: 'version1'
            version: 'ServiceVersion1'
            state: 'ACTIVE'
            transportId: 'Rest1'
33
            transportInfo:
34
35
36
37
38
              id: 'TransId12345'
              name: 'REST'
              description: 'REST API'
              type: 'REST_HTTP'
              protocol: 'HTTP'
39
40
41
              version: '2.0'
              endpoint:
                uris:
42
                - '/meMp1/service/EntryPoint'
43
44
                addresses:
                - host: '192.0.2.0'
45
                  port: 8080
46
47
              security:
                oAuth2Info:
48
49
50
                  grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                  tokenEndpoint: '/meMp1/security/TokenEndPoint'
            serializer: 'JSON'
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  400:
    description: Bad Request
    schema:
      type: object
      properties:
        ProblemDetails:
          $ref: '#/definitions/ProblemDetails'
  403:
    description: Forbidden
    schema:
      type: object
      required:
      - ProblemDetails
      properties:
        ProblemDetails:
          $ref: '#/definitions/ProblemDetails'
  404:
    description: Not Found
    schema:
      type: object
      properties:
        ProblemDetails:
          $ref: '#/definitions/ProblemDetails'