repo/rest-api/specs/resources/labels/label-in-language-for-property.json
{
"get": {
"operationId": "getPropertyLabel",
"tags": [ "labels" ],
"summary": "Retrieve a Property's label in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/PropertyId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"responses": {
"200": { "$ref": "./responses.json#/PropertyLabel" },
"304": { "$ref": "../../global/responses.json#/NotModified" },
"400": { "$ref": "../../global/responses.json#/InvalidTermByLanguageInput" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"put": {
"operationId": "replacePropertyLabel",
"tags": [ "labels" ],
"summary": "Add / Replace a Property's label in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/PropertyId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"requestBody": { "$ref": "./requests.json#/PropertyLabel" },
"responses": {
"200": {
"$ref": "./responses.json#/PropertyLabel",
"description": "The updated Label in a specific language"
},
"201": {
"$ref": "./responses.json#/PropertyLabel",
"description": "The newly added Label in a specific language"
},
"304": { "$ref": "../../global/responses.json#/NotModified" },
"400": { "$ref": "../../global/responses.json#/InvalidSetLabelInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"422": { "$ref": "../../global/responses.json#/DataPolicyViolation" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"delete": {
"operationId": "deletePropertyLabel",
"tags": [ "labels" ],
"summary": "Delete a Property's label in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/PropertyId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"requestBody": { "$ref": "../../global/requests.json#/Delete" },
"responses": {
"200": { "$ref": "./responses.json#/LabelDeleted" },
"400": { "$ref": "../../global/responses.json#/InvalidRemoveLabelInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
}
}