前のトピック: createDocument

次のトピック: deleteDocument

modifyDocument

modifyDocumentメソッドでは以下のパラメータを使用します。

パラメータ

説明

SID

Integer

ログインにより取得したセッションを指定します。

docId

Integer

変更するドキュメントの固有IDを指定します。

kdAttributes

String[]

更新する名前と値のペアを"SUMMARY", "概要テキスト", "TITLE", "タイトル テキスト"のように指定します。

modifyDocumentメソッドで一般的に使用される有効なドキュメント属性値の例を以下の表に指定します。 タイプ列は実際のタイプを指定します。メソッドで使用する場合は、文字列形式にパースしてattrVals文字列配列に指定する必要があります。

パラメータ

説明

MODIFY_DATE

(String)

「レコードをロックする」ために使用する特別なフィールドです。2 人のユーザが同時に同じドキュメントを更新することを防ぎます。 ドキュメントの既存MODIFY_DATEで渡す必要があります。 この MODIFY_DATE を空白にした場合は、別のユーザがドキュメントを更新したというエラーを受け取ります。

USER_DEF_ID

String

ドキュメントを識別するために使用する任意のIDを指定します。

TITLE

String

ドキュメントのタイトルを示します。

SUMMARY

String

ドキュメントの概要を示します。

PROBLEM

String

ドキュメントの問題を示します。

RESOLUTION

String

ドキュメントの解決策を示します。 これにはHTMLも含めることができます。

STATUS_ID

Integer

ドキュメントのステータスIDを示します。 デフォルトは 10(ドラフト)です。

PRIORTY_ID

Integer

ドキュメントの優先度IDを示します。 初期設定は20(中)です。

START_DATE

Date (String)

ドキュメントがアクティブになる日付を示します。これも有効期限と組み合わせて使用します。 開始日を指定せずに空白のままにしておくと、有効期限が過ぎるまでの間、ドキュメントはアクティブのままになります。

EXPIRATION_DATE

Date (String)

ドキュメントの有効期限を示します。開始日と組み合わせて使用します。 有効期限を指定しない場合は空白にします。

SD_PRODUCT_ID

Integer

このドキュメントを関連付ける CA SDM の製品 ID を示します。

ASSIGNEE_ID

UUID

このドキュメントに割り当てられる CA SDM の一意の ID を示します。

SD_ASSET_ID

UUID

このドキュメントを関連付ける CA SDM のアセット ID を示します。

SD_ROOTCAUSE_ID

Integer

このドキュメントを関連付ける CA SDM の根本原因 ID を示します。

SD_PRIORITY_ID

Integer

このドキュメントを関連付ける CA SDM の優先度 ID を示します。

SD_SEVERITY_ID

Integer

このドキュメントを関連付ける CA SDM の重大度 ID を示します。

SD_IMPACT_ID

Integer

このドキュメントを関連付ける CA SDM の影響 ID を示します。

SD_URGENCY_ID

Integer

このドキュメントを関連付ける CA SDM の緊急度 ID を示します。

AUTHOR_ID

UUID

このドキュメントの作成者である連絡先の固有IDを指定します。 作成者が内部連絡先ではない場合、このフィールドを0に設定して、代わりにAuthorパラメータを使用することができます。

OWNER_ID

UUID

このドキュメントの担当者である連絡先の固有IDを指定します。

SUBJECT_EXPERT_ID

UUID

このドキュメントのサブジェクト エキスパートである連絡先の固有IDを指定します。

NOTES

String

ドキュメントの注意事項を指定します。

READ_GROUP_LIST

String

このドキュメントの読み取り許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-2-3)。 全員に許可を割り当てるには「A」を指定します。

WRITE_GROUP_LIST

String

このドキュメントの書き込み許可を持つグループ ID をダッシュ区切りのリストで指定します(例: 1-3-4)。 全員に許可を割り当てるには「A」を指定します。

INHERIT_PERMISSION

Boolean

許可を継承するためのフラグのステータスを指定します。 ドキュメントが作成されるカテゴリから許可を継承する場合、Trueを設定します。 Trueに設定した場合は、読み取り許可および書き込み許可のパラメータは無視されます。

DOC_TYPE_ID

Integer

ドキュメントのタイプ(標準ドキュメントまたはツリー ドキュメント)のIDを指定します。 初期設定は標準ドキュメントです。

HITS

Integer

ドキュメントが表示された回数を指定します。

DOC_TEMPLATE_ID

Integer

このドキュメントに割り当てるテンプレートのIDを指定します。

WF_TEMPLATE

Integer

このドキュメントに割り当てるワークフロー テンプレートのIDを指定します。

WF_ACTION

String

このドキュメントに割り当てるワークフローのアクションを指定します。 たとえば、「wf_unpublish」では、ドキュメントは発行停止になります。

WF_COMMENT

String

このドキュメントに割り当てるワークフローのコメントを指定します。 たとえば、「unpublish」と指定します。

WF_CONTACT_ID

UUID

このドキュメントに割り当てるワークフローのユーザ ID を指定します。

WF_REJECT_TO_ID

Integer

承認プロセスと一致する、このドキュメントに割り当てるワークフローのタスク ID を指定します。 タスク ID は、CI_ACTIONS テーブルに格納されます。

CUSTOM1

String

カスタム フィールドを指定します。

CUSTOM2

String

カスタム フィールドを指定します。

CUSTOM3

String

カスタム フィールドを指定します。

CUSTOM4

String

カスタム フィールドを指定します。

CUSTOM5

String

カスタム フィールドを指定します。

CUSTOMNUM1

二重線

数値型のカスタム フィールドを指定します。

CUSTOMNUM2

二重線

数値型のカスタム フィールドを指定します。

説明

ドキュメントを変更します。

戻り値

変更されたナレッジ ドキュメントを説明する<UDSObject>ノード。