본문으로 건너뛰기

DocumentResponse

Data returned for Document. Required fields are id, name, category, item.

idId (string)필수

Server-assigned unique identifier

nameName (string)필수

Resource name

alias object

URL-safe short handle

하나 이상(anyOf)
string
categoryCategory (string)필수

Resource type tag

type object

Subtype within category

하나 이상(anyOf)
string
collection_id object

Parent collection ID

하나 이상(anyOf)
string
folder_id object

Identifier of the containing folder.

하나 이상(anyOf)
string
tags object

Classification labels

하나 이상(anyOf)
  • Array [
  • string
  • ]
  • description object

    Resource description

    하나 이상(anyOf)
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    기본값: []
    created_at object

    Creation timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    updated_at object

    Last update timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)필수

    "user." | "group." | "public.all"

    typeType (string)필수

    Possible values: [user, group, public]

    display_nameDisplay Name (string)필수
    avatar_url object
    하나 이상(anyOf)
    string
    avatar_config object
    하나 이상(anyOf)
    object
    email object
    하나 이상(anyOf)
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    하나 이상(anyOf)
    string

    Possible values: [owner, grant, admin]

    options object
    하나 이상(anyOf)
    object
    itemItem (string)필수사용 중단
    DocumentResponse
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "options": {}
    }