Get deliverable versions

getapi.bunnystudio.com/revisions/{deliverableId}/versions

This endpoint gets all the versions of a specific deliverable.

Requirements

Authentication

None

Scope

users

Path parameters

deliverableId

string
Bunny Studio UUID of the deliverable you want to get the versions

Request example

Console

 curl --request GET \ 
      --url https://api.bunnystudio.com/revisions/DELIVERABLE_ID/versions \
      --header "x-access-token: YOUR_TOKEN" \

JavaScript

  const url = 'https://api.bunnystudio.com/revisions/DELIVERABLE_ID/versions';
  const options = {
    method: 'GET',
    headers: {
      'x-access-token': 'YOUR_TOKEN',
    }
  }; 
  fetch(url, options)
    .then(response => response.json())
    .then(response => console.log(response))
    .catch(err => console.error(err));

Python

  import requests
  import json
  api_url = "https://api.bunnystudio.com/revisions/DELIVERABLE_ID/versions"
  headers = {
    'x-access-token': 'YOUR_TOKEN',
  }
  response = requests.get(api_url, headers=headers)
  print(response.text)

PHP - CURL

<?php
  $curl = curl_init();
  curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.bunnystudio.com/revisions/DELIVERABLE_ID/versions',
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
      'x-access-token': 'YOUR_TOKEN',
    ),
    
  ));
  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;

Response format

id

string
A UUID (Universal Unique Identifier) that identifies the deliverable on Bunny Studio's database. You should use this ID for all API actions related to a specific deliverable.

serviceSubCategory

string
The category of this deliverable

name

string
The name of the deliverable. If it consists of multiple parts, the string will usually represent the part number (e.g. "Part 2").

status

string
The status of the deliverable

versions

array
List of the versions of the deliverable.

versions[x].created

object
Date the version was created.

versions[x].instructions

object
Instructions that the version have if a revision was requested.

versions[x].urls

object
The URLs of the files from the deliverable version. Depending on the category of the deliverable, the available formats for download will vary.

Response example

  {
    "id": "eac02f6d-d62a-4f48-b4d8-40b6478a0900",
    "serviceSubCategory": CATEGORY,
    "name": "part1",
    "status": "approved",
    "versions": [
      {
        "created": "2023-03-13T19:08:15",
        "instructions": "Revision instructions",
        "urls": {LINKS_OF_FILES_BY_FORMAT}
      }
      ...
    ],
  }

Error responses

500 Error getting versions of deliverable

  {
    status: 500,
    type: 'ERROR_GETTINT_VERSIONS',
    message: 'There was an error getting the versions for deliverable with id \"DELIVERABLE_ID\", please talk with our support team',
  }

400 Deliverable not exist

  {
    status: 404,
    type: 'DELIVERABLE_NO_EXIST',
    message: 'Deliverable with id \"DELIVERABLE_ID\" not found',
  }

403 Forbidden

  {
    status: 403,
    type: 'FORBIDDEN',
    message: 'You do not have permission to do this action',
  }

422 Id required

  {
    status: 422,
    type: 'ID_REQUIRED',
    message: 'The field "\id\" is required',
  }