pages

Create a Page

This method creates a new page. It supports three modes: 1) Upload an XLSX file for bulk page creation (multipart form data) 2) Process a previously uploaded XLSX file (pass xlsx_path parameter) 3) Create a single page via JSON body. When using a template, all variables defined in the template must be included in opts_json.

post/areas/{area_id}/services/{svc_id}/pages

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/areas/{area_id}/services/{svc_id}/pages
  • Auth: none declared

Path parameters

area_idstring required

Area ID or Area name can be used.

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Request body

setsstring[]

Array of page set names to associate with the page.

auto_translateboolean

If true and the service supports auto-translation, the page will be translated.

contentstring

JSON string containing the page content sections and rows. Defaults to '[]'.

opts_jsonstring

JSON string containing page options. Must include a 'variables' array with at minimum a 'title' variable containing the localized page title. When using a template, all template variables must be present.

namestring

The page name (URL slug). If not provided, derived from the title.

scriptsstring

Custom scripts for the page.

page_typestring

The type of page (e.g. material, stream, depot, app, template, other).

localestring

The locale for the page (e.g. en, en-US, fr). Defaults to 'en'.

tagsstring

Array of tag strings, or a comma-separated string of tags.

linksstring

JSON string containing an array of page links to create.

script_languagestring

The scripting language used by the page.

Response

200 OK

localestring
page_typestring
updated_atstring date-time
namestring
service_idinteger
tagsstring[]
idinteger
created_atstring date-time
titlestring
setstring
contentstring

Changes

No recorded changes to this operation across all 1 revision of this API.