1. API Guide
  2. Oracle Health Sciences Data Management Workbench APIs
  3. Flags, Categories, and Actions

31 Flags, Categories, and Actions

This is a public interface for operations related to flags and actions. It contains the following topics:

Parent topic: Oracle Health Sciences Data Management Workbench APIs

Flag-Related APIs

This section contains the following procedures related to flags in the package DME_PUB_FLAG_DATA.

Note:

A program that calls any of these flag APIs must call DME_PUB_INITIALIZATION.SetupAPIStudyEnvironment to set the study and lifecycle context after calling CDR_PUB_API_INITIALIZATION.enableAPIs.

Parent topic: Flags, Categories, and Actions

Set Flag

Use this API to set the state of a single flag for a given record.

Name

DME_PUB_FLAG_DATA.SetFlag

Signature

PROCEDURE SETFLAG, 
( P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_TAB_OBJ_ID IN NUMBER,
PI_SKEY_VALUE IN VARCHAR2,
PI_TIMESTAMP IN DATE,
PI_FLAG_ID IN NUMBER,
PI_FLAG_STATE IN VARCHAR2,
  );

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_TAB_OBJ_ID (Mandatory). Enter the object ID of the table instance that contains the data record.
  • PI_SKEY_VALUE (Mandatory). Enter the surrogate key of the record.
  • PI_TIMESTAMP Enter the latest timestamp of the data record. The system tracks which version of the record the flag was initially applied to.
  • PI_FLAG_ID (Mandatory). Enter the unique ID of the flag (from dme_flag_names)
  • PI_FLAG_STATE (Mandatory). The flag state to be applied for the data record.

Parent topic: Flag-Related APIs

Get Flag

Use this API to retrieve information about an Oracle DMW flag setting.

Name

DME_PUB_FLAG_DATA.GetFlag

Signature

PROCEDURE GETFLAG
( P_API_VERSION IN VARCHAR2,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_TAB_OBJ_ID IN NUMBER,
PI_SKEY_VALUE IN VARCHAR2,
PI_FLAG_ID IN NUMBER,
PO_FLAG_STATE OUT NOCOPY VARCHAR2,
);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_TAB_OBJ_ID (Mandatory). Enter the obj_id of the table instance that contains the data record.
  • PI_SKEY_VALUE (Mandatory).The surrogate key of the record
  • PI_FLAG_ID (Mandatory). The unique ID of the flag (from dme_flag_names)
  • PO_FLAG_STATE (Mandatory). This output parameter inherits the flag state for this record.

Parent topic: Flag-Related APIs

Get Flags on Data

This API retrieves all the flags and their states, assigned to a particular data record, plus the latest update timestamp for each flag category per record.

It does not provide a timestamp for each individual flag update. If you want to see the update timestamp for a particular flag, you can create a category for that one flag.

Name

DME_PUB_FLAG_DATA.GetFlagsOnDataMore

Signature

PROCEDURE getFlagsOnDataMore
  ( p_api_version IN VARCHAR2
  , p_init_msg_list IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE
  , p_commit IN VARCHAR2 default CDR_PUB_DEF_CONSTANTS.G_FALSE
  , p_validation_level IN NUMBER default CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL
  , x_return_status OUT NOCOPY VARCHAR2
  , x_msg_count OUT NOCOPY NUMBER
  , x_msg_data OUT NOCOPY VARCHAR2
  , pi_company_id IN NUMBER
  , pi_tab_obj_id IN NUMBER
  , pi_skey_value IN VARCHAR2
  , pi_include_nulls IN NUMBER
  , po_flags OUT NOCOPY dme_flag_show_more_coll
 ) ;

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_TAB_OBJ_ID (Mandatory). This input parameter is an object ID for a namings object of type $OBJTYPES$TABLEREF (table instance).
  • PI_SKEY_VALUE (Mandatory). Enter the surrogate key of the record whose flags you want to retrieve.
  • PI_INCLUDE_NULLS (Mandatory). Set this input parameter to 1 to include information for flags with NULL state, else 0.
  • PO_FLAGS (Output). This is a parameter of type DME_FLAG_SHOW_MORE_COLL that returns:
    • Flag ID
    • Flag Name
    • Flag Value
    • Flag State Priority Code
    • Flag State Priority Meaning
    • Category ID
    • Most Recent Category Update Date (The most recent update of any flag in the category.)
    • Category Update User ID (The user ID of the user or validation check that performed the most recent flag assignment update in the category.)
    • Category Update Username (The name of the user or validation check that performed the most recent flag assignment update in the category.)

Parent topic: Flag-Related APIs

Delete Flag

Use this API to delete an existing DMW Flag state.

Name

DME_PUB_FLAG_DATA.DeleteFlag

Signature

PROCEDURE DELETEFLAG 
(P_API_VERSION IN VARCHAR2,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_TAB_OBJ_ID IN NUMBER,
PI_SKEY_VALUE IN VARCHAR2,
PI_FLAG_ID IN NUMBER,

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_TAB_OBJ_ID (Mandatory). This input parameter is an object id for a namings object of type $OBJTYPES$TABLEREF (table instance).
  • PI_SKEY_VALUE (Mandatory). The surrogate key of the record.
  • PI_FLAG_ID (Mandatory). This input parameter is the ID of the flag whose state you want to remove.

Parent topic: Flag-Related APIs

Get Surrogate Key Values for Records in a Flag State

Use this API to get the surrogate keys for all records in a table that have the given state for the given flag.

Name

DME_PUB_FLAG_DATA.getRecordsForFlagState

Signature

PROCEDURE getRecordsForFlagState 
( p_api_version IN VARCHAR2  
 , p_init_msg_list IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE
 , p_commit IN VARCHAR2 default CDR_PUB_DEF_CONSTANTS.G_FALSE
 , p_validation_level IN NUMBER default CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL
 , x_return_status OUT NOCOPY VARCHAR2
 , x_msg_count OUT NOCOPY NUMBER
 , x_msg_data OUT NOCOPY VARCHAR2
 , pi_company_id IN NUMBER
 , pi_tab_obj_id IN NUMBER
 , pi_flag_id IN NUMBER
 , pi_flag_state IN VARCHAR2
 , pi_records OUT NOCOPY dme_char_coll);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_TAB_OBJ_ID (Mandatory). Enter the object id for a namings object of type $OBJTYPES$TABLEREF (table instance) that contains the record.
  • PI_FLAG_ID (Mandatory). Enter the ID of the flag.
  • PI_FLAG_STATE (Mandatory). Enter the flag state.
  • PI_RECORDS This output parameter is a collection of type dme_char_coll.

Parent topic: Flag-Related APIs

Flag Name-Related APIs

Use the following APIs in the package DME_PUB_FLAG_NAME to retrieve DMW flag names definitions and states. Use the first version of these APIs if you know the flag ID; use the second one if you know its name.

Note:

A program that calls any of these flag APIs must call DME_PUB_INITIALIZATION.SetupAPIStudyEnvironment to set the study and lifecycle context after calling CDR_PUB_API_INITIALIZATION.enableAPIs.

This section includes the following:

Parent topic: Flags, Categories, and Actions

Get Flag Name Definition, Version 1

Use this API to retrieve information about an Oracle DMW flag name definition. Use this API if you know the Flag Name ID.

Name

DME_PUB_FLAG_NAME.GetFlagName

Signature

PROCEDURE GETFLAGNAME
(P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_FLAG_NAME_ID IN NUMBER,
PIO_DME_FLAG_NAME IN OUT NOCOPY DME_FLAG_NAME_TYPE,
  );

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_FLAG_NAME_ID (Mandatory). Enter the ID of the flag name definition to be retrieved.
  • PIO_DME_FLAG_NAME (Mandatory). This is a parameter of type DME_FLAG_DEF_NAME for the returned values.

Parent topic: Flag Name-Related APIs

Get Flag Name Definition, Version 2

Use this API to retrieve information about an Oracle DMW flag name definition. Use this API if you know the flag name.

Name

DME_PUB_FLAG_NAME.GetFlagName

Signature

PROCEDURE GETFLAGNAME
(P_API_VERSION IN VARCHAR2,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_FLAG_NAMESTR IN VARCHAR2,
PIO_DME_FLAG_NAME IN OUT NOCOPY DME_FLAG_NAME_TYPE,
);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_FLAG_NAMESTR (Mandatory). Enter the name of the flag name definition to be retrieved.
  • PIO_DME_FLAG_NAME (Mandatory). This is a parameter of type DME_FLAG_DEF_NAME for the returned values.

Parent topic: Flag Name-Related APIs

Get Flag Name Definitions

Use this API to retrieve information about DMW flag name definitions.

Name

DME_PUB_FLAG_NAME.GetFlagNames

Signature

PROCEDURE GETFLAGNAMES
( P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_CATEGORY_ID IN NUMBER DEFAULT NULL,
PI_SUBJECT_VISIT IN VARCHAR2 DEFAULT NULL,
PI_USER_SETTABLE IN VARCHAR2 DEFAULT NULL,
PO_FLAG_NAMES OUT NOCOPY DME_FLAG_NAME_COLL,
  );

Parameters

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

  • PI_CATEGORY_ID (Optional). Set to null to retrieve flags in all categories. To get flags from a given category, provide a valid category ID.
  • PI_SUBJECT_VISIT (Optional). Set to null to retrieve all flags irrespective of their being marked as subject_visit flags or not. To retrieve only subject_visit flags, enter either $YESNO$YES. To retrieve only record flags, enter $YESNO$NO.
  • PI_USER_SETTABLE (Optional). Set to null to retrieve flags whether or not they are settable by the user. To retrieve only user-settable flags, enter $YESNO$YES. To retrieve flags not settable by users, enter $YESNO$NO.
  • PO_FLAG_NAMES (Mandatory). This is a parameter of type DME_FLAG_NAME_COLL for the returned values.

Parent topic: Flag Name-Related APIs

Get Flag States

Use this API to retrieve information about all the DMW flag states for a single flag.

Name

DME_PUB_FLAG_STATE.GetFlagStates

Signature

PROCEDURE GETFLAGSTATES
(P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_FLAG_NAME_ID IN NUMBER,
PO_DME_FLAG_STATES OUT NOCOPY DME_FLAG_STATE_COLL,
);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_FLAG_NAME_ID (Mandatory). Enter the ID of the flag.
  • PO_DME_FLAG_STATES (Mandatory). This is a parameter of type DME_FLAG_STATE_COLL for the returned information.

Parent topic: Flags, Categories, and Actions

Clinical Data Model Category-Related APIs

This section includes the following:

Note:

You can create categories in the Oracle DMW Administration user interface.

Parent topic: Flags, Categories, and Actions

Create Model Flag Category Mapping

Use this API to create a map between a model type and subtype and a flag category.

Name

DME_PUB_MODEL_FLAGCAT.CreateModelFlagcatMap

Signature

PROCEDURE CREATEMODELFLAGCATMAP,
(P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_MODEL_TYPE_RC IN VARCHAR2,
PI_MODEL_SUBTYPE_RC IN VARCHAR2,
PI_CATEGORY_ID IN NUMBER,
);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_MODEL_TYPE_RC (Mandatory). Enter a model type from the lookup CDR_MODELTYPES such as $MODELTYPE$INPUT.

    If you want to map a flag category to input models that come from files, pass these two arguments as '$MODELTYPE$INPUT' and '$INPUTMODTYPE$FILE'.

    If you want to map a flag category to input models from InForm, pass these two arguments as '$MODELTYPE$INPUT' and '$INPUTMODTYPE$INFORM'.

    If you want to map a flag category to target models, pass these arguments as '$MODELTYPE$TARGET' and NULL.

  • PI_MODEL_SUBTYPE_RC (Mandatory). Enter a model subtype; for example, $MODELTYPE$INPUT or $MODELTYPE$TARGET
  • PI_CATEGORY_ID (Mandatory). Enter the unique ID of the category (from dme_categories in the Administration Area of the DMW User Interface).

Parent topic: Clinical Data Model Category-Related APIs

Get Categories for Model

Use this API to get all categories that are valid for a model type and subtype.

Name

DME_PUB_MODEL_FLAGCAT.GetCategoriesForModel

Signature

PROCEDURE GETCATEGORIESFORMODEL,  
P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_COMPANY_ID IN NUMBER,
PI_MODEL_TYPE_RC IN VARCHAR2,
PI_MODEL_SUBTYPE_RC IN VARCHAR2,
PO_CATEGORIES OUT NOCOPY DME_NUMBER_COLL,
);

Parameters

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

  • PI_COMPANY_ID (Mandatory). Enter the company ID.
  • PI_MODEL_TYPE_RC (Mandatory). Enter a model type such as $MODELTYPE$INPUT, from the lookup CDR_MODELTYPES.
  • PI_MODEL_SUBTYPE_RC (Mandatory). Enter a model subtype; for example, $INPUTMODTYPE$FILE.
  • PO_CATEGORIES Output parameter returns an array of category IDs.

Parent topic: Clinical Data Model Category-Related APIs

Action-Related APIs

Use the following APIs to perform tasks related to discrepancy actions:

Parent topic: Flags, Categories, and Actions

Create Discrepancy Action

Use this API to create a new discrepancy action.

Name

DME_PUB_DISC_ACTION.CreateDiscAction

Signature

PROCEDURE CREATEDISCACTION   (P_API_VERSION IN VARCHAR2,   P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,   P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,   P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,   X_RETURN_STATUS OUT NOCOPY VARCHAR2,   X_MSG_COUNT OUT NOCOPY NUMBER,   X_MSG_DATA OUT NOCOPY VARCHAR2,   PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE,) ;

Parameters

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

PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE that contains action attributes.

Enter the Start State, one of Candidate, Open, Answered, Cancelled, Closed. (In the API those are specified as $DISC_STATES$CANDIDATE, $DISC_STATES$OPEN. $DISC_STATES$ANSWERED, $DISC_STATES$CANCELLED, and $DISC_STATES$CLOSED).

Parent topic: Action-Related APIs

Get Discrepancy Action, Version 1

Use this API to retrieve information about an Oracle DMW Discrepancy Action.

Name

DME_PUB_DISC_ACTION.GetDiscAction

Signature

PROCEDURE GETDISCACTION( P_API_VERSION IN VARCHAR2,  P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,  P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,  P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,  X_RETURN_STATUS OUT NOCOPY VARCHAR2,  X_MSG_COUNT OUT NOCOPY NUMBER,  X_MSG_DATA OUT NOCOPY VARCHAR2,  PI_ACTION_ID IN NUMBER,  PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE,  );

Parameters

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

  • PI_ACTION_ID (Mandatory). Enter the ID of the discrepancy action to retrieve information for it.
  • PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE for the returned values.

Parent topic: Action-Related APIs

Get Discrepancy Action, Version 2

Use this API to retrieve information about an Oracle DMW Discrepancy Action.

Name

DME_PUB_DISC_ACTION.GetDiscAction

Signature

PROCEDURE GETDISCACTION,
( P_API_VERSION IN VARCHAR2,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_ACTION_NAME IN VARCHAR2,
PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE,
);

Parameters

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

  • PI_ACTION_NAME (Mandatory). Provide the name of the discrepancy action to retrieve information for it.
  • PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE for the returned values.

Parent topic: Action-Related APIs

Update Discrepancy Action

Use this API to modify an existing DMW Discrepancy Action.

Name

DME_PUB_DISC_ACTION.UpdateDiscAction

Signature

PROCEDURE UPDATEDISCACTION,
( P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PIO_DME_DISC_ACTION IN OUT NOCOPY DME_DISC_ACTION_TYPE,
  );

Parameters

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

  • PIO_DME_DISC_ACTION (Mandatory). This is a parameter of type DME_DISC_ACTION_TYPE that contains the discrepancy action attributes to be updated.

Parent topic: Action-Related APIs

Delete Discrepancy Action

Use this API to delete an existing DMW Discrepancy Action.

Name

DME_PUB_DISC_ACTION.DeleteDiscAction

Signature

PROCEDURE DELETEDISCACTION,
(P_API_VERSION IN VARCHAR2,   
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_DME_DISC_ACTION_ID IN NUMBER,
);

Parameters:

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

  • PI_DME_DISC_ACTION_ID (Mandatory). This is a parameter of type NUMBER, that contains the unique ID of the category to be disabled.

Parent topic: Action-Related APIs