DocumentationAPI reference

Rust · 0.1.0

Get Memo View

GET /api/v1/users/{user}/views/{view}

UserService · UserService_GetMemoView

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

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Reuse the stored filter

Read the filter string from the returned MemoView and pass it to ListMemos.filter. The resulting feed is evaluated with the caller's current permissions and current data; a saved view is not a snapshot.

Request

GetMemoView gets a memo view by name.

GET/api/v1/users/{user}/views/{view}

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
view
path
string
Required
The view id.

Request body

No request body is declared.

Responses

200 · OK

application/json · MemoView

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": [
    "UserService"
  ],
  "description": "GetMemoView gets a memo view by name.",
  "operationId": "UserService_GetMemoView",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "view",
      "in": "path",
      "description": "The view id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MemoView"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}