Get a configuration
get
/services/rest/connect/v1.4/configurations/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the configuration.
Response
Default Response
Root Schema : configurations
Type:
object
The information about the configuration settings within Oracle B2C Service.
Show Source
-
createdTime:
string
The date and time when the configuration was created. This attribute is read-only.
-
dataType:
object namedIDs-configurations-dataType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the configuration. -
lookupName:
string
Maximum Length:
255
The name used to look up the configuration. -
name:
string
Maximum Length:
120
Pattern:^[a-zA-Z]([0-9A-Za-z_]*)$
The name of the configuration. -
updatedTime:
string
The date and time when the configuration was last updated. This attribute is read-only.
-
value:
[
"string",
"null"
]
Maximum Length:
300000
The string value of the configuration. The value is either a site value or the value associated with the interface. The configuration values are stored and fetched from a file cache.
Nested Schema : namedIDs-configurations-dataType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
Examples
Use GET with the following syntax to retrieve data for a custom configuration object:
https://your_site_interface/services/rest/connect/version/configurations/configuration_id
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002
Response body example
{
"id": 1000002,
"lookupName": "CUSTOM_CFG_my_config",
"dataType": {
"id": 3,
"lookupName": "Text"
},
"name": "CUSTOM_CFG_my_config",
"value": "Default text goes here.",
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/configurations",
"mediaType": "application/schema+json"
}
]
}