PRprocess
File Revisions

Create a file revision

Changed on

Starts a draft with a replacement document. First call createFileUpload, upload your document to the returned URL, and pass its fileUploadId here. The published document stays available until you publish the draft. A file can have only one draft at a time.

post/files/{fileId}/revisions

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/files/{fileId}/revisions
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

fileIdstring required

File ID

Request body

fileUploadIdstring required

The upload ID returned by createFileUpload. Upload the replacement document to its uploadUrl before creating the revision.

Response

Example response

{
  "data": {
    "id": "jkBnUsJVEmABoZxtcCRyeQ",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes