Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

Initializes a Housekeeping policy for an entity selection
Endpoint ID:

1200

Method
POST
URL:

/housekeeping/policy/{policyID}/trigger-for-selection


policyID

A GUID identifying the Housekeeping policy to trigger

Request body:

An array of entityIDs which comprise the Housekeeping selection

{
	"entities": [12345, 23456, 34567]
}

Response body:

An execution ID, identifying the asynchronous policy execution that has been triggered.

{
	"executionID": 12345
}
Status codes:

HttpStatusCode
ApiStatusSubCode
Description
200
The policy schedule has been triggered
400
The policy has not been configured correctly
412412.1The policy schedule may not be triggered by the API in this way
404404.4

policyID not found

  • No labels