site/jobs/import (POST)
Overview
Schedules a site import
- REST Method: POST
- Method Access: public
Query Parameters
Name | Type | Description |
dryrun | bool? | Perform a dry run of the import to diagnose potential content problems (default: false) |
Return Codes
Name | Value | Description |
OK | 200 | The request completed successfully |
Bad Request | 400 | Invalid input parameter or request body |
Forbidden | 403 | The user must be an Administrator |
Message Format
Input:
<job> <notification> <email>{text}</email> </notification> <archive> <url>{uri}</url> </archive> </job>
<job> <notification> <url>{uri}</url> </notification> <archive> <url>{uri}</url> </archive> </job>
<job> <notification> <email>{text}</email> <url>{uri}</url> </notification> <archive> <url>{uri}</url> </archive> </job>
Output:
<job id="{text}" type="{text}" status="{text}"> <submitted>{date}</submitted> <lastmodified>{date}</lastmodified> <data> <{key}>{value}</{key}> ... </data> <user id="{int}" href="{uri}"> <nick>{text}</nick> <username>{text}</username> <email>{text}</email> <page.home id="{int}" href="{int}"> <title>{text}</title> <path>{text}</path> </page.home> <fullname /> <status>{active|inactive}</status> <date.lastlogin>{date}</date.lastlogin> <service.authentication id="{int}" href="{uri]" /> <permissions.user> <operations mask="{int}">{text}</operations> <role id="{int}" href="{uri}">{text}</role> </permissions.user> <permissions.effective> <operations mask="{int}">{text}</operations> </permissions.effective> <groups count="{int}" href="{uri}"> <group id="{int}" href="{uri}"> <name>{text}</name> <service.authentication id="{int}" href="{uri}" /> <users count="{int}" href="{uri}" /> <permissions.group> <operations mask="{int}">{text}</operations> <role id="{int}" href="{uri}">{text}</role> </permissions.group> </group> ... </groups> </user> </job>
Remarks
Request must be made using a Developer API Token.