URSY.DEVPART OF THE URSY NETWORKSign inBuild with URSY

Every contract sourcedEvery check datedGaps shown, never filledBuild with URSY

Endpoints

apply_spreadsheet_edit

Apply the exact spreadsheet proposal after checking its base version.

POST/v1/spreadsheets/{file_id}/edit-plans/{plan_id}/applyv1.8.3

Request

Authentication is required by the published contract.

CURL
curl -X POST 'https://api.ursy.cloud/v1/spreadsheets/{file_id}/edit-plans/{plan_id}/apply' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_SERVICE_TOKEN'
Scopes
Not specified by this operation
Execution
At the owning service
Risk classification
not declared

Parameters

file_id path · string required

See the accepted schema for constraints.

plan_id path · string required

See the accepted schema for constraints.

If-Match header · string required

See the accepted schema for constraints.

Idempotency-Key header · string required

See the accepted schema for constraints.

This operation is documented here. Use the owning service with the appropriate credentials and permissions to execute it.

Response schemas and request body
CONTRACT JSON
{
    "requestBody": {
        "required": true,
        "content": {
            "application/json": {
                "schema": {
                    "type": "object",
                    "additionalProperties": false
                }
            }
        }
    },
    "responses": {
        "200": {
            "description": "Typed operation result; request_id correlates the request.",
            "content": {
                "application/json": {
                    "schema": {
                        "type": "object",
                        "additionalProperties": true,
                        "properties": {
                            "file": {
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "schema": {
                                        "type": "string",
                                        "enum": [
                                            "ursy.cloud/file/v1"
                                        ]
                                    },
                                    "id": {
                                        "type": "string",
                                        "pattern": "^file_[1-9][0-9]{0,14}$"
                                    },
                                    "workspace_id": {
                                        "type": "string",
                                        "pattern": "^ws_[1-9][0-9]*$"
                                    },
                                    "parent_id": {
                                        "oneOf": [
                                            {
                                                "type": "string",
                                                "pattern": "^file_[1-9][0-9]{0,14}$"
                                            },
                                            {
                                                "type": "null"
                                            }
                                        ]
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 190,
                                        "x-ursy-maxBytes": 190
                                    },
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "folder",
                                            "document",
                                            "spreadsheet",
                                            "presentation",
                                            "note",
                                            "publication",
                                            "pdf",
                                            "uploaded_file"
                                        ]
                                    },
                                    "current_version_id": {
                                        "oneOf": [
                                            {
                                                "type": "string",
                                                "pattern": "^ver_[1-9][0-9]*$"
                                            },
                                            {
                                                "type": "null"
                                            }
                                        ]
                                    },
                                    "etag": {
                                        "type": "string",
                                        "pattern": "^\"[a-f0-9]{64}\"$"
                                    },
                                    "state": {
                                        "type": "string",
                                        "enum": [
                                            "active",
                                            "trashed"
                                        ]
                                    },
                                    "created_at": {
                                        "type": "string"
                                    },
                                    "updated_at": {
                                        "type": "string"
                                    },
                                    "human_url": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "schema",
                                    "id",
                                    "workspace_id",
                                    "parent_id",
                                    "name",
                                    "type",
                                    "current_version_id",
                                    "etag",
                                    "state",
                                    "created_at",
                                    "updated_at",
                                    "human_url"
                                ]
                            },
                            "request_id": {
                                "type": "string"
                            },
                            "replayed": {
                                "type": "boolean"
                            }
                        },
                        "required": [
                            "file"
                        ]
                    }
                }
            }
        },
        "default": {
            "description": "Stable error envelope. 401 invalid/expired/revoked grant; 403 missing scope; 404 unavailable resource; 409 plan/idempotency conflict; 412 stale ETag; 413 size/quota; 429 rate limit.",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Error"
                    }
                }
            }
        }
    }
}