This API will add a content object to a case instance.

Parameters

pObj: The content object to add to the case.

Returns

boolean: Returns"true" if the operation succeeds

Example

var newCase = Case.CreateCase(bp, "CASEID");
newCase.AddToCase(CurrentForm);

This API will create a new instance of a Case object.

Parameters

bp: The Process Director environment.

pCASEID: The CaseID of the Case definition.

Returns

object: A Case Object.

Example

var newCase = Case.CreateCase(bp, "CASEID");

This API will return a specified Case object.

Parameters

bp: The Process Director environment.

pCASEID: The CaseID of the Case definition.

Returns

object: A Case Object.

Example

var myCase = Case.GetCaseByCASEID(bp, "CASEID");

This API will return a specified Case object.

Parameters

bp: The Process Director environment.

pCASEINSTID: The CaseInstanceID of the Case instance.

Returns

object: A Case Object.

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");

This API will return a List object containing all of the properties for a Case.

Parameters

None

Returns

list <object>: A list of Case property objects.

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
List<NameValueEx> myVals = myCase.GetCaseProperties();
// Get the first value from the list
string val = myVals[0].Value;

This API will return the specified property of a Case object. This API will return the value from any case property type, including number or DateTime values, cast as a string.

Parameters

pPropName: The string name of the property to return.

Returns

string: The case property value.

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
string myVal = myCase.GetPropertyText("PropertyName");

This API will return the specified property of a Case object, if the property is a numeric value. If the property is a string or a DateTime, the API will return "0".

Parameters

pPropName: The string name of the property to return.

Returns

decimal: A decimal number containing the case property value.

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
string myVal = myCase.GetPropertyNumber("PropertyName");

This API will return the specified property of a Case object, if the property is a DateTime value. If the property is a string or a number, the API will return null.

Parameters

pPropName: The string name of the property to return.

Returns

object: A DateTime object containing the case property value.

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
string myVal = myCase.GetPropertyDateTime("PropertyName");

This API will recalculate the name of the case instance to update any changes to the data used in the instance name, such as form field or case variables.

Parameters

None

Returns

None

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
myCase.RecalcCaseInstanceName();

This API will set the specified property of a Case object. If the case property is a numeric or DateTime value, Process Director will cast the string to the correct data type.

Parameters

pPropName: The string name of the property to return.

Returns

None

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
string myVal = "Value";
myCase.SetPropertyText("PropertyName") = myVal;

This API will set the specified property of a Case object, if the case property is a numeric value. Otherwise, the value will be set to null.

Parameters

pPropName: The string name of the property to return.

Returns

None

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
int myVal = 1;
myCase.SetPropertyNumber("PropertyName") = myVal;

This API will set the specified property of a Case object, if the case property is a DateTime value. Otherwise, the value will be set to null.

Parameters

pPropName: The string name of the property to return.

Returns

None

Example

var myCase = Case.GetCaseByCASEINSTID(bp, "CASEINSTID");
datetime myDate = new DateTime(2023, 1, 18);
myCase.SetPropertyDateTime("PropertyName") = myDate;