Spaces

Here are examples of XML output for API calls to the various space resources.

Retrieve all Spaces -> /spaces

<?xml version="1.0" encoding="UTF-8"?>
<spaces type="array">
  <space>
    <id>employees</id>
    <title>Employee Stuff</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/employees</url>
  </space>
  <space>
    <id>562</id>
    <title>Internal Stuff</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/562</url>
  </space>
  <space>
    <id>medianotes</id>
    <title>MediaNotes</title>
    <protected>true</protected>
    <url>http://bmls.screenstepslive.com/spaces/medianotes</url>
  </space>
  <space>
    <id>screensteps</id>
    <title>ScreenSteps</title>
    <protected>false</protected>
    <url>http://help.screensteps.com</url>
  </space>
  <space>
    <id>screenstepslive</id>
    <title>ScreenSteps Live</title>
    <protected>false</protected>
    <url>http://bmls.screenstepslive.com/spaces/screenstepslive</url>
  </space>
</spaces>

Retrieve a Single Space -> /spaces/#{space_id}

<?xml version="1.0" encoding="UTF-8"?>
<space>
  <id>720</id>
  <title>Employee Stuff</title>
  <permalink>employees</permalink>
  <message></message>
  <description></description>
  <protected>true</protected>
  <assets type="array">
    <asset>
      <title>Employee Stuff</title>
      <id>employee_stuff</id>
      <type>Bucket</type>
      <asset_type>Bucket</asset_type>
      <hidden>false</hidden>
      <url>http://bmls.screenstepslive.com/spaces/employees/buckets/employee_stuff</url>
    </asset>
    <asset>
      <title>Working With Highrise</title>
      <id>highrise</id>
      <type>Manual</type>
      <asset_type>Manual</asset_type>
      <hidden>false</hidden>
      <url>http://bmls.screenstepslive.com/spaces/employees/manuals/highrise</url>
    </asset>
  </assets>
</space>

Search a Single Space -> /spaces/#{space_id}/searches?text=#{search_string}

<?xml version="1.0" encoding="UTF-8"?>
<lessons type="array">
  <lesson>
    <title>Using the Capture Tool</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2385</url>
    <description>&lt;p&gt;Shows you how to use the capture tool.&lt;/p&gt;</description>
    <id type="integer">2385</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using the Capture Palette</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2386</url>
    <description>&lt;p&gt;Learn how to use the Capture Palette in ScreenSteps to quickly get screen shots.  The Capture Palette can float on top of other applications while you work.  Just click the capture icon to capture an image and add it to a ScreenSteps lesson.&lt;/p&gt;</description>
    <id type="integer">2386</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Creating a Lesson</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How to Capture a Menu</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/8935</url>
    <description>&lt;p&gt;There are a variety of ways you can capture menu items. This is one solution that will work on Mac or Windows.&lt;/p&gt;</description>
    <id type="integer">8935</id>
    <tags type="array">
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Capturing Images Using the Global Key Command (Mac only)</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2384</url>
    <description>&lt;p&gt;As of version 2.0.3 you can now assign a global key command to capture images into ScreenSteps.  This means that you no longer have to use the Clipboard Recorder unless you have a specific screen capture utility you want to interface with.  Currently this feature is only available for Mac OS X.&lt;/p&gt;</description>
    <id type="integer">2384</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using SnagIt with ScreenSteps</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2389</url>
    <description>&lt;p&gt;Learn how to set SnagIt to output to the system clipboard.  You can then turn on the Clipboard Recorder in ScreenSteps and use SnagIt to capture images for your ScreenSteps lessons.&lt;/p&gt;</description>
    <id type="integer">2389</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>SnagIt</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Creating a Lesson</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2380</url>
    <description>&lt;p&gt;Learn how to create a lesson using ScreenSteps 2.&lt;/p&gt;</description>
    <id type="integer">2380</id>
    <tags type="array">
      <tag>
        <name>Getting Started</name>
      </tag>
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>2.5</name>
      </tag>
      <tag>
        <name>Creating a Lesson</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using the Clipboard Recorder</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2387</url>
    <description>&lt;p&gt;Learn how to use the Clipboard Recorder.  The Clipboard Recorder will add any image that is copied to the system clipboard as a ScreenSteps step.&lt;/p&gt;</description>
    <id type="integer">2387</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Importing Images Into a Step</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2388</url>
    <description>&lt;p&gt;This lesson will show you how to import images that you already have saved on your hard drive into a step.  We know that this workflow isn't optimal right now and will be improving this in a future release of ScreenSteps.&lt;/p&gt;</description>
    <id type="integer">2388</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Dragging and Dropping Images Onto Lessons</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2390</url>
    <description>&lt;p&gt;This lesson will show you how to drag single or multiple images onto a lesson.  This can be a quick way to create steps if you already have existing images you would like to use.&lt;/p&gt;</description>
    <id type="integer">2390</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
      <tag>
        <name>Image Capture</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Image Tools</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2396</url>
    <description>&lt;p&gt;Learn what those icons are next to images in ScreenSteps.&lt;/p&gt;</description>
    <id type="integer">2396</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Using Split Step</title>
    <url>http://help.screensteps.com/manuals/screensteps/lessons/2423</url>
    <description>&lt;p&gt;See how you can take traditional, text based documentation and turn it into something visual in just a couple of minutes.  &lt;/p&gt;</description>
    <id type="integer">2423</id>
    <tags type="array">
      <tag>
        <name>ScreenSteps 2</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps 2.7</title>
      <type>Manual</type>
      <id>screensteps</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps</title>
      <url>http://help.screensteps.com</url>
    </space>
  </lesson>
</lessons>

Tags for a Space -> /spaces/#{space_id}/tags?tag=(tag_name}

<?xml version="1.0" encoding="UTF-8"?>
<lessons type="array">
  <lesson>
    <title>How do I Permanently Delete a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2309</url>
    <id type="integer">2309</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Set the Status of a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2310</url>
    <id type="integer">2310</id>
    <description>&lt;p&gt;You can use lesson status to track the progress of a lesson from creation to review to approval. This setting is only to help you with your workflow. It does not affect how the lesson is displayed to the end user.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Status</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Enable/Disable Comments for a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2311</url>
    <id type="integer">2311</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Respond to Comments on a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2312</url>
    <id type="integer">2312</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Subscribe/Unsubscribe to Comments via Email for a Lesson?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2313</url>
    <id type="integer">2313</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Delete a Comment?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/2315</url>
    <id type="integer">2315</id>
    <description></description>
    <tags type="array">
      <tag>
        <name>Comments</name>
      </tag>
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Share the URL for a Lesson From the Administration Area?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/3517</url>
    <id type="integer">3517</id>
    <description>&lt;p&gt;Many times you will want to send the url for a lesson to customer or other user.  This lesson will show you how to easily get the urls for those lessons from the administration area.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Manuals</name>
      </tag>
      <tag>
        <name>Spaces</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>Add Lesson Content</title>
    <url>http://help.bluemangolearning.com/m/customer_support_site/l/4248</url>
    <id type="integer">4248</id>
    <description>&lt;p&gt;Now it is time to go back and add some content to the lessons we created. ScreenSteps makes this really fast. &lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
      <tag>
        <name>Methodology</name>
      </tag>
    </tags>
    <asset>
      <title>Creating a ScreenSteps Live Support Site</title>
      <type>Manual</type>
      <id>customer_support_site</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
  <lesson>
    <title>How do I Download a Lesson to My ScreenSteps Library From ScreenSteps Live?</title>
    <url>http://help.bluemangolearning.com/m/screensteps_live/l/16630</url>
    <id type="integer">16630</id>
    <description>&lt;p&gt;All editing of lesson content is done in the ScreenSteps Desktop software. &lt;/p&gt;


&lt;p&gt;If the lesson is already in your lesson library then you can just re-upload it. If it is not then follow the directions below to download the lesson into your library.&lt;/p&gt;</description>
    <tags type="array">
      <tag>
        <name>Lessons</name>
      </tag>
    </tags>
    <asset>
      <title>ScreenSteps Live</title>
      <type>Manual</type>
      <id>screensteps_live</id>
    </asset>
    <space>
      <id>screensteps</id>
      <title>ScreenSteps Documentation</title>
      <url>http://help.bluemangolearning.com</url>
    </space>
  </lesson>
</lessons>

Topics

Quicklinks

Last Updated

Other Resources

ScreenSteps Desktop & Workgroup

ScreenSteps Live

Implementation Guides

FAQs

Comments

Spaces

Retrieve all Spaces -> /spaces

Retrieve a Single Space -> /spaces/#{space_id}

Search a Single Space -> /spaces/#{space_id}/searches?text=#{search_string}

Tags for a Space -> /spaces/#{space_id}/tags?tag=(tag_name}

Comments (0)

Add your comment