kythene.v1.KytheneService

AddArtifacts

AddArtifacts appends artifacts (new content and/or references to existing artifacts of the same space) to an existing collection, bumping its revision. Lets a document set grow without republishing (which would create a new collection and abandon its comments and history).

post/kythene.v1.KytheneService/AddArtifacts

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/AddArtifacts
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 add to.

existingArtifactIdsstring[]

existing_artifact_ids references already-published artifacts of the SAME space into the collection (curation).

notestring

note is an optional note recorded on the activity entry.

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.

Response

Success

shareCodeHoldersstring[]

share_code_holders lists the labels of active share codes whose holders can now read the added files anonymously (empty when the collection carries no shared tag) - the exposure the add created.

Example response

{
  "collection": {
    "createdAt": "2023-01-15T01:30:15.01Z",
    "artifacts": [
      {
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      }
    ]
  }
}

Changes

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