getPolicyInfo

This article contains the following topics:
casm173
This article contains the following topics:
The following parameters apply to the getPolicyInfo method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
Description
Returns information about the access policy that is controlling and managing the current CA SDM Web Services session.
Returns
The following XML string:
XML Element
Type
Description
<SAPolicy>
N/A
Identifies the detailed information of this access policy and its related problem types.
The content of <SAPolicy> is shown as follows:
<SAPolicy> <Name> name of policy </Name> <Code> policy code </Code> <ContactName> policy proxy contact's combo name </ContactName> <ContactHandle> handle of policy's contact </ContactHandle> <Access> <TicketCreation> limitation </TicketCreation> <ObjectCreation> limitation </ObjectCreation> <ObjectUpdate> limitation </ObjectUpdate> <Attachments> limitation </Attachments> <Queries> limitation </Queries> <Knowledge> limitation </Knowledge> </Access> <ProblemTypes> (zero or more <ProblemType> elements) <ProblemType> <Code>code of a problem type </Code> <Status>active or inactive </Status> </ProblemType> </ProblemTypes> </SAPolicy>
getTaskListValues
The following parameters apply to the getTaskListValues method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
objectHandle
String
Identifies the object handle for an issue or change order.
attributes
String
Identifies the sequence of attribute names for which to fetch values. Dotted-attributes are permitted. If this is blank, all attributes are fetched.
Description
Returns values for all the tasks associated with the specified issue or change order.
This is a convenience method. The same list could be obtained using doSelect().
Returns
This method has the following returns:
XML Element
Type
Description
<UDSObjectList>
N/A
Outer element -- contains zero or more <UDSObject> elements. Each <UDSObject> node represents a Task. The nodes are ordered by the Task’s ‘sequence’ attribute.
getValidTaskTransitions
The following parameters apply to the getValidTaskTransitions method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
taskHandle
String
Identifies the handle to a Workflow task (for an issue or change order).
attributes
String[]
Identifies the names of attributes to fetch from the ‘tskstat’ object. If this field is empty, all value-based attributes are returned.
Description
Returns all of the possible values for the ‘status’ attribute of a particular task. The Status codes to which a task may be set depend upon several factors, such as the current status of the task, and restrictions set by the administrator.
taskHandle
can be a task owned by either a change order or an issue. The objects returned are Task Status (‘tskstat’) objects used for both types of tasks.
Returns zero or more Status objects to which a task can be set.
Returns
This method has the following returns:
XML Element
Type
Description
<UDSObjectList>
N/A
Identifies the outer element, which contains zero or more <UDSObject> elements with the requested attribute values.
getValidTransitions
The getValidTransitions method lets you list the transitions for a ticket.
The following parameters apply:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
handle
String
Identifies the handle for a ticket or status. If a ticket handle is provided, the method retrieves the valid transitions for the current status of the ticket.
ticketFactory
String
Identifies the factory of the ticket. Valid values are only “cr” for Request, “in” for Incident, “pr” for Problem, “chg” for Change Order and “iss” for Issue.
Description
Returns all of the possible transition values for the status of a ticket. Administrators can configure valid status transitions for all ticket types.
Returns zero or more request/incident/problem/change/issue transition objects, depending on the values passed for handle and ticketFactory. If zero objects are returned, there are no transitions on the status of the ticket.
Returns
This method has the following return:
XML Element
Type
Description
<UDSObjectList>
N/A
Identifies the outer element, which contains zero or more <UDSObject> elements.
getDependentAttrControls
The getDependentAttrControls method lets you list the locked and required attributes for the Status record (either the ticket’s current status or any status record). At this time, the only attribute supported is the Status attribute. If the attrVals parameter is passed as empty, the method returns the dependent attributes for the current status of the ticket (assuming that a valid handle is used). Otherwise, you can request the dependent attributes for any status record by using the attrVals parameter.
Enter the attrVals parameter syntax as follows:
  • Specify the word "status" for the first item.
  • For the second item, specify the code of the status record, for example, WIP.
The following parameters apply:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
handle
String
Identifies the handle for a ticket.
attrVals
String
Identifies the name-value pairs of a ticket attribute for this method to get its dependent attribute controls.
Description
Returns all of the possible dependent attribute controls for the Status field of a ticket. Administrators can configure attribute restrictions.
Returns zero or more attribute control objects depending on the values specified. If zero objects are returned, there are no attribute restrictions on the object.
Returns
The following:
XML Element
Type
Description
<UDSObjectList>
N/A
Identifies the outer element, which contains zero or more <UDSObject> elements.
getHandleForUserid
The following parameters apply to the getHandleForUserid method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
userID
String
Identifies the user ID upon which to query.
Description
Returns the persistent handle for a Contact represented by userID.
Returns
The following is returned:
Parameter
Type
Description
<Handle>
String
Identifies the contact’s handle.
getAccessTypeForContact
The following parameters apply to the getAccessTypeForContact method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
ContactHandle
String
Identifies the contact handle upon which to query.
Description
Returns a handle for the Access Type for a Contact.
Every Contact is assigned an Access Type object, which defines a Contact’s permissions and security. Note the access_type field on a Contact is not required. To accommodate this, a single Access Type is marked as the default for Contacts who do not have an object specifically assigned.
This method returns the Access Type directly assigned to a Contact (that is, the information to which the access_type field points in the Contact record) or it returns the default. Typical value methods, such as getObjectValues() or getListValues(), may not return the correct Access type; therefore, these are not the accurate methods for retrieving the Contact’s Access.
Returns
A string handle for an Access Type object.
getContact
The following parameter applies to the getContact method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
contactId
String
Identifies the unique ID of the contact to retrieve. contactId is UUID in string format.
Description
Retrieves information on all contacts.
Returns
A <UDSObject> node with a <UDSObject> node describing a contact with some of the following child <Attributes> nodes:
XML Element Value
Type
Description
contactid
String
Specifies a unique ID of the contact. contactId is UUID in string format.
userid
String
Indicates the user name of the contact.
last_name
String
Indicates the last name of the contact.
first_name
String
Specifies the first name of the contact.
middle_name
String
Specifies the middle name of the contact.
location
String
Indicates the location of the contact.
dept
String
Identifies the department of the contact.
organization
String
Identifies the organization of the contact.
email_address
String
Identifies the email address of the contact.
pemail_address
String
Signifies the alternate email address of the contact.
phone_number
String
Indicates the phone number of the contact.
alt_phone
String
Indicates the alternate phone number of the contact.
address1
String
Specifies the address of the contact.
address2
String
Specifies the alternate address of the contact.
city
String
Identifies the city of the contact.
state
String
Identifies the state of the contact.
zip
String
Indicates the ZIP code of the contact.
country
String
Indicates the country of the contact.
delete_flag
Integer
Indicates whether the contact is active:
0
-- Active
1
-- Inactive
findContacts
The following parameters apply to the findContacts method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
userName
String
Returns only the contacts with this user name. You can do wildcard searches by using the percent (%) sign.
For example, to search for all contacts where the User Name begins with Smi, specify Smi%.
lastName
String
Returns only the contacts with this last name. You can do wildcard searches by using the percent (%) sign.
firstName
String
Returns only the contacts with this first name. You can do wildcard searches by using the percent (%) sign.
email
String
Returns only the contacts with this email address. You can do wildcard searches by using the percent (%) sign.
accessType
String
Returns only the contacts with this access type. You can specify multiple roles by separating them with commas. Specify the following:
10002 - Administration
10004 - Customer
10005 - Employee
10009 - IT Staff
10013 - Knowledge Management
10014 - Process Management
10010 - Service Desk Management
10008 - Service Desk Staff
10020 - Vendor Staff
inactiveFlag
Integer
Returns only the contacts that are inactive or active. Specify the following:
0 for active
- 999 for all
other for inactive
Description
Retrieves the list of contacts.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing contacts with the following <Attributes> child nodes:
XML Element Value
Type
Description
id
UUID
Specifies the unique ID of the contact.
userid
String
Specifies the user name of the contact.
last_name
String
Identifies the last name of the contact.
first_name
String
Identifies the first name of the contact.
access_type
Integer
Specifies the Role ID of the contact.
delete_flag
Integer
Indicates whether the contact is active or inactive:
0 - Active
1 - Inactive