PublishingMonitorServices.GetPublishLogsForPubTarget Method

PublishingMonitorServicesGetPublishLogsForPubTarget Method

Ingeniux CMS Web Services API

Retrieves the collection of Publishing Logs basic information for specific Publishing Target. Each log contains the information of a completed Publishing Task.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PublishingLogSummaryReturn> GetPublishLogsForPubTarget(
	string pubTargetId,
	int start,
	int count
)

Public Function GetPublishLogsForPubTarget ( 
	pubTargetId As String,
	start As Integer,
	count As Integer
) As XHRServiceResponseGeneric(Of PublishingLogSummaryReturn)

public:
virtual XHRServiceResponseGeneric<PublishingLogSummaryReturn^>^ GetPublishLogsForPubTarget(
	String^ pubTargetId, 
	int start, 
	int count
) sealed

abstract GetPublishLogsForPubTarget : 
        pubTargetId : string * 
        start : int * 
        count : int -> XHRServiceResponseGeneric<PublishingLogSummaryReturn> 
override GetPublishLogsForPubTarget : 
        pubTargetId : string * 
        start : int * 
        count : int -> XHRServiceResponseGeneric<PublishingLogSummaryReturn>

Parameters

pubTargetId: Type: SystemString
Id of Publishing Target to get logs for
start: Type: SystemInt32
[Missing <param name="start"/> documentation for "M:IngeniuxCMService.PublishingMonitorServices.GetPublishLogsForPubTarget(System.String,System.Int32,System.Int32)"]
count: Type: SystemInt32
[Missing <param name="count"/> documentation for "M:IngeniuxCMService.PublishingMonitorServices.GetPublishLogsForPubTarget(System.String,System.Int32,System.Int32)"]

Return Value

Type: XHRServiceResponseGenericPublishingLogSummaryReturn

Array of Publishing Logs for given Publishing Target

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": [{
        "FileName": "publishLog_PublishingTargets_1-2014-01-28-11-37-41.xml",
        "PublishTime": "2014-01-28-11-37",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2014-01-28-11-37-05.xml",
        "PublishTime": "2014-01-28-11-37",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2014-01-28-11-37-00.xml",
        "PublishTime": "2014-01-28-11-37",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2014-01-28-11-36-57.xml",
        "PublishTime": "2014-01-28-11-36",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2014-01-28-11-35-47.xml",
        "PublishTime": "2014-01-28-11-35",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2014-01-27-10-18-29.xml",
        "PublishTime": "2014-01-27-10-18",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-16-56-35.xml",
        "PublishTime": "2013-12-11-16-56",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-16-56-29.xml",
        "PublishTime": "2013-12-11-16-56",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-14-34-18.xml",
        "PublishTime": "2013-12-11-14-34",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-12-18-55.xml",
        "PublishTime": "2013-12-11-12-18",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-11-54-52.xml",
        "PublishTime": "2013-12-11-11-54",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-11-54-25.xml",
        "PublishTime": "2013-12-11-11-54",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-11-53-23.xml",
        "PublishTime": "2013-12-11-11-53",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-11-20-32.xml",
        "PublishTime": "2013-12-11-11-20",
        "PublishingTargetID": "PublishingTargets\/1"
    }, {
        "FileName": "publishLog_PublishingTargets_1-2013-12-11-11-15-15.xml",
        "PublishTime": "2013-12-11-11-15",
        "PublishingTargetID": "PublishingTargets\/1"
    }]
}

Remarks

If Publishing Target doesn't exist, or it has never had a successful publish, returns empty collection

Reference

PublishingMonitorServices Class

IngeniuxCMService Namespace