125 lines
3.2 KiB
Markdown
125 lines
3.2 KiB
Markdown
---
|
|
name: web-links-routes
|
|
description: Handle 11 OpenAPI operation(s) under /web_links for the web links route group.
|
|
---
|
|
|
|
# web links API Routes
|
|
|
|
Handle 11 OpenAPI operation(s) under /web_links for the web links route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### post_web_links
|
|
|
|
- Operation ID: `post_web_links`
|
|
- Route: `POST /web_links`
|
|
- Mode: WRITE
|
|
- Summary: Create web link
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_web_links_id
|
|
|
|
- Operation ID: `get_web_links_id`
|
|
- Route: `GET /web_links/{web_link_id}`
|
|
- Mode: READ
|
|
- Summary: Get web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `boxapi` in `header`
|
|
|
|
### post_web_links_id
|
|
|
|
- Operation ID: `post_web_links_id`
|
|
- Route: `POST /web_links/{web_link_id}`
|
|
- Mode: WRITE
|
|
- Summary: Restore web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### put_web_links_id
|
|
|
|
- Operation ID: `put_web_links_id`
|
|
- Route: `PUT /web_links/{web_link_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_web_links_id
|
|
|
|
- Operation ID: `delete_web_links_id`
|
|
- Route: `DELETE /web_links/{web_link_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
|
|
### get_web_links_id_trash
|
|
|
|
- Operation ID: `get_web_links_id_trash`
|
|
- Route: `GET /web_links/{web_link_id}/trash`
|
|
- Mode: READ
|
|
- Summary: Get trashed web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### delete_web_links_id_trash
|
|
|
|
- Operation ID: `delete_web_links_id_trash`
|
|
- Route: `DELETE /web_links/{web_link_id}/trash`
|
|
- Mode: WRITE
|
|
- Summary: Permanently remove web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
|
|
### get_web_links_id_get_shared_link
|
|
|
|
- Operation ID: `get_web_links_id_get_shared_link`
|
|
- Route: `GET /web_links/{web_link_id}#get_shared_link`
|
|
- Mode: READ
|
|
- Summary: Get shared link for web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query` required
|
|
|
|
### put_web_links_id_add_shared_link
|
|
|
|
- Operation ID: `put_web_links_id_add_shared_link`
|
|
- Route: `PUT /web_links/{web_link_id}#add_shared_link`
|
|
- Mode: WRITE
|
|
- Summary: Add shared link to web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### put_web_links_id_update_shared_link
|
|
|
|
- Operation ID: `put_web_links_id_update_shared_link`
|
|
- Route: `PUT /web_links/{web_link_id}#update_shared_link`
|
|
- Mode: WRITE
|
|
- Summary: Update shared link on web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### put_web_links_id_remove_shared_link
|
|
|
|
- Operation ID: `put_web_links_id_remove_shared_link`
|
|
- Route: `PUT /web_links/{web_link_id}#remove_shared_link`
|
|
- Mode: WRITE
|
|
- Summary: Remove shared link from web link
|
|
- Parameters:
|
|
- `web_link_id` in `path` required
|
|
- `fields` in `query` required
|
|
- Body: JSON request body accepted.
|