-
Notifications
You must be signed in to change notification settings - Fork 119
Sync API docs from bc3: spotlights, questions 403 note, schedule entries 422 note #439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| Spotlights | ||
| ========== | ||
|
|
||
| A spotlight puts a recording's card on the home page of the project or template | ||
| it belongs to, alongside the tools. A spotlight doesn't change who can see the | ||
| recording: clients see a spotlight only when the recording is shared with them. | ||
| A recording can be spotlighted once, and only in its own project or template. | ||
|
|
||
| A spotlight isn't a resource of its own: it's a mark on the recording, like a | ||
| pin. Spotlighting a recording returns that recording, and the project's `dock` | ||
| array is unaffected, since spotlights aren't tools. See | ||
| [recordings](recordings.md) for the shape of a recording and | ||
| [Get a project](projects.md#get-a-project) for the dock. | ||
|
|
||
| Endpoints: | ||
|
|
||
| - [Spotlight a recording](#spotlight-a-recording) | ||
| - [Remove a spotlight](#remove-a-spotlight) | ||
|
|
||
|
|
||
| Spotlight a recording | ||
| --------------------- | ||
|
|
||
| * `POST /recordings/2/spotlight.json` will spotlight the recording with an ID of | ||
| `2` on the home page of its project or template. | ||
|
|
||
| No parameters are required. This endpoint returns `201 Created` with the | ||
| recording that was spotlighted. Spotlighting a recording that's already | ||
| spotlighted also returns `201 Created`. | ||
|
|
||
| Not every recording can be spotlighted: containers such as message boards and | ||
| to-do sets can't, nor can recordings that are archived or trashed. Those | ||
| requests return `422 Unprocessable Entity`. | ||
| Spotlighting also requires permission to edit the project, so clients and people | ||
| without that permission get `403 Forbidden`. | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -X POST \ | ||
| https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/spotlight.json | ||
| ``` | ||
|
|
||
|
|
||
| Remove a spotlight | ||
| ------------------ | ||
|
|
||
| * `DELETE /recordings/2/spotlight.json` will remove the spotlight on the | ||
| recording with an ID of `2`. | ||
|
|
||
| This endpoint returns `204 No Content`. Removing a spotlight that doesn't exist | ||
| also returns `204 No Content`. | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE \ | ||
| https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/spotlight.json | ||
| ``` | ||
|
|
||
|
|
||
| Legacy project-scoped routes | ||
| ----------------------------- | ||
|
|
||
| The following project-scoped routes are still supported and will remain | ||
| available, but flat routes above are the canonical form for new integrations. | ||
|
|
||
| * `POST /buckets/1/recordings/2/spotlight.json` → [Spotlight a recording](#spotlight-a-recording) | ||
| * `DELETE /buckets/1/recordings/2/spotlight.json` → [Remove a spotlight](#remove-a-spotlight) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.