repo/rest-api/specs/resources/aliases/list-for-property.json
{
"get": {
"operationId": "getPropertyAliases",
"tags": [ "aliases" ],
"summary": "Retrieve a Property's aliases",
"parameters": [
{ "$ref": "../../global/parameters.json#/PropertyId" },
{ "$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#/PropertyAliases" },
"304": { "$ref": "../../global/responses.json#/NotModified" },
"400": { "$ref": "../../global/responses.json#/InvalidEntityIdInput" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"patch": {
"operationId": "patchPropertyAliases",
"tags": [ "aliases" ],
"summary": "Change a Property's aliases",
"parameters": [
{ "$ref": "../../global/parameters.json#/PropertyId" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" }
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to a Property's aliases and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": { "$ref": "../../global/request-parts.json#/PatchRequest" },
"example": { "$ref": "./examples.json#/PatchPropertyAliases" }
},
"application/json": {
"schema": { "$ref": "../../global/request-parts.json#/PatchRequest" },
"example": { "$ref": "./examples.json#/PatchPropertyAliases" }
}
}
},
"responses": {
"200": { "$ref": "./responses.json#/PropertyAliases" },
"400": { "$ref": "../../global/responses.json#/InvalidPatch" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"409": { "$ref": "../../global/responses.json#/CannotApplyPropertyPatch" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"422": { "$ref": "../../global/responses.json#/InvalidPatchedAliases" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
}
}