deleteProgram

Purpose

This operation deletes a program in PPM Center.

Function

This operation deletes a program, identified by the program ID.

To perform this operation, the user must meet one of the following conditions:

  • Have the Edit All Programs access grant.

  • Be the manager of the program and have the Edit Programs access grant.

Input

Program ID

Return

If the operation is successful, nothing will be returned to the client.

Java Examples

ProgramServiceStub stub = new ProgramServiceStub(ctx, WSURL);
DeleteProgramDocument doc =
DeleteProgramDocument.Factory.newInstance();
DeleteProgram deleteProgram = doc.addNewDeleteProgram();
deleteProgram.setProgramId(programId);
DeleteProgramResponseDocument responseDoc =
stub.deleteProgram(doc);

Errors and Exceptions

Possible root cause descriptions:

Exception/Message Code

Message

Cause(s)

Possible Corrective Action

ObjectNotFoundException

No program found

The program ID or name is invalid.

Validate the program ID or name.

AuthorizationException

You do not have the privilege to take this action. Please consult your PPM Administrator.

The user has no access granted to delete programs.

Grant the appropriate access to the user. For more information, see Function