Skip to content

Latest commit

 

History

History
356 lines (287 loc) · 9.93 KB

19_Revisions.md

File metadata and controls

356 lines (287 loc) · 9.93 KB
Raw

Revisions

Retrieving Revisions' Information

Returns a referenced File Revision's information.

Definition

GET /api/v1/:organization_name/:project/:folder_path/:file_name/:revision

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
  'https://api.layervault.com/api/v1/layervault/Test/Illustrations/NewFile.psd/1'

Example Response

{
  "name": "1",
  "download_url": "https://layervault.com/files/download_node/DwoRKvzbEj",
  "full_url": "https://layervault.com/layervault/api-playground/Test.psd/1",
  "md5": "e388875b2d81f6798dd187d1c047a50c",
  "deleted_at": null,
  "updated_at": "2013-10-21T19:05:24Z",
  "created_at": "2013-10-21T19:05:24Z",
  "shortened_url": "http://lyrv.lt/DwoRKvzbEj",
  "revision_number": 1,
  "user": {},
  "previews": []
}

Arguments

The :organization_name, :project, :folder_path, :file_name and :revision are required in the call URL.

Returns

Returns a JSON object containing:

  • name - The name of the revision, which is its revision number.
  • full_url - The absolute URL to the Revision
  • download_url - The absolute URL to download a copy of the Revision
  • md5 - The MD5 hash of the Revision
  • shortened_url - The shortened URL for the Folder
  • deleted_at - The date when the revision was deleted, null otherwise
  • updated_at - The updated at date for the Revision
  • deleted_at - The deletion date for the Revision
  • revision_number - The revision number for the Revision
  • user - The user who created the Revision
  • previews - All previews generated for the Revision

Retrieving Revision's Meta Information

Returns a referenced File Revisions Meta Information. Contains various metadata about the file format.

Definition

GET /api/v1/:organization_name/:project/:folder/:file_name/:revision/meta

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
    'https://api.layervault.com/api/v1/layervault/Test/Illustrations/NewFile.psd/1/meta'

Example Response

{
  "psd": {
    "children": [
      {
        "type": "group",
        "visible": false,
        "opacity": 1.0,
        "blending_mode": "normal",
        "name": "design aids",
        "left": 220,
        "right": 2100,
        "top": 0,
        "bottom": 2640,
        "height": 1880,
        "width": 2640,
        "children": [
          {
            "type": "layer",
            "visible": true,
            "opacity": 0.2,
            "blending_mode": "normal",
            "name": "Layer 8",
            "left": 220,
            "right": 2100,
            "top": 1559,
            "bottom": 1759,
            "height": 200,
            "width": 1880,
            "text": null,
            "ref_x": 0.0,
            "ref_y": 1259.0
          },
          {
            "type": "layer",
            "visible": true,
            "opacity": 0.2,
            "blending_mode": "normal",
            "name": "Layer 1",
            "left": 220,
            "right": 2100,
            "top": 0,
            "bottom": 2640,
            "height": 2640,
            "width": 1880,
            "text": null,
            "ref_x": 200.0,
            "ref_y": 0.0
          }
        ]
      },
      {
        "type": "group",
        "visible": true,
        "opacity": 1.0,
        "blending_mode": "normal",
        "name": "header",
        "left": 0,
        "right": 2320,
        "top": -80,
        "bottom": 120,
        "height": 2320,
        "width": 200,
        "children": [
          {
            "type": "group",
            "visible": false,
            "opacity": 1.0,
            "blending_mode": "normal",
            "name": "logo",
            "left": 219,
            "right": 337,
            "top": 15,
            "bottom": 114,
            "height": 118,
            "width": 99,
            "children": [
              {
                "type": "layer",
                "visible": true,
                "opacity": 1.0,
                "blending_mode": "normal",
                "name": "DN",
                "left": 237,
                "right": 294,
                "top": 45,
                "bottom": 75,
                "height": 30,
                "width": 57,
                "text": {
                  "value": "DN",
                  "font": {
                    "name": "AvantGardeBQ-Bold",
                    "sizes": [
                      56.0
                    ],
                    "colors": [
                      [
                        255,
                        45,
                        114,
                        217
                      ]
                    ],
                    "css": "font-family: \"AvantGardeBQ-Bold\", \"AdobeInvisFont\", \"MyriadPro-Regular\";\nfont-size: 56.0pt;\ncolor: rgba(45, 114, 217, 255);"
                  },
                  "left": 0,
                  "top": 0,
                  "right": 0,
                  "bottom": 0,
                  "transform": {
                    "xx": 0.75,
                    "xy": 0.0,
                    "yx": 0.0,
                    "yy": 0.75,
                    "tx": 265.2851736545563,
                    "ty": 75.36329567432404
                  }
                },
                "ref_x": -1200.9999825954437,
                "ref_y": -314.62498557567596
              }
    ],
    "document": {
      "width": 2320,
      "height": 2640
    }
  }
  }
}

Arguments

The :organization_name, :project, :folder_path, :file_name and :revision are required in the call URL.

Returns

Returns a JSON object containing any Meta information that was set for the revision.

Retrieving All Previews for a Revision

Returns all of the previews associated with the revision.

Definition

GET /api/v1/:organization_name/:project/:folder/:file_name/:revision/previews

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
  'https://api.layervault.com/api/v1/layervaultTest/Illustrations/NewFile.psd/1/previews'

Example Response

[
  'https://layervault-preview.imgix.net/data/ed3fd8ba3ff2acf4157517fb14aadf8b?s=6666868519b243260d38b3ca1d1b23ef',
  'https://layervault-preview.imgix.net/data/ed3fd8ba3ff2acf4157517fb14aadf8b?s=6666868519b243260d38b3ca1d1b4edf',
  'https://layervault-preview.imgix.net/data/ed3fd8ba3ff2acf4157517fb14aadf8b?s=6666868519b243260d38b3ca1d1bw21f',
...
]

Arguments

The :organization_name, :project, :folder_path, :file_name, and :revision are required in the call URL. In addition, you can add GET parameters that will be passed along to imgix for formatting the image. See their API documentation for available options.

Returns

Returns a JSON array containing a list of preview image URLs.

Retrieving Revisions Preview Information

Returns a referenced File Revisions Preview image link.

Definition

GET /api/v1/:organization_name/:project/:folder/:file_name/:revision/preview

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
  'https://api.layervault.com/api/v1/layervaultTest/Illustrations/NewFile.psd/1/previews'

Example Response

'https://layervault-preview.imgix.net/data/ed3fd8ba3ff2acf4157517fb14aadf8b?w=600&h=1012&s=6666868519b243260d38b3ca1d1b981f'

Arguments

The :organization_name, :project, :folder_path, :file_name and :revision are required in the call URL. In addition, you can add GET parameters that will be passed along to imgix for formatting the image. See their API documentation for available options.

Returns

A single URL to the preview image.

Retreiving a File Revision's Feedback Items

Obtain the feeback items attached to a file revision.

Definition

GET /api/v1/:organization_name/:project/:folder/:file_name/:revision/feedback_items

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
  'https://api.layervault.com/api/v1/layervault/Project/Test.psd/1/feedback_items'

Example Response

[
  {
    "id": 1687,
    "top": null,
    "right": null,
    "left": null,
    "bottom": null,
    "left_on_preview_id": 436729,
    "message": "I meant to say Front Page, not Story Page :(",
    "created_at": "2013-04-19T19:06:11Z"
    "user": {},
    "addressed_by": null,
    "replies": []
  }
]

Arguments

The :organization_name, :project, :folder_path, :file_name and :revision are required in the call URL.

Returns

Returns a JSON array of objects containing:

  • id - The ID of the feedback item.
  • top - The top coordinate of the feedback annotation bounding box.
  • right - The right coordinate of the feedback annotation bounding box.
  • left - The left coordinate of the feedback annotation bounding box.
  • bottom - The bottom coordinate of the feedback annotation bounding box.
  • left_on_preview_id - The preview id the feedback item was left on.
  • message - The text of the feedback item.
  • created_at - The date the feedback item was created.
  • user - User object for the user who left the feedback.
  • addressed_by - The feedback item that was created when Requesting Team Feedback and marks this feedback item as addressed.
  • replies - Array of feedback item objects that are a reply to this feedback item. Threads can only be 1 level deep, so the replies will not have replies.

Downloading a File Revision

Download the file represented by the requested revision.

Definition

GET /api/v1/:organization_name/:project/:folder/:file_name/:revision/download

Example Request

$ curl -H 'Authorization: Bearer <your access token>' \
  'https://api.layervault.com/api/v1/layervault/Project/Test.psd/1/download'

Example Response

  {
    "file_url": "https://s3.amazon.com"
  }

Arguments

The :organization_name, :project, :folder_path, :file_name and :revision are required in the call URL.

Returns

Returns the location of the Revision download:

  • file_url - The URL from which to download the Revision.