Web Services Knowledge Management

This article contains the following topics:
casm172
This article contains the following topics:
To use the Web Services Knowledge Management, it is helpful if you are familiar with the database structure.
Table Types
Some of the more important tables are described as follows:
Table Type
Description
skeleton
Stores all information pertaining to documents with each row representing one document. Field names from this table can be used when passing the PropertyList and SortBy parameters to methods such as FAQ() and Search(). The field names are case-sensitive so make sure you pass them just as they are in the database.
o_indexes
Stores all information pertaining to categories with each row representing one category.
 
Knowledge Management General Methods
This section describes Knowledge Management general methods. Valid Knowledge document sorting properties (when available) are as follows:
  • RELEVANCE
  • AUTHOR_ID
  • BU_RESULT
  • CREATION_DATE
  • DOC_TYPE_ID
  • EXPIRATION_DATE
  • HITS
  • id
  • MODIFY_DATE
  • OWNER_ID
  • PRIORITY_ID
  • ACCEPTED_HITS
  • ASSET_ID
  • SD_ASSET_ID
  • ASSIGNEE_ID
  • PRODUCT_ID
  • START_DATE
  • STATUS_ID
  • SUBJECT_EXPERT_ID
faq
The following parameters apply to the faq method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
categoryIds
String
Identifies the category ID used to perform the faq. Use 1 for the ‘Root’ category.
Note:
Multiple ids are supported, for example, "1, 2, 3”.
resultSize
Integer
Identifies the number of documents for which you want to retrieve detailed information. For the rest of the documents, only their IDs return. Detailed information for these documents can be accessed later using the getDocumentsByIDs() method. The default is 10.
propertyList
String
Identifies the comma-separated list of database fields from which you want to retrieve information. The following fields are always returned, regardless of the propertyList parameter:
id
DOC_TYPE_ID
BU_RESULT
sortBy
String
Identifies the database field that you want to use for sorting the results. Multiple sort fields are not supported. The default is BU_RESULT, meaning that the faq rating sorts it. When ID is used as a secondary sort, it always sorts the results. A value of
HITS
in "sortBy" is also supported.
HITS
Identifies the number of times that the document has been viewed.
descending
Boolean
Identifies an indicator available for sorting the results in descending order.
whereClause
String
Use this to add your own ‘SQL where clause’ for filtering the results of the search.
maxDocIds
Integer
Identifies the maximum amount of document IDs to be returned (the default is 100).
For example, if you specify a resultSize of 10 and a maxDocIds of 50, if there are 100 matching documents in the database, then 10 have their detailed information retrieved and 40 have just their IDs returned. The remaining 50 are not returned at all.
Description
Use to perform a faq search. Documents are retrieved based on the category ID that is passed. Any documents residing in that category or in any sub-category are returned. To improve performance, these methods only retrieve detailed information on a user-defined set of documents, which is controlled through the resultSize parameter. The rest of the documents return their IDs only. Using this method, you can for example, set up a paging mechanism where the user can click on ‘Top’, ‘Previous’, ‘Next’, and ‘Bottom’ links. When you need to retrieve the next set of information, you can use the getDocumentsByIDs() method. The maximum number of 100 IDs is returned.
Returns
A <UDSObjectList> node with the following sections:
<UDSObject> node from the <UDSObject> Node Description section of this chapter. There is a <UDSObject> node with all the given properties for the first
n
documents that the method finds where
n
equals the resultSize parameter.
For example, if the resultSize parameter is 10, the maxDocIDs parameter is 50, and the method finds 100 documents, then there are 10 <UDSObject> with <Attributes> nodes in the first<UDSObject> section with detail attribute information from propertyList parameter and 40 <UDSObject> nodes with only ID <Attributes> in the following section. If you want to retrieve detailed ID <AttrName> information for documents numbering 11-20, you have to make a call to the getDocumentsByIDs() method and pass it those IDs from <AttrValue>.
The following parameters apply to the search method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
problem
String
Identifies the problem description to which you want to find solutions.
resultSize
Integer
Identifies the number of documents for which you want to retrieve detailed information. The remaining documents have their IDs returned only. Detailed information for these documents can be accessed later using the getDocumentsByIDs() method. The default is 10.
propertyList
String
Identifies the comma-separated list of database fields from which you want to retrieve information. The following fields are always returned, regardless of the propertyList parameter:
id
DOC_TYPE_ID
sortBy
String
Identifies the database field that you want to use for sorting the results. Multiple sort fields are not supported. The default is RELEVANCE. When id is a secondary sort, it always sorts the results. For a valid sort property, see the faq method.
descending
Boolean
Identifies an indicator you can use for sorting the results in descending order.
relatedCategories
Boolean
Returns a list of all related categories for the documents found.
searchType
Integer
Type of search to perform:
1 = Natural Language Search (NLS)
2 = Knowledge Management search
matchType
Integer
Represents the type of match:
0 = OR type match
1 = AND type match
2 = Exact match
Note:
If NLS is selected for the searchType parameter, then only the OR and AND matchTypes are valid.
searchField
Integer
Represents the binary combination of fields in which to search:
Title = 1
Summary = 2
Problem = 4
Resolution = 8
For example, to search all fields, specify 15 (1+2+4+8). To search in Summary and Problem only, specify 6 (2+4).
Note:
The default is to search Problem.
If you set the searchType parameter to NLS, the searchFields parameter is ignored because NLS searches can only search the Problem field.
categoryPath
String
Limits the results of the search to a specific category or categories. You need to specify the full ID path to the category and separate multiple categories with commas. For example, 1-3-5, 1-4-8 to limit the search to categories 5 and 8 (and their sub-categories).
whereClause
String
Use this to add your own ‘SQL where clause’ for filtering the results of the search.
maxDocIds
Integer
Represents the maximum amount of document IDs allowed to be returned. For example, if you specify a resultSize of 10 and a maxDocIds of 50, if there are 100 matching documents in the database, then 10 have their detailed information retrieved, and 40 have just their IDs returned. The remaining 50 are not returned at all. The default is 100.
Description
Searches for solutions to a problem. Documents are retrieved based on the problem that is passed. Any documents matching the description of the problem or a similar description, are returned. To improve performance, these methods only retrieve detailed information on a user-defined set of documents, which is controlled through the resultSize parameter. The rest of the documents return their ids only. Using this method, you can for example, set up a paging mechanism, where the user can click on ‘Top’, ‘Previous’, ‘Next’, and ‘Bottom’ links. When you need to retrieve the next set of information, you can use the getDocumentsByIDs() method.
Returns
A <UDSObjectList> node with the following sections:
<UDSObject> node from the <UDSObject> Node Description section of this chapter. There will be a <UDSObject> node with all the given properties for the first
n
documents that the method finds, where
n
equals the resultSize parameter. For example, if the resultSize parameter is 10, the maxDocIds parameter is 50, and the method finds 100 documents, then there are 10 <UDSObject> nodes with all the properties requested in the <Attributes> section and 40 <UDSObject> with only the ID property in the <Attributes> section. If you want to retrieve detailed <UDSObject> information for documents 11-20, you need to make a call to the getDocumentsByIDs() method and pass it those IDs.
If the getRelatedCategories parameter is set to True, the <UDSObjectList> node is included in the <Attributes> section for related categories. Each <INDEX_DOC_LINKS> node contains the relational ID of the category, as shown by the following example:
1-70
doSelectKD
The following parameters apply to the doSelectKD method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
whereClause
String
(Optional) Identifies the where clause for the query.
sortBy
String
Identifies the database field that you want to use for sorting the results. Multiple sort fields are not supported. The default is BU_RESULT, meaning that the faq rating sorts it. When id is used as the secondary sort, it always sorts the results.
desc
Boolean
Identifies the indicator available for sorting the results in descending order. Use True for descending and False for ascending the document order.
maxRows
Integer
Indicates the maximum number of rows to return. Specify -1 to return all rows.
Note:
Regardless of the integer specified, CA SDM will return a maximum of 250 rows per call.
attributes
String[]
Identifies the attribute list from which to fetch values. Dotted-attributes are permitted. If this field is blank, all value-based attributes are returned. These attributes cannot be defined as LOCAL in the majic definition file. LOCAL attributes are temporal; they have no database storage.
skip
Integer
Identifies the number of knowledge documents to skip from the beginning. Enter zero (0) to return all documents.
Description
Performs an SQL-like select on a Knowledge Document table. Supply one or more attributes you want fetched from the objects that match the supplied where clause.
Returns
A sequence of <UDSObject> elements. The following format applies:
<UDSObjectList> <UDSObject> <Handle> <Attributes> <AttributeName0> <AttributeName1>
XML Element
Type
Description
<UDSObject>
Sequence
Contains a <Handle> element and an <Attributes> sequence.
<UDSObjectList>
 
Signifies the outer element, which contains a sequence of <UDSObject> elements.
 
createDocument
The following parameters apply to the createDocument method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
kdAttributes
String[]
Identifies an array of name-value pairs used to set the initial attribute values for the new Knowledge document, as illustrated by the following:
"SUMMARY","Summary text",
"TITLE","Title text"
As part of the createDocument method, the following table reflects examples of valid, commonly used attribute values for a document. Data in the Type column reflect the actual type, which must be parsed to the method in string format in the attrVals string array.
Attribute Value
Type
Description
PRIMARY_INDEX
Integer
Identifies the category ID in which to create the document. Use 1 for the
Root
category.
USER_DEF_ID
String
Identifies any ID that you would like to use to represent the document.
TITLE
String
Identifies the title of the document.
SUMMARY
String
Identifies the summary of the document.
PROBLEM
String
Identifies the problem of the document.
RESOLUTION
String
Identifies the resolution of the document. This can contain html.
STATUS_ID
Integer
Identifies the status ID for the document. The default is 10 (Draft).
PRIORITY_ID
Integer
Identifies the priority ID for the document. The default is 20 (Normal).
CREATION_DATE
Date (String)
Identifies the date and time the document was created. Leave blank to assign current date.
MODIFY_DATE
Date (String)
Identifies the date and time the document was last modified. Leave blank to assign the current date.
START_DATE
Date (String)
Identifies the date the document becomes active and is used in conjunction with Expiration_Date. Leave blank to specify no start date and the document will be active as long as the expiration date has not been reached.
EXPIRATION_DATE
Date (String)
Identifies the date the document expires, and it is used in conjunction with Start_Date. Leave blank to specify no expiration date.
PUBLISHED_DATE
Date (String)
Identifies the date and time the document was published. Leave blank to assign current date if the status is Published. If the status is not Published, this parameter is ignored.
SD_PRODUCT_ID
Integer
Identifies the product ID from CA SDM with which to associate this document.
ASSIGNEE_ID
UUID
Identifies the unique assignee ID from CA SDM to which this document is assigned.
SD_ASSET_ID
UUID
Identifies the asset ID from CA SDM with which to associate this document.
SD_ROOTCAUSE_ID
Integer
Identifies the root cause ID from CA SDM with which to associate this document.
SD_PRIORITY_ID
Integer
Identifies the priority ID from CA SDM with which to associate this document.
SD_SEVERITY_ID
Integer
Identifies the severity ID from CA SDM with which to associate this document.
SD_IMPACT_ID
Integer
Identifies the impact ID from CA SDM with which to associate this document.
SD_URGENCY_ID
Integer
Identifies the urgency ID from CA SDM with which to associate this document.
AUTHOR_ID
UUID
Identifies the unique ID of the contact who authored this document. If the author is not an internal contact, you can set this field to zero and use the Author parameter instead.
OWNER_ID
UUID
Identifies the unique ID of the contact who owns this document.
SUBJECT_EXPERT_ID
UUID
Identifies the unique ID of the contact who is the subject expert for this document.
NOTES
String
Identifies the notes for the document.
READ_GROUP_LIST
String
Identifies the dash-separated list of group IDs that have read permission for this document (for example: 1-3-4). Use
A
to assign permission to everyone.
WRITE_GROUP_LIST
String
Identifies the dash-separated list of group IDs that have write permission for this document (for example: 1-3-4). Use
A
to assign permission to everyone.
INHERITPERMISSIONS
Boolean
Indicates the status of the flag to inherit permissions from the category in which the document is being created.
Set to True if you want to inherit permissions, and then ReadPermissions and the WritePermissions parameters will be ignored.
DOC_TYPE_ID
Integer
Identifies the ID for the type of document that this document will be; a regular document or a tree document. The default is a regular document.
HITS
Integer
Identifies the number of times that the document has been viewed.
DOC_TEMPLATE_ID
Integer
Identifies the ID for the template you want to assign to this document.
WF_TEMPLATE
Integer
Identifies the ID for the workflow template you want to assign to this document.
CUSTOM1
String
Specifies a custom field.
CUSTOM2
String
Specifies a custom field.
CUSTOM3
String
Specifies a custom field.
CUSTOM4
String
Specifies a custom field.
CUSTOM5
String
Specifies a custom field.
CUSTOM_NUM1
Double
Specifies a numeric custom field.
CUSTOM_NUM2
Double
Specifies a numeric custom field.
Description
Creates a new document.
Returns
A <UDSObject> node describing the Knowledge Document created.
modifyDocument
The following parameters apply to the modifyDocument method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
docId
Integer
Identifies the unique ID of the document you want to modify.
kdAttributes
String[]
Specifies the name-value pairs for the update, for example, “SUMMARY”, ”Summary text”, “TITLE”, and “Title text”.
As part of the modifyDocument method, the following table reflects examples of valid, commonly used attribute values for a document. Data in the Type column reflect the actual type, which must be parsed to the method in string format in the attrVals string array.
Parameter
Type
Description
MODIFY_DATE
(String)
Indicates a special field used for "record locking" purposes to make sure that someone else is not updating the document at the same time that you are. You must pass in the existing MODIFY_DATE of the document. If you leave the modify date blank, you receive an error that another user has updated the document.
USER_DEF_ID
String
Specifies any ID that you want to use to represent the document.
TITLE
String
Indicates the title of the document.
SUMMARY
String
Indicates the summary of the document.
PROBLEM
String
Indicates the problem of the document.
RESOLUTION
String
Indicates the resolution of the document. This can contain html.
STATUS_ID
Integer
Indicates the status ID for the document. The default is 10 (Draft).
PRIORTY_ID
Integer
Indicates the priority ID for the document. The default is 20 (Normal).
START_DATE
Date (String)
Indicates the date that the document becomes active, which is also used in conjunction with ExpirationDate. Leave blank to specify no start date and the document becomes active as long as the expiration date is not exceeded.
EXPIRATION_DATE
Date (String)
Indicates the date that the document expires, which is used in conjunction with StartDate. Leave blank to specify no expiration date.
SD_PRODUCT_ID
Integer
Indicates the product ID from CA SDM with which to associate this document.
ASSIGNEE_ID
UUID
Indicates the unique ID from CA SDM to which this document is assigned.
SD_ASSET_ID
UUID
Indicates the asset ID from CA SDM with which to associate this document.
SD_ROOTCAUSE_ID
Integer
Indicates the root cause ID from CA SDM with which to associate this document.
SD_PRIORITY_ID
Integer
Indicates the priority ID from CA SDM with which to associate this document.
SD_SEVERITY_ID
Integer
Indicates the severity ID from CA SDM with which to associate this document.
SD_IMPACT_ID
Integer
Indicates the impact ID from CA SDM with which to associate this document.
SD_URGENCY_ID
Integer
Specifies the urgency ID from CA SDM with which to associate this document.
AUTHOR_ID
UUID
Identifies the unique ID of the contact who authored this document. If the author is not an internal contact, you can set this filed to zero (0) and use the Author parameter instead.
OWNER_ID
UUID
Identifies the unique ID of the contact who owns this document.
SUBJECT_EXPERT_ID
UUID
Indicates the unique ID of the contact who is the subject expert for this document.
NOTES
String
Indicates notes for the document.
READ_GROUP_LIST
String
Indicates the dash-separated list of group ids that have read permission for this document (for example: 1-3-4). Use
A
to assign permission to everyone.
WRITE_GROUP_LIST
String
Indicates the dash-separated list of group IDs that have write permission for this document (for example: 1-3-4). Use
A
to assign permission to everyone.
INHERIT_PERMISSION
Boolean
Indicates the status of the inherit permissions flag. Set to True if you want to inherit permissions from the category in which the document is being created. If set to True, the ReadPermissions and WritePermissions parameters are ignored.
DOC_TYPE_ID
Integer
Identifies the ID for the type of document that this document is to become; a regular document or a tree document. The default is a regular document.
HITS
Integer
Indicates the number of times that the document has been viewed.
DOC_TEMPLATE_ID
Integer
Identifies the ID for the template you want to assign to this document.
WF_TEMPLATE
Integer
Identifies the ID for the workflow template you want to assign to this document.
WF_ACTION
String
Identifies the action for the workflow you want to assign to this document. For example, wf_unpublish lets the document become unpublished.
WF_COMMENT
String
Identifies the comment for the workflow you want to assign to this document. For example, unpublish.
WF_CONTACT_ID
UUID
Identifies the user id for the workflow you want to assign to this document.
WF_REJECT_TO_ID
Integer
Identifies the task id for the workflow you want to assign to this document, matching its approval process. Task ids are stored in the CI_ACTIONS table.
CUSTOM1
String
Indicates a custom field.
CUSTOM2
String
Indicates a custom field.
CUSTOM3
String
Indicates a custom field.
CUSTOM4
String
Indicates a custom field.
CUSTOM5
String
Indicates a custom field.
CUSTOMNUM1
Double
Indicates a numeric custom field.
CUSTOMNUM2
Double
Indicates a numeric custom field.
Description
Modifies a document.
Returns
A <UDSObject> node describing the Knowledge Document modified.
deleteDocument
The following parameters apply to the deleteDocument method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
docId
Integer
Identifies the unique ID of the document you want to delete.
Description
Flags a document for deletion. The Knowledge Management Windows Service permanently deletes the document.
Returns
Returns error codes only when there are
individual
errors. For additional information, see Error Codes.
Use the Knowledge Management Web Services
The login process and any error codes that may display for the Knowledge Management Web Services are the same as those found for the CA SDM Web Services. For additional information, see Login and Error Codes.
Access the Knowledge Management Web Services
The Knowledge Management Web Services uses Apache Axis implementation of standards set forth by the W3C. Ideally, a client on any type of platform should be able to access the services, but vendor implementations vary. For example, Java and .NET both provide tools for generating proxy classes from a WSDL service description. If you experience any issues using the Web Services with a different technology, consult your platform vendor or Microsoft's knowledge base.
addComment
The following parameters apply to the addComment method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
comment
String
Identifies the comment to add.
docId
Integer
Identifies the document ID for the comment you want to add.
email
String
Indicates the email address of the person who submitted the comment. Leave blank if you want the email address retrieved from the database based on the user ID parameter.
username
String
Indicates the user name of the person who submitted the comment. Leave blank if you want the user name retrieved from the database based on the user id parameter.
contactId
String
Indicates the ID of the person submitting the comment. If this contact ID exists in the database, the associated email and user name are retrieved and placed in the email and user name fields. If this ID does not exist, the email and user name parameters are used instead, if supplied. Use zero (0) if you are not using this parameter. Contact ID is UUID in string format.
Description
Adds a comment to a particular document.
Returns
A <UDSObject> node with the following<Attributes> child nodes describing the comment most recently added:
XML Element Value
Data Type
Description
id
Integer
Identifies the unique identifier for the comment most recently added.
DOC_ID
Integer
Identifies the document ID for the comment most recently added.
USER_ID
Integer
Identifies the ID of the person who submitted the comment.
USER_NAME
String
Identifies the user name of the person who submitted the comment.
EMAIL_ADDRESS
String
Identifies the email address of the person who submitted the comment.
COMMENT_TEXT
String
Identifies the text for the comment recently added.
COMMENT_TIMESTAMP
Date
Identifies the date and time the comment was added.
 
deleteComment
The following parameters apply to the deleteComment method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
commentId
Integer
Identifies the unique ID for the comment you want to delete.
Description
Deletes a comment.
Returns
Returns error codes only for
individual
errors. For additional information, see Error Codes.
rateDocument
The following parameters apply to the rateDocument method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
docId
Integer
Identifies the document ID to rate.
rating
Integer
Identifies the rating to give the document (a scale of 0-4, where 0 is the worst and 4 is the best).
multiplier
Integer
Identifies the multiplier parameter. This parameter can be used to simulate many ratings at once. Use the default of 1 for a single rating and any other number for multiples.
For example, if you submit 3, it acts as if you called the method 3 times. Three ratings with the value you supplied in the rating parameter is added to the database.
ticketPerId
String
Identifies the persistent ID of a ticket related to this Knowledge document.
onTicketAccept
Boolean
Identifies whether the document was accepted as a solution for the ticket.
solveUserProblem
Boolean
Identifies whether this document solved the user's problem. It signifies how the user responded to the question "Did this document solve your problem?" on the Solution Survey.
isDefault
Boolean
Indicates a default rating status. If you are setting the rating just because the user viewed the document and not because he actually rated it, set this to True. This is used for reporting reasons.
Description
Rates a particular document.
Returns
A <UDSObject> node with the following <Attributes> children nodes describing the rating BU_TRANS :
XML Element Value
Data Type
Description
id
Integer
Identifies the unique identifier for the rating most recently added. Use this with the updateRating() method if you want to modify the rating at a later time.
DOC_ID
Integer
Identifies the document ID.
INDEX_ID
Integer
Identifies the category ID.
BU_RATING
String
Identifies the rating given to the document.
HIT_NO_VOTE
Integer
Identifies the rating set because a user viewed the document and not actually rated it, or vice versa.
 
updateRating
The following parameters apply to the updateRating method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
buID
Integer
Identifies the unique ID of the rating you want to modify. This ID is returned by the rateDocument() method.
rate
Integer
Identifies the new rating to apply to the document (a scale of 0 -- 4, where 0 is the worst and 4 is the best).
Description
Updates one of the ratings of a particular document.
Returns
A <UDSObject> node describing BU_TRANS with the updated rating attribute.
getQuestionsAsked
The following parameters apply to the getQuestionsAsked method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
resultSize
Integer
Identifies the number of searched text for which you want to retrieve detailed information.
Descending
Boolean
Indicates an option available for sorting the results in descending order of the ASKED_DATE.
Description
Retrieves historical Knowledge document search text.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing EBR_LOG with the following <Attributes> child nodes:
XML Element Value
Data Type
Description
id
Integer
Indicates the unique identifier of the question asked.
SEARCH_TEXT
Integer
Indicates the search text of the question asked.
 
getBookmarks
The following parameters apply to the getBookmarks method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
contactId
String
Identifies the unique ID of the contact for which you want to retrieve bookmarks. Contact ID is UUID in string format.
Description
Retrieves bookmarks for a particular contact.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing CI_BOOKMARKS with the following <Attributes> child nodes:
XML Element Name
Type
Description
DOCUMENT_ID
Integer
Identifies the unique ID of the document.
id
Integer
Identifies the bookmark ID
USER_ID
String
Identifies the user ID for the owner of this bookmark.
BOOKMARK_TITLE
String
Identifies the bookmark title from the document.
 
addBookmark
The following parameters apply to the addBookmark method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
contactId
String
Identifies the unique ID of the contact for which you want to retrieve bookmarks. Contact ID is UUID in string format.
docId
Integer
Identifies the document ID you want to bookmark.
Description
Adds a bookmark for a particular contact.
Returns
A <UDSObject> node describing the newly created bookmark.
deleteBookmark
The following parameters apply to the deleteBookmark method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
contactId
String
Identifies the unique ID of the contact for which you want to delete a bookmark. Contact ID is UUID in string format
docId
Integer
Identifies the document ID of the bookmark you want to remove.
Description
Deletes a bookmark for a particular contact.
Returns
Returns error codes only for
individual
errors. For additional information, see Error Codes.
getStatuses
The following parameter applies to the getStatuses method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
Description
Retrieves the list of statuses.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing CI_STATUSES with the following <Attributes> child nodes:
XML Element Values
Data Type
Description
id
Integer
Identifies the unique ID of the status.
STATUS
String
Identifies the name for the status.
STATUS_DESCRIPTION
String
Identifies the description for the status.
PREDEFINED
Integer
Indicates whether the status is predefined by the Knowledge Management system, meaning that it cannot be deleted.
STATUS_ORDER
Integer
Describes the order by which the status should appear in the Workflow task list. Workflows can only be created when they follow this order.
 
getPriorities
The following parameter applies to the getPriorities method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
Description
Retrieves the list of priorities.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing CI_PRIORITIES with the following <Attributes> child nodes:
XML Element Values
Data Type
Description
id
Integer
Identifies the unique ID of the priority.
PRIORITY
String
Identifies the name for the priority.
 
getDocumentTypes
The following parameter applies to the getDocumentTypes method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
Description
Retrieves the list of document types.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing CI_DOC_TYPES with the following <Attributes> child nodes:
XML Element Values
Data Type
Description
id
Integer
Identifies the unique ID of the document type.
DOC_TYPE_TXT
String
Identifies the name for the document type.
 
getTemplateList
The following parameter applies to the getTemplateList method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
Description
Retrieves the list of document templates
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing CI_DOC_TEMPLATES with the following <Attributes> child nodes:
XML Element Value
Type
Description
id
Integer
Identifies the unique ID of the document type.
TEMPLATE_NAME
String
Identifies the name for the document template.
IS_PREDEFINED
Integer
Indicates whether the template is predefined by the Knowledge Management system and cannot be deleted.
IS_DEFAULT
Integer
Indicates whether the template is the default that will be assigned to new documents.
 
getWorkflowTemplateList
The following parameter applies to the getWorkflowTemplateList method:
Parameter
Type
Description
SID
String
Identifies the session retrieved from logging in.
Description
Retrieves the list of workflow templates.
Returns
A <UDSObjectList> node with zero or more <UDSObject> nodes describing WF_TEMPLATE with the following <Attributes> child nodes:
XML Element Value
Type
Description
id
Integer
Identifies the unique ID of the workflow template.
WF_NAME
String
Identifies the name for the workflow template.
WF_DESCRIPTION
String
Identifies the description for the workflow template.
IS_DEFAULT
Integer
Indicates that the default template is to be assigned to new documents.