kythene.v1.KytheneService

EditCollection

EditCollection edits a collection's membership with one call - the aggregate of add / reorder / move behind an action - returning a lean ack (revisions and any newly-exposed share-code holders) rather than whole collections.

post/kythene.v1.KytheneService/EditCollection

Request

  • Base URL: https://kythene.com (the document declares no server; this is the origin it was published from)
  • URL: https://kythene.com/kythene.v1.KytheneService/EditCollection
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

collectionIdstring

collection_id is the collection to edit (for a move, the SOURCE collection).

actionstring

action is one of: "add" (add files), "reorder" (set the full member order), "move" (move a file to another collection), "rename" (change the title), "tags" (replace the collection's tags).

existingArtifactIdsstring[]

add: references to already-published artifacts of the same space to append.

notestring

add: optional version note.

artifactIdsstring[]

reorder: the FULL current member set, every artifact once, in the order you want (a partial or unknown-id list is rejected; work from a fresh get_collection).

artifactIdstring

move: the artifact to move, and the destination collection (same space); collection_id is the source.

toCollectionIdstring

to_collection_id is the collection to move the artifact INTO; collection_id is the one it leaves. Both must be in the same space.

titlestring

rename: the new title. The collection keeps its id, links, comments, reviews and history; the revision does not change.

spacestring

space optionally selects which of your spaces to act in (an id or name from list_spaces). Omit it when you belong to a single space.

tagsstring[]

tags: the full set of tags the collection should carry (labels and projects); names not yet in the workspace become new labels.

dryRunboolean

tags: true to report the effect without changing anything.

Response

Success

okboolean

ok is true when the edit applied.

revisioninteger

revision is the collection's revision after add/reorder, or (unchanged) after a rename.

fromRevisioninteger

from_revision / to_revision are the source and destination revisions after a move.

toRevisioninteger
shareCodeHoldersstring[]

share_code_holders lists share-code labels whose holders can now read a newly-added or newly-moved file anonymously (the exposure the edit created).

urlstring

url is the collection's canonical link - after a move, the file within its destination - hand THAT to a person, never the bare id.

tagsAddedstring[]

tags: what the change does (or would, on a dry run). Tell the person who gains or loses access BEFORE you make a change that does either.

tagsRemovedstring[]
membersGainstring[]

members_gain / members_lose: workspace members who can now / can no longer see the collection (a private project decides this), by name.

membersLosestring[]
guestsGainstring[]

guests_gain / guests_lose: share links (by label) and tag passwords whose holders can now / can no longer read it without an account.

guestsLosestring[]

Changes

No recorded changes to this operation across all 1 revision of this API.