MarkForPublishServicesMarkAssets Method

Ingeniux CMS Web Services API

Marks/unmarks the given Assets for publish on provided Publishing Targets. All involved pages will be marked the same way.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<AssetCommandReturnInformation> MarkAssets(
	MarkPageInput data,
	string pubTarget
)

Parameters

data
Type: MarkPageInput

The instructions on Asset's publish marking

Examples

Sample JSON input
JavaScript
{
    "pageIds": [
      "a/160"
    ],
    "markForPublish": [],
    "unmarkForPublish": [],
    "recursive": false
}
pubTarget
Type: SystemString
The id of current Publishing Target. It is used to construct Asset properties information on the result object.

Return Value

Type: XHRServiceResponseGenericAssetCommandReturnInformation

The information of affected Assets(s) after mark for publishing is done.

Examples

Sample JSON return
JavaScript
{
    "assets": [
      {
        "id": "a/160",
        "props": {
          "name": "flexTable",
          "allowedCategoryRoots": [],
          "ancestors": [
            "af/12"
          ],
          "assignedGroup": null,
          "assignedUser": null,
          "canClaimPage": false,
          "checkedOut": false,
          "error": null,
          "icon": 15,
          "isAssignedToOtherUser": false,
          "isEditable": false,
          "isFolder": false,
          "isInWorkflow": false,
          "justRecycled": false,
          "languageRootId": "",
          "lingualMaps": {
            "clones": [],
            "fullInfo": false,
            "master": null
          },
          "locale": "",
          "localeInherited": true,
          "markedForPublish": true,
          "markedForPublishAny": true,
          "markedForPublishPropagated": true,
          "nextPageIndex": 0,
          "noDnd": false,
          "pageId": "a/160",
          "parentId": "af/12",
          "pendingMasterVersion": 0,
          "referenceProps": {
            "created": "20180403T22:11:20",
            "createdBy": "test",
            "endDate": "",
            "lastModified": "20180403T22:11:55",
            "lastModifiedBy": "User/test",
            "publishAs": "",
            "startDate": ""
          },
          "remoteServer": "",
          "schemaFriendlyName": "CSS",
          "schemaName": "CSS",
          "schemaOnLatestVersion": true,
          "securityLevel": 2,
          "userCanCopyPage": true,
          "workflow": null,
          "assetSummary": {
            "allowedExtensions": [
              ".css",
              ".less",
              ".sass",
              ".scss"
            ],
            "audioCodec": null,
            "audioCodecVersion": null,
            "dimensions": null,
            "dpi": 0,
            "duration": null,
            "videoCodec": null,
            "videoCodecVersion": null
          },
          "assetType": "Css",
          "comments": "",
          "extension": ".css",
          "externalUrl": "",
          "fileSize": 131,
          "isUnmanaged": false,
          "sourceUri": null
        }
      }
    ],
    "contentChanged": false,
    "folders": [],
    "operationPageCount": 0,
    "pageAction": "markforpublish",
    "properties": {
      "__type": "AssetProperties:#IngeniuxCMService",
      "name": "flexTable",
      "allowedCategoryRoots": [],
      "ancestors": [
        "af/12"
      ],
      "assignedGroup": null,
      "assignedUser": null,
      "canClaimPage": false,
      "checkedOut": false,
      "error": null,
      "icon": 15,
      "isAssignedToOtherUser": false,
      "isEditable": false,
      "isFolder": false,
      "isInWorkflow": false,
      "justRecycled": false,
      "languageRootId": "",
      "lingualMaps": {
        "clones": [],
        "fullInfo": false,
        "master": null
      },
      "locale": "",
      "localeInherited": true,
      "markedForPublish": true,
      "markedForPublishAny": true,
      "markedForPublishPropagated": true,
      "nextPageIndex": 0,
      "noDnd": false,
      "pageId": "a/160",
      "parentId": "af/12",
      "pendingMasterVersion": 0,
      "referenceProps": {
        "created": "20180403T22:11:20",
        "createdBy": "test",
        "endDate": "",
        "lastModified": "20180403T22:11:55",
        "lastModifiedBy": "User/test",
        "publishAs": "",
        "startDate": ""
      },
      "remoteServer": "",
      "schemaFriendlyName": "CSS",
      "schemaName": "CSS",
      "schemaOnLatestVersion": true,
      "securityLevel": 2,
      "userCanCopyPage": true,
      "workflow": null,
      "assetSummary": {
        "allowedExtensions": [
          ".css",
          ".less",
          ".sass",
          ".scss"
        ],
        "audioCodec": null,
        "audioCodecVersion": null,
        "dimensions": null,
        "dpi": 0,
        "duration": null,
        "videoCodec": null,
        "videoCodecVersion": null
      },
      "assetType": "Css",
      "comments": "",
      "extension": ".css",
      "externalUrl": "",
      "fileSize": 131,
      "isUnmanaged": false,
      "sourceUri": null
    },
    "queryString": {
      "assignTargetId": null,
      "assignToGroup": null,
      "comment": null,
      "includeChildren": false,
      "newPageName": null,
      "pageAction": null,
      "pageId": null,
      "pageIds": null,
      "transitionId": null
    }
}
Remarks

If we are marking on multiple assets, we can only mark/unmark each asset on its current version. Otherwise, we can mark asset on any of its available previous versions.

See Also

Reference