Initializes a Housekeeping policy for an entity selection


Endpoint ID:

1200

Method
URL:

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


policyID

A GUID identifying the Housekeeping policy to trigger

Request body:

The request contains a single property "entities" which contains an array of entity references. The references include either a Rubiq entityID, or an external key and type pair.

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


{
	"entities": [
        { "extKey": "user1@domain.org", "extType": 1001 },
        { "extKey": "user2@domain.org", "extType": 1001 },
        { "extKey": "user3@domain.org", "extType": 1001 }
    ]
}



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.1

One of the entities could not be found

404.2One of the entity external keys was not recognized
404.4policyID not found