Set Custom Attribute

API Type

Web Services

Description

Sets the name and value for a custom attribute for a specified custom ID.

Syntax

public virtual SetCustomAttr(String customID, String attributeName, object val)

Parameters

NameDescription

customID
Description:
A work object ID specified within a process instance.
Type
string
Allowed Values:
One valid work object ID.

attributeName
Description:
The name of the process instance attribute you want.
Type
string
Allowed Values:
A valid process instance attribute.

val
Description:
The value of the custom attribute.
Type
object
Allowed Values:
A valid Types object.

Output

None.

Example

IWFWorkflowService svc = GetWorkflowService();
string customID = ..// for example,
"InfoPath:011eaf6c46ac4723b25b4db5772d9912"
string attributeName = ...// for example,
"//pd:purchaseOrder/pd:secondApproval"
bool val = true;

try
	{
    svc.SetCustomAttr(customID, attributeName, val);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.