---
swagger: "2.0"
info:
title: PublicReferenceDataManagement_Digital_Domain
description: '
Microservice name : PublicReferenceDataManagement_Digital_DomainPCF
deployment reference : AIM-D-PublicRefDataMgt-DGL-EM
'
version: 1.0.0
x-ibm-name: PublicReferenceDataManagement_Digital_Domain
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
/v1/emea/utilities/referenceData/{referenceCode}:
get:
summary: Retrieve all the possible values for CVT
description: This API provides all possible values for list of values/set of
permissible values to be used by other data fields. Developer can use same
to map screen LOV fields to all fields defined in API's. In field description
Indexes are defined for same.
tags:
- AnalyticsAndInformationManagement
parameters:
- name: referenceCode
in: path
description: Reference Code
type: string
required: true
- name: Authorization
in: header
description: Access token to authenticate your request.
type: string
required: true
- name: countryCode
in: header
description: Country code in 2 character ISO 3166 format.
required: true
type: string
- name: uuid
in: header
description: 128 bit random UUID generated uniquely for every request.
type: string
required: true
- name: Accept
in: header
description: Content-Type that are acceptable for the response.
type: string
required: true
- name: client_id
in: header
description: Client ID generated during application registration.
required: true
type: string
- name: clientDetails
in: header
description: Device and browser information. Refer the developer portal for
more information. Please ensure the header is base64 encoded
type: string
required: false
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/ReferenceDataTypeResponse'
400:
description: Type | Code | Details |
invalid | invalidRequest | Missing
or invalid parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: error | accessNotConfigured | The
requested operation is not configured to access this resource. | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: error | resourceNotFound | Empty
resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: fatal | serverUnavailable | The
request failed due to an internal error |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
ReferenceData:
properties:
referenceDataCode:
description: Reference data code associated with CVT
type: string
example: title
referenceDataValue:
description: Reference data Value associated with CVT
type: string
example: MR
referenceDataShortDescription:
description: Reference data Short description associated with CVT
type: string
example: MR
referenceDataLongDescription:
description: Reference data long description associated with CVT
type: string
example: MISTER
status:
description: Reference data status
type: string
example: active
ReferenceDataTypeResponse:
properties:
referenceDataDetails:
type: array
items:
$ref: '#/definitions/ReferenceData'
ErrorResponse:
properties:
type:
description: Invalid - Request did not confirm to the specification and was
unprocessed and rejected. Please fix the value and try again
enum:
- error
- warn
- invalid
- fatal
type: string
code:
description: Error code which qualifies the error
type: string
details:
description: Human readable explanation specific to the occurrence of the
problem
type: string
location:
description: The name of the field that resulted in the error
type: string
moreInfo:
description: URI to human readable documentation of the error
type: object
required:
- type
- code
x-ibm-configuration:
enforced: true
testable: true
phase: realized
securityDefinitions:
API Key(Query):
type: apiKey
description: ""
in: query
name: client_id
API Key:
type: apiKey
description: pv52735
in: header
name: X-IBM-Client-Id
security:
- API Key: []
- API Key(Query): []
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
description: Custom Gateway API Endpoint
type:
- production
- development
...