Jump to

• Request
• Response

Gets configuration properties such that all returned properties contain the property name provided in the input.

get

/config/property/v1

Gets configuration properties such that all returned properties contain the property name provided in the input. If there is no match to the input, then an empty propery array will be present in the output.

Request

Query Parameters

• locale: string
  This optional parameter can be provided in the input, if value of the property is desired in certain locale. If service implementation has value defined for that property in that locale then that value will be returned. If the locale os not provided or if locale specific value is not available for input property value, then property vale in default locale (en_US) will be retuned in the output.
• propertyName(required): string
  Name to search for configuration property. All properties that contain the input name are returned in the response.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success.

Body ()

Root Schema : ConfigPropertiesResponse

Type: array

Contains Congfig Properties that are returned from API.

Show Source

• Array of: object NameValSource
  Name-value and source of the property.

{
    "type":"array",
    "description":"Contains Congfig Properties that are returned from API.",
    "items":{
        "$ref":"#/components/schemas/NameValSource"
    }
}

Nested Schema : NameValSource

Type: object

Name-value and source of the property.

Show Source

• name(required): string
  Property name.
• source(required): string
  Where is property loaded from. This can be file(product files of service implementation), environment(where service is running) or database(persistent store used by the service).
• value(required): string
  Property Value String.

{
    "required":[
        "name",
        "source",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        },
        "source":{
            "type":"string",
            "description":"Where is property loaded from. This can be file(product files of service implementation), environment(where service is running)  or database(persistent store used by the service)."
        }
    },
    "description":"Name-value and source of the property."
}

406 Response

Incorrect Data.

Body ()

Root Schema : ConfigAPIResponse

Type: object

Show Source

• responseCode(required): string
• responseMessage(required): string

{
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Back to Top