ScreenStepsScreenSteps API v2 JSON APICreating Manuals, Chapters and Articles through the API (beta)

Creating Manuals, Chapters and Articles through the API (beta)

This article describes how to create Manuals, Chapter and Articles via the API.

All updates you make via the API will appear in Activity logs as if they were done by the user whose credentials are used when making the API calls.

1. Create a Manual

URL

POST /api/v2/sites/:site_id/manuals

Body

manual: {
  title: "My title",
  published: false,
  chapters: [
    { position: 1, title: "Chapter 1", published: false },
    { position: 2, title: "Chapter 2", published: false },
  ]
}

Explanation

Key
Value
title
Manual title. Up to 255 characters.
published
Boolean
chapters
Optional array of a chapter JSON hashes. Each hash must contain:

  • position
  • title
The pubished key is optional.
2. Update a Manual

URL

PUT /api/v2/sites/:site_id/manuals/:id

Body

Body is the same as is used when creating a manual except that the chapters array is ignored.

3. Create a Chapter

URL

POST /api/v2/sites/:site_id/chapters

Body

chapter: {
  position: 1,
  title: "My title",
  published: false,
  manual_id: 4415
}

Explanation

Key
Value
position
Position of the chapter in the manual
title
Chapter title. Up to 255 characters.
published
Boolean
manual_id
ID of the manual the chapter is assigned to.
4. Update a Chapter

URL

PUT /api/v2/sites/:site_id/manuals/:id

Body

Body is the same as is used when creating a chapter.

0 Comments

Add your comment

E-Mail me when someone replies to this comment