This method generates pages based on the data previously loaded into a data container.
Notes : The relative URL of the page (/zzz) for each data item is a field you include when you load your data items. The full URL for that item's page is generated based on the siteId you provide for the data item (in the 'loaddataitems' method). Our platform looks up that site's domain by the siteId, and generates the full URL for the data item's page (e.g. 'mysite.mobi/zzz'). If another page already exists on this full URL, and the page was created with API templates for the same data item, the page will be updated.
Request Information
Headers
Name | Description | Type | Additional information |
---|---|---|---|
Authentication |
Authentication token |
string |
Required |
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
containerid |
Id of the API data container for generate pages. |
integer |
Required |
Body Parameters
You can include specific Item Ids to generate pages for specific data items, or you can leave this parameter blank to generate pages for all data items in the specified container. Please note that we are currently limiting the number of requests for this method to approximately 2 requests per minute per API key. (In other words, if you need to generate pages for 100 specific data items, include them all in the array in one method request.)
Collection of ApiGeneratePagesRequestName | Description | Type | Additional information |
---|---|---|---|
ItemId |
Your Item ID |
integer |
Required |
Request Formats
application/json
[ { "ItemId": 1 }, { "ItemId": 1 } ]
Response Information
Resource Description
Returns the job id of this page generation task. You can use this job id to check on the status of the task.
Name | Description | Type | Additional information |
---|---|---|---|
Data | ApiGeneratePagesResponse |
None. |
|
Success | boolean |
None. |
|
Messages | Collection of ErrorMessage |
None. |
Response Formats
application/json
{ "Data": null, "Success": false, "Messages": null }