Check Out a Workflow Definition

Use this API to check out a Workflow definition.

Name

CDR_PUB_DF_WORKFLOW.CheckOutWorkFlow

Signature

PROCEDURE CHECKOUTWORKFLOW( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_CDRWORKFLOW  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2, 
  PI_ISINSTONLY  IN    VARCHAR2, 
  PI_OPTYPE  IN    VARCHAR2 
); 

Parameters

This API has standard parameters (see Standard Parameters) and the following parameters:

  • PIO_CDRWORKFLOW [Mandatory] This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Workflow definition that you want to check in.

    The following attributes are mandatory: COMPANY_ID, OBJECT_ID, OBJECT_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER. Initialize these attributes in CDR_BASE_OBJ_TYPE.

  • PI_COMMENT [Optional] Enter the reason for checking out the Workflow definition.
  • PI_ISINSTONLY (Mandatory) Enter $YESNO$NO. (The $YESNO$YES setting is used internally only.)
  • PI_OPTYPE (Mandatory) Enter NULL for this parameter.