AttachmentService · AttachmentService_GetAttachment
Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.
Access
The resource must be readable by the caller. Anonymous access depends on public instance policy and the memo's visibility. Unlinked attachments require their owner or an instance administrator. A resource name alone does not grant access.
Request
GetAttachment returns an attachment by name.
GET
/api/v1/attachments/{attachment}Parameters
| Name / location | Type / requirement | Description |
|---|---|---|
attachmentpath | string Required | The attachment id. |
Request body
No request body is declared.
Responses
200 · OK
application/json · Attachment
default · Default error response
application/json · Status
Complete operation definition
All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.
Open JSON definition
{
"tags": [
"AttachmentService"
],
"description": "GetAttachment returns an attachment by name.",
"operationId": "AttachmentService_GetAttachment",
"parameters": [
{
"name": "attachment",
"in": "path",
"description": "The attachment id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Attachment"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}