Error: Invalid spaceKey on retrieving a related space config.

ARGetListAssociation

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves a list of association names from the specified server. You can retrieve all (accessible) associations or limit the list to associations associated with a particular form or modified after a specified time.

Privileges

The system returns information based on the access privileges of the user that you specify for the control parameter. All lists, therefore, are limited to association the user can access.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetListAssociation(
      	ARControlStruct   *control,
	  	ARTimestamp       changedSince, 
		ARInternalId      assocType,  
		ARNameType        schemaName, 
		ARPropList        *objPropList, 
		ARInternalId      cardinality, 
		ARInternalId      enforcement,
		ARNameList        *nameList, 
		ARStatusList      *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.

If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the BMC Remedy AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode on the Configuration settings N-R

changedSince

A time stamp that limits the forms retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve forms with any modification time stamp.

assocType

A value that indicates association types to retrieve

  • 0 – Retrieve all association types.
  • 1 – Retrieve all Direct Associations. (AR_ASSOCIATION_TYPE_DIRECT)
  • 2 – Retrieve all Indirect Associations. (AR_ASSOCIATION_TYPE_INDIRECT)

schemaName

Specifies the form name to retrieve all the associations in which this form is used as primary form.

objPropList

List of server-managed object properties to search for. Returns all schemas that match the object properties, for example, the application owner. See Server-managed object property tags.

cardinality

A value that indicates association cardinality. All the associations with this cardinality will be retrieved in this call.

  • 0 – Retrieve all associations of any cardinality.
  • 1 – Retrieve all association of cardinality type OneToOne.
    (AR_ASSOCIATION_CARDINALITY_ONE_TO_ONE)
  • 2 – Retrieve all association of cardinality type OneToMany.
    (AR_ASSOCIATION_CARDINALITY_ONE_TO_MANY)
  • 3 – Retrieve all association of cardinality type ManyToMany.
    (AR_ASSOCIATION_CARDINALITY_MANY_TO_MANY)

Enforcement

A value that indicates association enforcement. All the associations with this enforcement will be retrieved in this call.

  • 0 – Retrieve all associations of any enforcement.
  • 1 – Retrieve all association of enforcement type ENFORCE_YES.
    (AR_ASSOCIATION_ENFORCE_YES)
  • 2 – Retrieve all association of enforcement type ENFORCE_NO.
    (AR_ASSOCIATION_ENFORCE_NO)

For more information, see Enforced and unenforced relationships.

Return values

nameList

A list of zero or more associations that match the criteria in the assocType, changedSince, cardinality,enforcement, and objPropList parameters. The system returns a list with zero items if no association match the specified criteria.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error checking.

See also

Was this page helpful? Yes No Submitting... Thank you

Comments