Set Custom Attributes

API Type

Web Services

Description

Sets a list of process attribute (custom attributes) to the specified values for a specified custom attribute ID. The list of process variables must be specified as a Name-Value array.

Syntax

public virtual void SetCustomAttrs(string customID, NameValue[] nameValues)

Parameters

NameDescription

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

attributes
Function:
Name-value pairs associated with a custom ID.
Type
NameValue
Accepted Values:
A valid custom ID with an associated name.

Output

None.

Example

IWFWorkflowService svc = GetWorkflowService();
string customID = ..// for example, "InfoPath:011eaf6c46ac4723b25b4db5772d9912"

NameValue[] attributes = new NameValue[] 
    {
    new NameValue("CustomAttributeName1","CustomAttributevalue1"),
    new NameValue("CustomAttributeName2",false),
    new NameValue("CustomAttributeName3", 10.0)
	};

try
	{
    svc.SetCustomAttrs(customID, attributes);
	}

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.