• Document Up to Date

Publish Items

Publish a list of items. This will automatically calculate dependencies, drop items and dependencies from any existing workflows and add them to a new publish package.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /studio, please prefix the API URLs with this context.

HTTP Verb
POST
URL
/api/1/services/api/1/publish/publish-items.json
Response Formats
JSON
Required Role
Site admin, or has publish permission in this site

Parameters

Name
Type
Required
Description
site_id
String
Site to use
environment
String
Environment to publish to
schedule
Datetime

Schedule when to publish
submission_comment
Datetime

Schedule when to publish
entities
Array
List of items to publish

Example

POST .../api/1/services/api/1/publish/publish-items.json?site_id=mysite
 1{
 2    "environment" : "live",
 3    "entities" : [
 4        {
 5            "item" : "/path/to/item1.xml",
 6        },
 7        {
 8            "item" : "/path/to/item2.xml",
 9        }
10    ]
11}

Response

{
  "message" : "OK"
}

Responses

Status
Response Body
200
{ "message" : "OK" }
400
{ "message" : "Invalid parameter(s)" }
400
{ "message" : "Bad Request" }
401
{ "message" : "Unauthorized" }
404
{ "message" : "Site not found" }
404
{ "message" : "Environment not found" }
500

{ "message" : "Internal server error.
ACTUAL_EXCEPTION" }