Update session

Update properties of an existing session, such as title or other metadata.

PATCH /session/{sessionID}

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.session.update({
  ...
})

200

{
  "id": "<string>",
  "slug": "<string>",
  "projectID": "<string>",
  "directory": "<string>",
  "title": "<string>",
  "version": "<string>",
  "time": {
    "created": 123,
    "updated": 123,
    "compacting": 123,
    "archived": 123
  },
  "workspaceID": "<string>",
  "parentID": "<string>",
  "forkedFrom": "<string>",
  "summary": {
    "additions": 123,
    "deletions": 123,
    "files": 123,
    "diffs": [
      {
        "file": "<string>",
        "patch": "<string>",
        "additions": 123,
        "deletions": 123,
        "status": "added"
      }
    ]
  },
  "share": {
    "url": "<string>"
  },
  "tags": [],
  "permission": [
    {
      "permission": "<string>",
      "pattern": "<string>",
      "action": "allow"
    }
  ],
  "revert": {
    "messageID": "<string>",
    "partID": "<string>",
    "snapshot": "<string>",
    "checkpointId": "<string>",
    "diff": "<string>"
  }
}

Path Parameters

sessionID · string · required

Pattern: ^ses.*

Query Parameters

directory · string

workspace · string

Body

application/json

title · string

tags · string[]

permission · object[]

Show child attributes

time · object

Show child attributes

Response

200

application/json

Successfully updated session

id · string · required

Pattern: ^ses.*

slug · string · required

projectID · string · required

directory · string · required

title · string · required

version · string · required

time · object · required

Show child attributes

workspaceID · string

Pattern: ^wrk.*

parentID · string

Pattern: ^ses.*

forkedFrom · string

Pattern: ^ses.*

summary · object

Show child attributes

share · object

Show child attributes

tags · string[]

permission · object[]

Show child attributes

revert · object

Show child attributes