Deprecation Warning! The content below is only applicable for use within deprecated 1.x versions of CA Agile Central's App SDK. Use of the components and code on this page is not supported. To develop custom apps within our current environments, please see App SDK 2.1 documentation.

The rally.sdk.util.Ref object provides utility methods for handling CA Agile Central references.

References may be either fully qualified:


or shorthand:


Static Methods

Method Name Parameters Return Value Example
isRef ref True if the specified value is in valid CA Agile Central reference format; false otherwise
var isRef = rally.sdk.util.Ref.isRef
getOidFromRef ref The Oid from the specified ref; or null if not a valid CA Agile Central reference
var oid = rally.sdk.util.Ref.getOidFromRef
getTypeFromRef ref The type from the specified ref; or null if not a valid CA Agile Central reference
var type = rally.sdk.util.Ref.getTypeFromRef
getRefFromTypeAndObjectId type, oid A ref of the format /type/oid
var ref = rally.sdk.util.Ref
.getRefFromTypeAndObjectId("defect", 12345);
getRef input A ref if input is a valid ref or a valid CA Agile Central object; otherwise null
var ref = rally.sdk.util.Ref.getRef
getUserImage user, imageSize The URL of the specified user's profile image
var imageUrl = rally.sdk.util.Ref
.getUserImage("/user/12345", 60});
getRelativeRef input A relative ref of the specified absolute ref
var ref = rally.sdk.util.Ref.getRelativeRef({"_ref":


Need more help? The CA Agile Central Community is your one-stop shop for self-service and support. To submit feedback or cases to CA Agile Central Support, find answers, and collaborate with others, please join us in the CA Agile Central Community.