createDocument

Web Services Methods › Knowledge Management › Knowledge Management General Methods › createDocument

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"

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.