POST api.ashx/v2/articles/publishgroup/{collectionid}.{json|xml}
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
CollectionId | Guid | Request Body | Id of the collection to create the publish group in. | Required | ||
Name | string | Request Body | Name of the publish group. | Required | ||
PublishDate | DateTime | Request Body | Date when all associated article versions that are ready to publish will be published. | Optional | ||
PublishEndDate | DateTime | Request Body | Date when all associated published article versions will be unpublished. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.post({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/articles/publishgroup/{collectionid}.json', data: { 'collectionid': '49fec544-6df7-4a82-872b-f8be586d5e9e', 'Name': 'name' } }).then(function(response) { // use response });
Example Responses
JSON
{ "PublishGroups": { "Name": "name", "Data": {}, "Errors": [ "string", "string" ] }, "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <PublishGroups> <Name>name</Name> <Data /> <Errors> <string>string</string> <string>string</string> </Errors> </PublishGroups> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>