Request Publishing
Request publishing workflow.
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/workflow/submit-to-go-live.json |
Response Formats
|
JSON |
Required Role
|
N/A
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site to use
|
user
|
String
|
✓
|
User requesting publishing
|
sendEmail
|
String
|
✓
|
True to send email notifications, otherwise false
|
Example
Request
POST .../api/1/services/api/1/workflow/submit-to-go-live.json?site_id=mysite&user=author
1{
2 "sendEmail" : true,
3 "schedule" : "now",
4 "submissionComment" : "",
5 "environment" : "live"
6 "items" : [
7 "/site/website/index.xml"
8 ]
9}
Response
Status 200 OK
{
"status" : 200,
"commitId" : null,
"message" : "An email notification has been sent to the team. Your content will be reviewed and (if approved) pushed live between 4PM EST and 6PM EST of the business day that the request was received. If this request is sent after business hours, it will be reviewed and (if approved) pushed live as soon as possible, the next business day.<br/><br/>If you need to make further revisions to this item, please re-submit this publish request after making them.<br/><br/>If this request needs immediate attention, please email the administrator.",
"item" : null,
"success" : true,
"invalidateCache" : false
}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|