REST API AttributeMap

The AttributeMap class is a JSON map that contains only attributes. The attribute <Name> is the map entry key, and the attribute <values> array (note plural) is the map entry value.

The AttributeMap class includes the following fields.

• <Name>: the programmatic name of the attribute. This name serves as a unique key for accessing the attribute within the component instance in which it occurs.
  Note: <Name> is not necessarily the display name that is presented to a user in the GUI. For components that are created from templates (such as projects or workflow tasks), the attribute name is specified by the template element definition. The attribute name must be unique. For other components, the attribute name typically is derived programmatically from the server-side component instance.
  Note: By convention, custom attributes include the name of the form in which the editable version is defined: <form_name>.<attribute_name>.
• Values: a JSON object array, containing zero or more attribute values. The type of each value must be the same and agree with the type of the attribute as it is defined in Unica Plan.

The metadata of an attribute (such as translated display name and description) is defined by the template that is associated with the attribute and its parent object instance. Attributes provide a simple yet extensible mechanism for showing both required and optional object instance attributes, such as project name, code, and start date.

Attribute maps:

{"multiTypeMap":{"uapDescription":[{"valueType":"java.lang.String",
"multiTypeValue":"abcdProjDesc4"}],"uapName":[{"valueType":"java.lang.
String","multiTypeValue":"RestTestProj04"}]}}

{"multiTypeMap":{"uapDescription":[{"valueType":"java.lang.String",
"multiTypeValue":"abcdProjDesc4"}],"uapName":[{"valueType":
"java.lang.String","multiTypeValue":"RestTestProg04"}]}}

{"multiTypeMap":{"uapDescription":[{"valueType":"java.lang.String",
"multiTypeValue":"abcdProjDesc4"}],"uapName":[{"valueType":"java.
lang.String","multiTypeValue":"RestTestProg09"}]}}

{"multiTypeMap":{"uapDescription":[{"valueType":"java.lang.String",
"multiTypeValue":"ReqDesacrption"}],"uapName":[{"valueType":"java.
lang.String","multiTypeValue":"RestTestProjReq01"}]}}

{"multiTypeMap":{"uapName":[{"valueType":"java.lang.String",
"multiTypeValue":"RestTestProjReq03"}]}}

{"multiTypeMap":{"uapName":[{"valueType":"java.lang.String",
"multiTypeValue":"RestTestProjReq04"}]}}

{"multiTypeMap":{"uapName":[{"valueType":"java.lang.String",
"multiTypeValue":"RestTestProjReq05"}]}}

{"multiTypeMap":{"uapDescription":[{"valueType":"java.lang.String",
"multiTypeValue":"changedDescription"}]}}

{"multiTypeMap":{"uapStartDate":[{"valueType":"com.unica.uap.
restapi.multitype.values.GregorianCalendarValue","multiTypeValue":
"2015-06-20 00:08:00"}],"uapEndDate":[{"valueType":"com.unica.uap.
restapi.multitype.values.GregorianCalendarValue","multiTypeValue":
"2015-08-30 00:08:00"}]}}

Enumerations:

{"value":{"multiTypeValue":"IN_PROGRESS"}}
{"value":{"multiTypeValue":"ON_HOLD"}}
{"value":{"multiTypeValue":"SUBMITTED"}}
{"value":{"multiTypeValue":"RETURNED"}}
{"value":{"multiTypeValue":"DRAFT"}}
{"value":{"multiTypeValue":"ACCEPTED"}}
{"value":{"multiTypeValue":"PENDING"}}
{"value":{"multiTypeValue":"ACTIVE"}}
{"value":{"multiTypeValue":"FINISHED"}}
{"value":{"multiTypeValue":"SKIPPED"}}
{"value":{"multiTypeValue":"DISABLED"}}
{"value":{"multiTypeValue":"ProjectOwner"}}
{"value":{"multiTypeValue":"ProjectParticipant"}}
{"value":{"multiTypeValue":"ProjectRequester"}}
{"value":{"multiTypeValue":"ProjectRequestRecipient"}}
{"value":{"multiTypeValue":"ProjectRequestOwner"}}
{"value":{"multiTypeValue":"ApprovalOwner"}}
{"value":{"multiTypeValue":"ApprovalApprover"}}
{"value":{"multiTypeValue":"ProgramOwner"}}
{"value":{"multiTypeValue":"ProgramParticipant"}}
{"value":{"multiTypeValue":"COPY_USING_PROJECT_METRICS"}}
{"value":{"multiTypeValue":"COPY_USING_TEMMPLATE_METRICS"}}
{"value":{"multiTypeValue":"DRAFT"}}
{"value":{"multiTypeValue":"FINALIZED"}}
{"value":{"multiTypeValue":"LOCKED"}}
{"value":{"multiTypeValue":"ARCHIVED"}}

Array of values:

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"RestTestProj01"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"TRS1000"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"changedDescription"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"RestTestProj02"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"RestTestProjReq01"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"TRS1018"}]}

{"valueArray":[{"valueType":"java.lang.String","multiTypeValue":
"ReqDesacrption  "}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.values.
HandleValue","multiTypeValue":"http://mymachine:9021/plan/affiniumplan.
jsp?cat=projecttabs&projectid=103"},{"valueType":"com.unica.uap.
restapi.multitype.values.HandleValue","multiTypeValue":
"http://mymachine:9021/plan/affiniumplan.jsp?cat=
projecttabs&projectid=104"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.values.
HandleValue","multiTypeValue":"http://mymachine:9021/plan/affiniumplan.
jsp?cat=projecttabs&projectid=107"},{"valueType":"com.unica.uap.restapi.
multitype.values.HandleValue","multiTypeValue":"http://mymachine:9021/
plan/affiniumplan.jsp?cat=projecttabs&projectid=108"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.values.
HandleValue","multiTypeValue":"http://mymachine:9021/plan/affiniumplan.
jsp?cat=projecttabs&projectid=102"},{"valueType":"com.unica.uap.
restapi.multitype.values.HandleValue","multiTypeValue":
"http://mymachine:9021/plan/affiniumplan.jsp?cat=projecttabs
&projectid=106"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.values.
HandleValue","multiTypeValue":"http://mymachine:9021/plan/
affiniumplan.jsp?cat=projecttabs&projectid=105"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.
values.HandleValue","multiTypeValue":"http://mymachine:9021/plan
/affiniumplan.jsp?cat=adminuserpermissions&func=edit&userId=3"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.
values.HandleValue","multiTypeValue":"http://mymachine:9021/plan/
affiniumplan.jsp?cat=adminuserpermissions&func=edit&userId=2"}]}

{"valueArray":[{"valueType":"com.unica.uap.restapi.multitype.
values.HandleValue","multiTypeValue":"http://mymachine:9021/plan/
affiniumplan.jsp?cat=adminuserpermissions&func=edit&userId=2"},
{"valueType":"com.unica.uap.restapi.multitype.values.
HandleValue","multiTypeValue":"http://mymachine:9021/plan/
affiniumplan.jsp?cat=adminuserpermissions&func=edit&userId=3"}]}