Jump to

• Request
• Response

updateCustomTranslations

put

/ccadmin/v1/resources/{bundle}

Update Custom Translations. Update the custom translations for the specified resource bundle strings. Keys with blank values will be removed from the translations map

Request

Supported Media Types

• application/json

Path Parameters

• bundle(required): string
  The name of the resource bundle to store the custom values against.

Body ()

Root Schema : updateCustomTranslations_request

Type: object

Show Source

• custom: array custom
  Map of custom resource key/value pairs to update.

{
    "properties":{
        "custom":{
            "description":"Map of custom resource key/value pairs to update.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":"PUT /ccadminui/v1/resources/ns.common"
}

Example:

PUT /ccadminui/v1/resources/ns.common

Nested Schema : custom

Type: array

Map of custom resource key/value pairs to update.

Show Source

• Array of: string

{
    "description":"Map of custom resource key/value pairs to update.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateCustomTranslations_response

Type: object

Show Source

• custom: array custom
  Updated map of custom resource key/value pairs

{
    "properties":{
        "custom":{
            "description":"Updated map of custom resource key/value pairs",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : custom

Type: array

Updated map of custom resource key/value pairs

Show Source

• Array of: string

{
    "description":"Updated map of custom resource key/value pairs",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "custom":{
        "okText":"OK"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/resources/ns.common?custom=%5Bobject%20Object%5D"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |71008|If a key is missing or not specified| |71007|If an error occurs when trying to retrieve the custom translations| |71004|If the locale is not specified and cannot be determined| |71011|If an error occurs when removing a custom translation| |71010|If an error occurs when saving a custom translation|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top