QPR Knowledge Base 2016.1

DeleteObject

DeleteObject

Previous topic Next topic No directory for this topic  

DeleteObject

Previous topic Next topic Topic directory requires JavaScript Mail us feedback on this topic!  

Revision history:

Introduced in QPR 8.1

Last changed in QPR 2016.1

 

Deletes one or more objects identified by FulllID's supplied to the objectIds parameter.

 

Synopsis:

 

void DeleteObject(string sessionId, string objectIds, string options)

 

Return Value:

 

None.

 

Parameters:

 

sessionId: String. ID of an authenticated session.

objectIds: String. A comma-separated list of FullID's defining the objects that should be deleted. Note that deleting parent and child scorecards in the same request is not supported, so the objectIds list should not contain both parent and child scorecard ids.

options: A comma-separated list of options. Available options depend on the product and the object type. In addition, the following option is specifically supported to DeleteObject:

Recursive: true | false. Defines whether also child objects should be deleted. By default this is false. This option is not supported in the UM and SC namespaces.

 

Example Procedure:

 

ServiceClient client = new ServiceClient("WSHttpBinding_IService");

string sessionId = client.Authenticate("qpr", "demo");

client.DeleteObject(sessionId, "PO.0.56789", "");

client.LogOff(sessionId);

client.Close();