Recent searches

in
Developer ReferenceAPI

Editing Session Files

On this page

Get a file's details from an Editing Session

GET/api/v0/editing_session_files/{editing_session_file_uuid}
Path parameters:
editing_session_file_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_uuid": "string",
  "edit_type": "string",
  "source_path": "string",
  "path": "string",
  "sync_blocked": true,
  "has_conflict": true,
  "unchanged": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "metadata": {},
  "contributions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "editing_session_file_uuid": "string",
      "session_type": "string",
      "user_uuid": "string",
      "session_uuid": "string",
      "state": "string",
      "file_contents": "string",
      "generated_by_merge": true,
      "content_hash": "string",
      "ended_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Discard a file from an Editing Session

DELETE/api/v0/editing_session_files/{editing_session_file_uuid}
Path parameters:
editing_session_file_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200Discarded
JSON
Copied to clipboard
{}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Claim the editing lock on a file in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/claim_lock
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
previous_content_hashstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/claim_lock \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "previous_content_hash": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_file_uuid": "string",
  "session_type": "string",
  "user_uuid": "string",
  "session_uuid": "string",
  "state": "string",
  "file_contents": "string",
  "generated_by_merge": true,
  "content_hash": "string",
  "ended_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

List all contributions for a file in an Editing Session

GET/api/v0/editing_session_files/{editing_session_file_uuid}/contributions
Path parameters:
editing_session_file_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/contributions \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "editing_session_file_uuid": "string",
    "session_type": "string",
    "user_uuid": "string",
    "session_uuid": "string",
    "state": "string",
    "file_contents": "string",
    "generated_by_merge": true,
    "content_hash": "string",
    "ended_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Create a contribution for a file in an Editing Session, or update the latest contribution

POST/api/v0/editing_session_files/{editing_session_file_uuid}/contributions
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
s3_keystringRequired#

The storage key of the uploaded file contents

content_hashstringRequired#

The hash of the new file contents

previous_content_hashstring#

The content hash of the current latest contribution. Must match to avoid overwriting newer edits.

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/contributions \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "s3_key": "string",
    "content_hash": "string",
    "previous_content_hash": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_file_uuid": "string",
  "session_type": "string",
  "user_uuid": "string",
  "session_uuid": "string",
  "state": "string",
  "file_contents": "string",
  "generated_by_merge": true,
  "content_hash": "string",
  "ended_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Update a file's edit type in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/edit_type
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
edit_typestringRequired#
discard_unsavedboolean#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/edit_type \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "edit_type": "string",
    "discard_unsaved": true
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Update a file's metadata in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/metadata
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
metadataobject#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/metadata \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {}
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_uuid": "string",
  "edit_type": "string",
  "source_path": "string",
  "path": "string",
  "sync_blocked": true,
  "has_conflict": true,
  "unchanged": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "metadata": {},
  "contributions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "editing_session_file_uuid": "string",
      "session_type": "string",
      "user_uuid": "string",
      "session_uuid": "string",
      "state": "string",
      "file_contents": "string",
      "generated_by_merge": true,
      "content_hash": "string",
      "ended_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Update a file's path in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/path
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
pathstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/path \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_uuid": "string",
  "edit_type": "string",
  "source_path": "string",
  "path": "string",
  "sync_blocked": true,
  "has_conflict": true,
  "unchanged": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "metadata": {},
  "contributions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "editing_session_file_uuid": "string",
      "session_type": "string",
      "user_uuid": "string",
      "session_uuid": "string",
      "state": "string",
      "file_contents": "string",
      "generated_by_merge": true,
      "content_hash": "string",
      "ended_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Get a file's raw contents from an Editing Session

GET/api/v0/editing_session_files/{editing_session_file_uuid}/raw
Path parameters:
editing_session_file_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/raw \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
303Redirect
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response

View a resized preview of a file from an Editing Session

GET/api/v0/editing_session_files/{editing_session_file_uuid}/resized
Path parameters:
editing_session_file_uuidUUIDRequired#
Query parameters:
widthinteger#

The width to resize the preview to, in pixels

Defaults to: 200

heightinteger#

The height to resize the preview to, in pixels

Defaults to: 200

content_typestring#

The content type to return the image as

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/resized \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
307Redirect
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Mark a file's conflicts as resolved in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/resolve
Path parameters:
editing_session_file_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/resolve \
  -X PUT \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_uuid": "string",
  "edit_type": "string",
  "source_path": "string",
  "path": "string",
  "sync_blocked": true,
  "has_conflict": true,
  "unchanged": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "metadata": {},
  "contributions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "editing_session_file_uuid": "string",
      "session_type": "string",
      "user_uuid": "string",
      "session_uuid": "string",
      "state": "string",
      "file_contents": "string",
      "generated_by_merge": true,
      "content_hash": "string",
      "ended_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Release the editing lock on a file in an Editing Session

PUT/api/v0/editing_session_files/{editing_session_file_uuid}/unlock
Path parameters:
editing_session_file_uuidUUIDRequired#
Request body:
previous_content_hashstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/editing_session_files/{editing_session_file_uuid}/unlock \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "previous_content_hash": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "editing_session_file_uuid": "string",
  "session_type": "string",
  "user_uuid": "string",
  "session_uuid": "string",
  "state": "string",
  "file_contents": "string",
  "generated_by_merge": true,
  "content_hash": "string",
  "ended_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response
Open in a new tab