repo/rest-api/specs/resources/sitelinks/single.json
{
"get": {
"operationId": "getSitelink",
"tags": [ "sitelinks" ],
"summary": "Retrieve an Item's Sitelink",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/SiteId" },
{ "$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": "../../global/responses.json#/Sitelink" },
"304": { "$ref": "../../global/responses.json#/NotModified" },
"308": { "$ref": "../../global/responses.json#/MovedPermanently" },
"400": { "$ref": "./responses.json#/InvalidGetSitelinkInput" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"put": {
"operationId": "setSitelink",
"tags": [ "sitelinks" ],
"summary": "Add / Replace an Item's Sitelink",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/SiteId" },
{ "$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#/Sitelink" },
"responses": {
"200": {
"$ref": "../../global/responses.json#/Sitelink",
"description": "The updated Sitelink"
},
"201": {
"$ref": "../../global/responses.json#/Sitelink",
"description": "The newly added Sitelink"
},
"400": { "$ref": "./responses.json#/InvalidSetSitelinkInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"409": { "$ref": "../../global/responses.json#/ItemRedirected" },
"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": "deleteSitelink",
"tags": [ "sitelinks" ],
"summary": "Delete an Item's Sitelink",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/SiteId" },
{ "$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#/SitelinkDeleted" },
"400": { "$ref": "./responses.json#/InvalidRemoveSitelinkInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"409": { "$ref": "../../global/responses.json#/ItemRedirected" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
}
}