kythene.v1.KytheneService

MoveArtifact

MoveArtifact moves one artifact from one collection to another in the same space, atomically, carrying its comments, reviews and history. If the move empties the source, the source archives itself. Refuses a cross-space move (that is a share).

post/kythene.v1.KytheneService/MoveArtifact

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/MoveArtifact
  • 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

artifactIdstring

artifact_id is the artifact to move.

fromCollectionIdstring

from_collection_id is the source collection it currently belongs to.

toCollectionIdstring

to_collection_id is the destination collection (same space).

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 moved file anonymously via the destination (empty when the destination carries no shared tag) - the exposure the move created.

Example response

{
  "fromCollection": {
    "createdAt": "2023-01-15T01:30:15.01Z",
    "artifacts": [
      {
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      }
    ]
  },
  "toCollection": {
    "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.