Collection.GetPublisher

Updated on 14 May 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

Returns a list of collections and their current publishing configuration.

Note

The PublishWhenAgentCompletes field will be removed if the collection is publishing on a schedule.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

CollectionID or AgentID (comma separated lists)

Name	Required	Type	Description
`CollectionID`	False	numeric	Unique identifier of the collection.
`AgentID`	False	numeric	Unique identifier of the agent.

Responses

A list of collections with their current publishing configuration.

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`Collection (Publisher)`	Collection	An object representing the collection and its corresponding publish settings.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.GetPublisher&CollectionID=131794&AgentID=152029'

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<GetPublisherResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>
  <CollectionList>
    <Collection>
      <CollectionName>BuilderWelcome-FileDownloads</CollectionName>
      <CollectionID>131794</CollectionID>
      <AgentID>152029</AgentID>
      <PublishWhenAgentCompletes>True</PublishWhenAgentCompletes>
      <Created>2023-11-29 10:34:32</Created>
      <CreatedBy>Curtis, Christopher</CreatedBy>
      <Description />
      <ViewID>151876</ViewID>
      <BookmarkID>0</BookmarkID>
      <FileFormat>JSON</FileFormat>
      <FileName />
      <FileIncludeHeader>True</FileIncludeHeader>
      <FileCompressionFormat>zip</FileCompressionFormat>
      <FilePackageCompressionFormat>sevenzip</FilePackageCompressionFormat>
      <Method>AmazonS3</Method>
      <IncludePackages>True</IncludePackages>
      <ItemStatusIncludeColumn>False</ItemStatusIncludeColumn>
      <ItemStatusIncludeAdded>False</ItemStatusIncludeAdded>
      <ItemStatusIncludeChanged>False</ItemStatusIncludeChanged>
      <ItemStatusIncludeChangeMarkup>False</ItemStatusIncludeChangeMarkup>
      <ItemStatusIncludeUnchanged>False</ItemStatusIncludeUnchanged>
      <ItemStatusIncludeRemoved>False</ItemStatusIncludeRemoved>
      <SearchText />
      <SearchField />
      <AmazonS3AuthenticationToken>AuthenticationToken></AmazonS3AuthenticationToken>
      <AmazonS3SignRequestToken>SignRequestToken</AmazonS3SignRequestToken>
      <AmazonS3BucketPath>moztestingbucket/gzipped</AmazonS3BucketPath>
      <AmazonS3BucketRegion>bucketregion.amazonaws.com</AmazonS3BucketRegion>
    </Collection>
  </CollectionList>
</GetPublisherResponse>

JSON - (add `&ResponseFormat=JSON`)

{
  "Collection": [
    {
      "CollectionName": "BuilderWelcome-FileDownloads",
      "CollectionID": 131794,
      "AgentID": 152029,
      "Created": "2023-11-29 10:34:32",
      "CreatedBy": "Curtis, Christopher",
      "Description": "",
      "ViewID": 151876,
      "BookmarkID": 0,
      "FileFormat": "JSON",
      "FileName": "",
      "FileIncludeHeader": "True",
      "FileCompressionFormat": "zip",
      "FilePackageCompressionFormat": "sevenzip",
      "Method": "AmazonS3",
      "IncludePackages": "True",
      "ItemStatusIncludeColumn": "False",
      "ItemStatusIncludeAdded": "False",
      "ItemStatusIncludeChanged": "False",
      "ItemStatusIncludeChangeMarkup": "False",
      "ItemStatusIncludeUnchanged": "False",
      "ItemStatusIncludeRemoved": "False",
      "SearchText": "",
      "SearchField": "",
      "AmazonS3AuthenticationToken": "AuthenticationToken",
      "AmazonS3SignRequestToken": "SignRequestToken",
      "AmazonS3BucketPath": "moztestingbucket/gzipped",
      "AmazonS3BucketRegion": "bucketregion.amazonaws.com"
    }
  ],
  "JsonResult": {
    "Command": "Collection.GetPublisher",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?

What's Next

Collection.GetViews