Previous Topic: createDocumentNext Topic: deleteDocument


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.