WebCenter Content REST API v1.1
WebCenter Content REST API
REST APIについて
WebCenter Content REST APIを使用すると、WebCenter Contentのコンテンツと対話できます。
RESTの概要
REST (Representational State Transfer)は、HTTPSなどの標準プロトコルを介し、GET、POST、PUT、DELETEなどの基本的なメソッドを使用してリクエストをクライアント・アプリケーションから送信し、サーバー上に格納されているオブジェクトを操作します。
リクエストは、操作対象のリソース(dDocName、dID、GUIDなど)を識別するUniform Resource Identifier (URI)の形式で、操作に必要なパラメータを含みます。
クライアントからサーバーへの各RESTリクエストには、リクエストの理解に必要なすべての情報が含まれているため、個々のリクエストに関する、またはリクエスト間の関係に関する情報の格納をサーバーに依存しません。セッション状態は完全にクライアントに格納(キャッシュ)されます。
各RESTリクエストはIdcServiceリクエストに変換され、サービスの結果はJSONレスポンスとして返されます。各REST APIによってコールされるプライマリIdcServiceは、各APIの説明に記載されています。
使用の開始
WebCenter Content REST APIを使用するには、PostmanなどのRESTクライアントをインストールします。
認可
WebCenter Content REST APIでは、Basic認証を使用してRESTコールを認証します。匿名コールもサポートされます。
リソースURI
RESTコールには、POST、GET、PUT、DELETEなどのHTTPSメソッドと、Uniform Resource Identifier (URI)によって識別されるリソースが含まれています。
URIの形式は次のとおりです:
https://{WCCHost}[:WCCPort]/documents/wcc/api/version/resourcePath
例:
https://www.example.com/documents/wcc/api/v1.1
RESTリクエスト
REST APIは、RESTリクエストにダイレクトURLとJSONデータ形式をサポートしています。
一般に、WebCenter Content REST APIでは、IdcService名に似たパラメータ名が使用されます。
パス・パラメータ
パス・パラメータは、URIリソースで?文字の前に直接渡されるリソース・パラメータです。
問合せパラメータ
問合せパラメータは、URIリソースで?文字の後に直接渡されるリソース・パラメータです。
本文パラメータ
本文パラメータは、RESTリクエストのHTTP本文で渡されるリソース・パラメータです。
FormDataパラメータ
FormDataパラメータは、マルチパート・リクエストで使用され、RESTリクエストのHTTP本文で渡されます。WebCenter Content REST APIは、ファイルのアップロード時にこれを使用します。
RESTレスポンス
REST APIは、次のデータを返すことをサポートしています:
- レスポンスはファイルを返す場合があります。
- レスポンスはJSON形式で返される場合があります。
- レスポンスは空の場合があります。その場合、標準HTTPはレスポンスの成功または失敗を示すコードを返します。
一般に、WebCenter Content REST APIのレスポンスでは、IdcService名に似たパラメータ名が使用されます。
HTTPレスポンス・コード
WebCenter Content REST APIは、有効なHTTPレスポンス・コードを返す場合があります。最もよく返されるコードを次の表に定義します。
| HTTPステータス・コード | 説明 |
|---|---|
| 200 OK | リクエストは正常に完了しました。 |
| 201 Created | リクエストが完了し、新規のリソースが作成されました。レスポンスには、新規作成されたリソースの正規URIを含むLocationヘッダーが含まれます。 |
| 400 Bad Request | 情報が欠落しているか不適切であるため(入力フィールドでの検証エラー、必須値の欠落など)、処理できませんでした。 |
| 401 Unauthorized | リクエストは承認されません。このリクエストに含まれていた認証資格証明が欠落しているか無効です。 |
| 403 Forbidden | ユーザーを認証できません。ユーザーにはこのリクエストを実行する権限がありません。 |
| 404 Not Found | リクエストに、存在しないリソースURIが含まれています。 |
| 500 Internal Server Error | サーバーで予期しない状態が発生し、リクエストを処理できませんでした。 |
エラー・レスポンス
次の表では、エラーが返されたときに返されるエラー・メッセージのフィールドについて説明します。
| 名前 | 説明 |
|---|---|
| type | エラーのタイプを説明するリンク。 |
| title | 簡単なサマリー・エラー・メッセージ。 |
| detail | サーバーからのエラーの詳細。サービスStatusMessage。 |
| errorKey | エラーがサービス・レイヤーから発生した場合。サービスStatusMessageKey |
| o:errorCode | エラーがサービス・レイヤーから発生した場合、StatusCode。負の数値は、サービスが失敗したことを示します。 |
REST API定義
ファイル
ドキュメントのアップロード
POST /documents/wcc/api/v1.1/files/data
説明
新しいファイルをアップロードし、新しいドキュメントを作成します。(CHECKIN_UNIVERSAL)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| metadataValues | formData | このドキュメントに関連付けるメタデータ(JSON形式)。一部のフィールドは必須で、一部はオプションです。これはサーバーの構成方法によって異なります。次のフィールドは必須です: •dDocType – アップロードするドキュメントのタイプ •dDocTitle – アップロードするドキュメントのタイトル •dRevLabel – アップロードするドキュメントのリビジョン •dSecurityGroup – アップロードするドキュメントのセキュリティ・グループ 追加のフィールドが必要になる場合があります。 FrameworkFoldersコンポーネントが有効になっている場合、フォルダにアップロードするには、次のものを含めます: •fParentGUID – アップロードされるファイルのフォルダGUID。 |
はい | 文字列 |
| primaryFile | formData | このドキュメントのプライマリ・ファイル。 | はい | ファイル |
| alternateFile | formData | このドキュメントの代替ファイル。 | いいえ | ファイル |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | ドキュメントが正常にアップロードされました。 新しいドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ファイルをアップロードします。
リクエスト
POST …/documents/wcc/api/v1.1/files/data
リクエスト本文
FormDataパラメータ
metadataValues = {“dDocTitle”:“Rest”,“dSecurityGroup”:“Public”,“dDocType”:“Document”}
primaryFile = [filePath]
HTTPレスポンス
ステータス = 201
ヘッダー
Location = …/documents/wcc/api/v1.1/files/ID14006201
例2
Users:weblogicフォルダにファイルをアップロードします。
リクエスト
POST …/documents/wcc/api/v1.1/files/data
リクエスト本文
FormDataパラメータ
metadataValues = {“dDocTitle”:“Rest”,“dSecurityGroup”:“Public”,“dDocType”:“Document”, “fParentGUID”:“FLD_USER:weblogic”}
primaryFile = [filePath]
HTTPレスポンス
ステータス = 201
ヘッダー
Location = …/documents/wcc/api/v1.1/folders/files/5D6FC0B59C968931834B5BF2D6DAA52C
ドキュメントのリビジョンのアップロード
POST /documents/wcc/api/v1.1/files/{dDocName}/data
説明
新しいドキュメントを既存のドキュメントの新しいリビジョンとしてアップロードします。(CHECKIN_UNIVERSAL)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | リビジョンを追加するドキュメントのdDocName。 | はい | 文字列 |
| metadataValues | formData | このリビジョンに関連付けるメタデータ(JSON形式)。指定されていないフィールドは継承されます。サーバー構成によっては、dDocNameフィールドが必要になる場合があります。 |
はい | 文字列 |
| primaryFile | formData | このリビジョンのプライマリ・ファイル。 | はい | ファイル |
| alternateFile | formData | このリビジョンの代替ファイル。 | いいえ | ファイル |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | リビジョンが正常にアップロードされました。 新しいドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
新しいdDocTitleで新しいリビジョンをアップロードします。
リクエスト
POST …/documents/wcc/api/v1.1/files/ID14006201/data
リクエスト本文
FormDataパラメータ
metadataValues = {“dDocTitle”:“Rest Update Title”}
primaryFile = [filePath]
HTTPレスポンス
ステータス = 201
ヘッダー
Location = …/documents/wcc/api/v1.1/files/ID14006201
ドキュメントのダウンロード
GET /documents/wcc/api/v1.1/files/{dDocName}/data
説明
指定されたドキュメントのファイル・コンテンツをストリームとしてダウンロードします。(GET_FILE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | ダウンロードするドキュメントのdDocName。 | はい | 文字列 |
| version | query | ダウンロードするドキュメントのバージョン。指定しない場合、最新のリリース済バージョンとみなされます。 | いいえ | 文字列 |
| rendition | query | 取得するドキュメントのレンディション。レンディションを指定しない場合、ドキュメントのプライマリ・レンディションが想定されます。許可されるレンディション: •primary •alternate •web •rendition:T |
いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ドキュメントの完全なストリームが正常に返されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ドキュメントをダウンロードします
リクエスト
GET …/documents/wcc/api/v1.1/files/ID14006201/data
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
application/octet-streamとしてのファイル・コンテンツのストリーム
dIDによるドキュメントのリビジョンのダウンロード
GET /documents/wcc/api/v1.1/files/.by.did/{dID}/data
説明
指定されたドキュメント・リビジョンのファイル・コンテンツを、そのdIDを指定してストリームとしてダウンロードします。(GET_FILE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | コンテンツ・アイテムのリビジョン識別子。 | はい | 文字列 |
| rendition | query | ダウンロードするドキュメントのレンディション。primary、alternate、webまたはrendition:Tのいずれかです。レンディションを指定しない場合、ドキュメントのプライマリ・レンディションが想定されます。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ドキュメントの完全なストリームが正常に返されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
dIDでドキュメントをダウンロードします
リクエスト
GET …/documents/wcc/api/v1.1/files/.by.did/6205/data
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
application/octet-streamとしてのファイル・コンテンツのストリーム
ドキュメントのリビジョンのコピー
POST /documents/wcc/api/v1.1/files/{dDocName}/{dID}/copyRevision
説明
既存のドキュメントのリビジョンをコピーして、新しいドキュメントを作成します。(COPY_REVISION)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | コピーのソースとして使用されるドキュメントのdDocName。 | はい | 文字列 |
| dID | path | コピーのソースとして使用されるドキュメントのdID。 | はい | 文字列 |
| body | body | 新しく作成されたコピーに適用するJSONとしてのメタデータ。JSONに設定されていないフィールドは、ソース・ファイルから継承されます。使用するdDocNameがサーバーに存在しない場合は、新しいドキュメントが作成されます。dDocNameが存在する場合は、新しいリビジョンが作成されます。サーバー構成によっては、dDocNameフィールドが必要になる場合があります。 |
いいえ | MetadataChangeObjectParameter |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | リビジョンのコピーが正常に作成されました。 新しいドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ID14006201およびdID 6202のコピーを新しいコンテンツ・アイテムとして作成します。
リクエスト
POST …/documents/wcc/api/v1.1/files/ID14006201/6202/copyRevision
リクエスト本文
新しいコンテンツ・アイテムにdDocNameおよびdDocTitleを設定します。
{ “dDocName”: “createCopyRevision”,
“dDocTitle”:“Rest copyRevision” }
HTTPレスポンス
ステータス = 201
本文
Location = …/documents/wcc/api/v1.1/files/ID14006205
ドキュメント情報の取得
GET /documents/wcc/api/v1.1/files/{dDocName}
説明
ドキュメントのドキュメント情報を取得します。(DOC_INFO_LATESTRELEASEまたはDOC_INFO_SIMPLE_BYREV)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | 情報を返すドキュメントのdDocName。 | はい | 文字列 |
| version | query | 情報を返すドキュメントのバージョン。指定しない場合、最新のリリース・バージョンが返されます。 | いいえ | 文字列 |
| getFullInfo | query | trueの場合、docInfo、wfInfo、revisionHistory、fileInfoなどの追加配列が返されます。これをfieldsパラメータとともに使用して、返される内容をさらにフィルタ処理できます。 |
いいえ | ブール |
| fields | query | デフォルトでは、DOC_INFOサービス・ファミリによって返されるすべてのフィールドが返されます。指定する場合、フィールドは返される明示的なフィールドのカンマ区切りリストです。getFullinfo=trueとともに使用する場合、形式は{array}.{fieldsName}です。たとえば、fields=docInfo.dDocName,revisionHistory.dID,wfInfo.*,root.dDocTitleです。次の2つのキーワードがあります:• rootは、返されるJSONの最上位レベルを示します。フィールドは、キーワードを使用するroot.fieldNameか、キーワードなしのfieldNameで参照できます。• *文字は、配列内のすべてのフィールドを意味します。 |
いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | メタデータが正常に返されました | MetadataObjectResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
CREATECOPYREVISIONのメタデータを取得します。
リクエスト
GET …/documents/wcc/api/v1.1/files/CREATECOPYREVISION
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"dDocName": "CREATECOPYREVISION",
"dID": 6203,
"dDocType": "Document",
"dDocTitle": "Rest copyRevision",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "RELEASED",
"dOriginalName": "exif-xmp.jpg",
"dFormat": "image/jpeg",
"dFileSize": 129756,
"dDocCreator": "weblogic",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dIndexedID": 6203,
"dIsWebFormat": false,
"dCharacterSet": null,
"dRendition1": null,
"dPublishType": null,
"dRendition2": null,
"dDocClass": null,
"dInDate": "2024-05-21 16:08:00Z",
"dRevRank": "0",
"dDocID": 6405,
"dWebExtension": "jpg",
"dCheckoutUser": null,
"dLocation": null,
"dIsPrimary": false,
"dExtension": "jpg",
"dReleaseState": "Y",
"dProcessingState": "Y",
"dWorkflowState": null,
"dIndexerState": null,
"dReleaseDate": "2024-05-21 16:08:00Z",
"dFlag1": null,
"dCreateDate": "2024-05-21 16:08:00Z",
"dOutDate": null,
"dRevClassID": 6203,
"dLanguage": null,
"xExternalDataSet": null,
"dRevisionID": 1,
"dIsCheckedOut": false,
"dDocAccount": null,
"dPublishState": null,}
dIDによるドキュメント情報の取得
GET /documents/wcc/api/v1.1/files/.by.did/{dID}
説明
ドキュメントのドキュメント情報をdIDで取得します。(DOC_INFO_SIMPLE_BYREV)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | ドキュメントのdID/リビジョン識別子。 | はい | 文字列 |
| getFullInfo | query | trueの場合、docInfo、wfInfo、revisionHistory、fileInfoなどの追加配列が返されます。これをfieldsパラメータとともに使用して、返される内容をさらにフィルタ処理できます。 |
いいえ | ブール |
| fields | query | デフォルトでは、DOC_INFOサービス・ファミリによって返されるすべてのフィールドが返されます。指定する場合、フィールドは返される明示的なフィールドのカンマ区切りリストです。getFullinfo=trueとともに使用する場合、形式は{array}.{fieldsName}です。たとえば、fields=docInfo.dDocName,revisionHistory.dID,wfInfo.*,root.dDocTitleです。次の2つのキーワードがあります:• rootは、返されるJSONの最上位レベルを示します。フィールドは、キーワードを使用するroot.fieldNameか、キーワードなしのfieldNameで参照できます。• *文字は、配列内のすべてのフィールドを意味します。 |
いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | メタデータが正常に返されました | MetadataObjectResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
dID 6203のコンテンツ・アイテムのメタデータを取得します。
リクエスト
GET …/documents/wcc/api/v1.1/files/.by.did/6203
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"dDocName": "CREATECOPYREVISION",
"dID": 6203,
"dDocType": "Document",
"dDocTitle": "Rest copyRevision",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "RELEASED",
"dOriginalName": "exif-xmp.jpg",
"dFormat": "image/jpeg",
"dFileSize": 129756,
"dDocCreator": "weblogic",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dIndexedID": 6203,
"dIsWebFormat": false,
"dCharacterSet": null,
"dRendition1": null,
"dPublishType": null,
"dRendition2": null,
"dDocClass": null,
"dInDate": "2024-05-21 16:08:00Z",
"dRevRank": "0",
"dDocID": 6405,
"dWebExtension": "jpg",
"dCheckoutUser": null,
"dLocation": null,
"dIsPrimary": false,
"dExtension": "jpg",
"dReleaseState": "Y",
"dProcessingState": "Y",
"dWorkflowState": null,
"dIndexerState": null,
"dReleaseDate": "2024-05-21 16:08:00Z",
"dFlag1": null,
"dCreateDate": "2024-05-21 16:08:00Z",
"dOutDate": null,
"dRevClassID": 6203,
"dLanguage": null,
"xExternalDataSet": null,
"dRevisionID": 1,
"dIsCheckedOut": false,
"dDocAccount": null,
"dPublishState": null,}
ドキュメントの削除
DELETE /documents/wcc/api/v1.1/files/{dDocName}
説明
ドキュメントとそのすべてのリビジョンを削除します。(DELETE_DOC)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | 削除するドキュメントのdDocName。 | はい | 文字列 |
| version | query | 削除するドキュメントのバージョン番号。バージョンを指定しない場合、コンテンツ・アイテムとそのすべてのバージョンが削除されます。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | ドキュメントが正常に削除されました | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
dDocName CREATECOPYREVISIONを使用してコンテンツ・アイテムを削除します。
リクエスト
DELETE …/documents/wcc/api/v1.1/files/CREATECOPYREVISION
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
dIDによるドキュメントのリビジョンの削除
DELETE /documents/wcc/api/v1.1/files/.by.did/{dID}
説明
ドキュメント・リビジョンを削除します。(DELETE_REV_EX)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | 削除するドキュメントのdID (リビジョン)。 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | ドキュメントが正常に削除されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
dID 6206のコンテンツ・アイテムを削除します。
リクエスト
DELETE …/documents/wcc/api/v1.1/files/.by.did/6206
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ドキュメント・バージョン情報の取得
GET /documents/wcc/api/v1.1/files/{dDocName}/versions
説明
ドキュメントのすべてのリビジョン情報を取得します。(DOC_INFO_BY_NAME)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | リビジョン情報を返すドキュメントのdDocName。 | はい | 文字列 |
| fields | query | このパラメータは省略可能です。指定しない場合、DOC_INFOサービス・ファミリによって返されるすべてのフィールドが返されます。指定する場合、フィールドは返される明示的なフィールドのカンマ区切りリストです。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | メタデータが正常に返されました | MetadataVersionsResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
dDocName ID14006204を使用して、コンテンツ・アイテムのすべてのバージョンのメタデータを取得します。
リクエスト
GET …/documents/wcc/api/v1.1/files/ID14006204/versions
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"dDocName": "ID14006204",
"dRevLabelLatest": "2",
"count": 2,
"items": [
{
"dDocName": "ID14006204",
"dID": 6205,
"dDocType": "Document",
"dDocTitle": "Rest Update Title",
"dRevLabel": "2",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "RELEASED",
"dOriginalName": "exif-xmp.jpg",
"dFormat": "image/jpeg",
"dFileSize": 129756,
"dDocCreator": "weblogic",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dIndexedID": 6205,
"xIdcProfile": null,
"dIsWebFormat": false,
"xIsACLReadOnlyOnUI": 0,
"dCharacterSet": null,
"xComments": null,
"xDecimal": null,
"dRendition1": null,
"dPublishType": null,
"dRendition2": null,
"dDocClass": null,
"xReqText": null,
"dInDate": "2024-05-21 19:19:14Z",
"dRevRank": "0",
"dDocID": 6409,
"dMessage": null,
"dWebExtension": "jpg",
"dCheckoutUser": null,
"dLocation": null,
"xPartitionId": null,
"xWebFlag": null,
"dIsPrimary": false,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dReleaseState": "Y",
"dProcessingState": "Y",
"dWorkflowState": null,
"dIndexerState": null,
"xLongText": null,
"xTest": 0,
"xOptionList": null,
"xAnnotationDetails": 0,
"xMemo": "Test memo",
"dReleaseDate": "2024-05-21 19:24:05Z",
"dDocFunction": null,
"dFlag1": null,
"dCreateDate": "2024-05-21 19:19:14Z",
"dOutDate": null,
"dRevClassID": 6204,
"dLanguage": null,
"xExternalDataSet": null,
"dRevisionID": 2,
"dIsCheckedOut": false,
"dDocAccount": null,
"dPublishState": null,
"xDate": null,
"xLibraryGUID": null
},
{
"dDocName": "BB14006204",
"dID": 6204,
"dDocType": "Document",
"dDocTitle": "Rest",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "RELEASED",
"dOriginalName": "Mugs.jpg",
"dFormat": "image/jpeg",
"dFileSize": 53834,
"dDocCreator": "weblogic",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dIndexedID": 6205,
"xIdcProfile": null,
"dIsWebFormat": false,
"xIsACLReadOnlyOnUI": 0,
"dCharacterSet": null,
"xComments": null,
"xDecimal": null,
"dRendition1": null,
"dPublishType": null,
"dRendition2": null,
"dDocClass": null,
"xReqText": null,
"dInDate": "2024-05-21 19:18:39Z",
"dRevRank": "1",
"dDocID": 6407,
"dMessage": null,
"dWebExtension": "jpg",
"dCheckoutUser": null,
"dLocation": null,
"xPartitionId": null,
"xWebFlag": null,
"dIsPrimary": false,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dReleaseState": "O",
"dProcessingState": "Y",
"dWorkflowState": null,
"dIndexerState": null,
"xLongText": null,
"xTest": 0,
"xOptionList": null,
"xAnnotationDetails": 0,
"xMemo": "Test memo",
"dReleaseDate": "2024-05-21 19:18:41Z",
"dDocFunction": null,
"dFlag1": null,
"dCreateDate": "2024-05-21 19:18:39Z",
"dOutDate": null,
"dRevClassID": 6204,
"dLanguage": null,
"xExternalDataSet": null,
"dRevisionID": 1,
"dIsCheckedOut": false,
"dDocAccount": null,
"dPublishState": null,
"xDate": null,
"xLibraryGUID": null
}
]}
ドキュメント検索
GET /documents/wcc/api/v1.1/files/search/items
説明
サーバー内のドキュメントを検索します。(GET_SEARCH_RESULTS)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| q | query | コンテンツ・アイテムのフィルタに使用される検索問合せ。 | いいえ | 文字列 |
| fields | query | 各コンテンツ・アイテムに対して返されるメタデータ・フィールドの名前。このパラメータが渡されるかどうかに関係なく、常に返される一連のフィールドがあります。 | いいえ | 文字列 |
| orderBy | query | フィルタされたコンテンツ・アイテムのソートに使用されるソート・フィールドおよびソート順序。 | いいえ | 文字列 |
| limit | query | 1ページにリストされるアイテムの最大数。 | いいえ | 整数 |
| offset | query | レスポンスにアイテムがリストされる起点を指定します。 | いいえ | 整数 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | 検索結果が正常に返されました | SearchResultsResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
Publicセキュリティ・グループ内のすべてのファイルを検索します。
リクエスト
GET …/documents/wcc/api/v1.1/files/search/items
リクエスト本文
問合せパラメータq = dSecurityGroup <matches> `Public`
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"totalResults": 5,
"query": "dSecurityGroup <matches> \`Public\`",
"offset": 0,
"limit": 20,
"count": 5,
"hasMore": "false",
"pageNumber": 1,
"items": [
{
"dDocName": "ID14006204",
"dID": 6205,
"dDocType": "Document",
"dDocTitle": "Rest Update Title",
"dRevLabel": "2",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "Released",
"dOriginalName": "exif-xmp.jpg",
"dFormat": "image/jpeg",
"dFileSize": 129756,
"dDocCreatedDate": "2024-05-21 19:18:39Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-21 19:24:04Z",
"dDocLastModifier": "weblogic",
"dIndexedID": 6205,
"dDocOwner": "weblogic",
"dRendition1": null,
"dPublishType": null,
"URL": "/cs/groups/public/documents/document/yje0/mda2/~edisp/id14006204.jpg",
"dRendition2": null,
"VaultFileSize": 129756,
"dDocClass": null,
"dInDate": "2024-05-21 19:19:14Z",
"dWebExtension": "jpg",
"xWebFlag": null,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dDocFunction": null,
"dCreateDate": "2024-05-21 19:19:14Z",
"dOutDate": null,
"dRevClassID": 6204,
"xExternalDataSet": null,
"dRevisionID": 2,
"dDocAccount": null,
},
{
"dDocName": "ID14006201",
"dID": 6202,
"dDocType": "Document",
"dDocTitle": "Rest Update Title",
"dRevLabel": "2",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "Released",
"dOriginalName": "exif-xmp.jpg",
"dFormat": "image/jpeg",
"dFileSize": 129756,
"dDocCreatedDate": "2024-05-21 14:54:46Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-21 15:49:16Z",
"dDocLastModifier": "weblogic",
"dIndexedID": 6202,
"dDocOwner": "weblogic",
"dRendition1": null,
"dPublishType": null,
"URL": "/cs/groups/public/documents/document/yje0/mda2/~edisp/id14006201.jpg",
"dRendition2": null,
"VaultFileSize": 129756,
"dDocClass": null,
"dInDate": "2024-05-21 15:49:16Z",
"dWebExtension": "jpg",
"xWebFlag": null,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dDocFunction": null,
"dCreateDate": "2024-05-21 15:49:16Z",
"dOutDate": null,
"dRevClassID": 6201,
"xExternalDataSet": null,
"dRevisionID": 2,
"dDocAccount": null,
},
{
"dDocName": "ID14006002",
"dID": 6002,
"dDocType": "Document",
"dDocTitle": "Rest",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "Released",
"dOriginalName": "Mugs.jpg",
"dFormat": "image/jpeg",
"dFileSize": 53834,
"dDocCreatedDate": "2024-05-13 16:53:42Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-13 16:53:42Z",
"dDocLastModifier": "weblogic",
"dIndexedID": 6002,
"dDocOwner": "weblogic",
"dRendition1": null,
"dPublishType": null,
"URL": "/cs/groups/public/documents/document/yje0/mda2/~edisp/id14006002.jpg",
"dRendition2": null,
"VaultFileSize": 53834,
"dDocClass": null,
"dInDate": "2024-05-13 16:53:42Z",
"dWebExtension": "jpg",
"xPartitionId": null,
"xWebFlag": null,
"dExtension": "jpg",
"dDocFunction": null,
"dCreateDate": "2024-05-13 16:53:42Z",
"dOutDate": null,
"dRevClassID": 6002,
"xExternalDataSet": null,
"dRevisionID": 1,
"dDocAccount": null,
},
{
"dDocName": "ID14005802",
"dID": 5802,
"dDocType": "Document",
"dDocTitle": "file",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "UserB",
"dStatus": "Released",
"dOriginalName": "Mugs.jpg",
"dFormat": "image/jpeg",
"dFileSize": 53834,
"dDocCreatedDate": "2024-05-09 16:25:20Z",
"dDocCreator": "UserB",
"dDocLastModifiedDate": "2024-05-09 16:25:20Z",
"dDocLastModifier": "UserB",
"dIndexedID": 5802,
"dDocOwner": "UserB",
"dRendition1": null,
"dPublishType": null,
"URL": "/cs/groups/public/documents/document/yje0/mda1/~edisp/id14005802.jpg",
"dRendition2": null,
"VaultFileSize": 53834,
"dDocClass": null,
"dInDate": "2024-05-09 16:24:00Z",
"dWebExtension": "jpg",
"xWebFlag": null,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dDocFunction": null,
"dCreateDate": "2024-05-09 16:25:20Z",
"dOutDate": null,
"dRevClassID": 5802,
"xExternalDataSet": null,
"dRevisionID": 1,
"dDocAccount": null,
},
{
"dDocName": "1715255331863",
"dID": 5801,
"dDocType": "Document",
"dDocTitle": "Copy Title",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "Released",
"dOriginalName": "CSASampleImage.jpg",
"dFormat": "image/jpeg",
"dFileSize": 25382,
"dDocCreatedDate": "2024-05-09 11:48:53Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-09 11:48:53Z",
"dDocLastModifier": "weblogic",
"dIndexedID": 5801,
"dDocOwner": "weblogic",
"dRendition1": null,
"dPublishType": null,
"URL": "/cs/groups/public/documents/document/mju1/mzmx/~edisp/1715255331863.jpg",
"dRendition2": null,
"VaultFileSize": 25382,
"dDocClass": null,
"dInDate": "2024-05-09 11:48:53Z",
"dWebExtension": "jpg",
"xPartitionId": null,
"xWebFlag": null,
"dExtension": "jpg",
"dDocFunction": null,
"dCreateDate": "2024-05-09 11:48:53Z",
"dOutDate": null,
"dRevClassID": 5801,
"xExternalDataSet": null,
"dRevisionID": 1,
"dDocAccount": null,
}
],
"sortOrder": "dInDate:Desc"}
ドキュメントの再送信
POST /documents/wcc/api/v1.1/files/{dDocName}/resubmitConversion
説明
変換に失敗したドキュメントを再送信します。(RESUBMIT_FOR_CONVERSION)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | 再送信するドキュメントのdDocName。 | はい | 文字列 |
| version | query | 再送信するドキュメントのバージョン番号。バージョンを指定しない場合、最新のバージョンが再送信されます。 | いいえ | 文字列 |
| alwaysResubmit | query | デフォルトでは、変換失敗状態のファイルのみ再送信できます。これをtrueに設定すると、正常に変換されたファイルを再送信できます。 | いいえ | ブール |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 202 | ファイルが再送信されました。 | |
| 401 | 権限がありません | |
| 409 | ファイルは変換失敗状態ではなく、alwaysResubmitパラメータを使用して再送信できます。 |
ResubmitConflictErrorResponse |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした。 | GeneralErrorResponse |
例
コンテンツ・アイテムID14006204を再送信します。
リクエスト
POST …/documents/wcc/api/v1.1/files/ID14006204/resubmitConversion
リクエスト本文
なし
HTTPレスポンス
ステータス = 202
本文
ありません。
dIDによるドキュメントの再送信
POST /documents/wcc/api/v1.1/files/.by.did/{dID}/resubmitConversion
説明
変換に失敗したドキュメントを再送信します。(RESUBMIT_FOR_CONVERSION)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | ドキュメントのdID。 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 202 | ファイルが再送信されました | |
| 401 | 権限がありません | |
| 409 | ファイルは変換失敗状態ではなく、alwaysResubmitパラメータを使用して再送信できます |
ResubmitConflictErrorResponse |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
リビジョン6205を再送信します(ただし、変換に失敗していません)。
リクエスト
POST …/documents/wcc/api/v1.1/files/.by.did/6205/resubmitConversion
リクエスト本文
なし
HTTPレスポンス
ステータス = 409
本文
{
“type”: “https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict”,
“title”: “Resubmit Not Required”,
“detail”: “The content item is not in a failed conversion state.”,
“o:errorCode”: -1
}
処理中の作業の取得
GET /documents/wcc/api/v1.1/files/workInProgress/items
説明
ワークフローに存在しない、GENWWWまたはDONEステータスのアイテムのリストを返します。(WORK_IN_PROGRESS)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fields | query | 各コンテンツ・アイテムに対して返されるメタデータ・フィールドの名前。このパラメータが渡されるかどうかに関係なく、常に返される一連のフィールドがあります。 | いいえ | 文字列 |
| orderBy | query | フィルタされたコンテンツ・アイテムのソートに使用されるソート・フィールドおよびソート順序。 | いいえ | 文字列 |
| limit | query | 1ページにリストされるアイテムの最大数。 | いいえ | 整数 |
| offset | query | レスポンスにアイテムがリストされる起点を指定します。 | いいえ | 整数 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | 処理中の作業が正常に返されました。 | WorkInProgressResponse |
| 204 | 処理中の作業はありません。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
ドキュメントの更新
PUT /documents/wcc/api/v1.1/files/{dDocName}
説明
ドキュメントを更新します。ドキュメント・メタデータを更新するか、メタデータ・ファイルを別のファイルに更新します(ファイルはメタデータ・ファイルから1回のみ更新できます)。(UPDATE_DOCINFO_BYFORM & UPDATE_DOCINFO)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | 更新するドキュメントのdDocName。 | はい | 文字列 |
| version | query | 更新するドキュメントのバージョン。指定しない場合、最新のバージョンが更新されます。 | いいえ | 文字列 |
| createPrimaryMetaFile | query | trueの場合、プライマリ・メタファイルがチェックインされ、primaryFileパラメータは無視されます。 |
いいえ | ブール |
| createAlternateMetaFile | query | trueの場合、代替メタファイルがチェックインされ、alternateFileパラメータは無視されます。 |
いいえ | ブール |
| metadataValues | body | 更新するJSONとしてのメタデータ。ドキュメントに設定されたJSONのフィールド。存在しないフィールドは更新されません。 | はい | MetadataChangeObjectParameter |
| primaryFile | formData | このドキュメントの新しいプライマリ・ファイル(メタデータ・ファイルからのみ更新できます)。 | いいえ | ファイル |
| alternateFile | formData | このドキュメントの新しい代替ファイル(メタデータ・ファイルからのみ更新できます)。 | いいえ | ファイル |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | ドキュメントが正常に更新されました。 更新されたドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
METADATAドキュメントの最新リリース・バージョンを更新して、フィールドxCommentsを'my update'に設定します。
リクエスト
PUT …/documents/wcc/api/v1.1/files/METADATA
リクエスト本文
FormDataパラメータ
metadataValues = {“xComments”: “my update”}
HTTPレスポンス
ステータス = 204
ヘッダー
Location = …/documents/wcc/api/v1.1/files/METADATA
dIDによるドキュメントの更新
PUT /documents/wcc/api/v1.1/files/.by.did/{dID}
説明
ドキュメントを更新します。メタデータを更新するか、メタデータ・ファイルを別のファイルに更新します(ファイルはメタデータ・ファイルから1回のみ更新できます)。(UPDATE_DOCINFO_BYFORM & UPDATE_DOCINFO)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | 更新するドキュメントのdID。 | はい | 文字列 |
| createPrimaryMetaFile | query | trueの場合、プライマリ・メタファイルがチェックインされ、primaryFileパラメータは無視されます。 |
いいえ | ブール |
| createAlternateMetaFile | query | trueの場合、代替メタファイルがチェックインされ、alternateFileパラメータは無視されます。 |
いいえ | ブール |
| metadataValues | body | 更新するJSONとしてのメタデータ。ドキュメントに設定されたJSONのフィールド。存在しないフィールドは更新されません。 | はい | MetadataChangeObjectParameter |
| primaryFile | formData | このドキュメントの新しいプライマリ・ファイル(メタデータ・ファイルからのみ更新できます)。 | いいえ | ファイル |
| alternateFile | formData | このドキュメントの新しい代替ファイル(メタデータ・ファイルからのみ更新できます)。 | いいえ | ファイル |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | ドキュメントが正常に更新されました。 更新されたドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ファイル・リビジョン7603がメタデータ・ファイルとともに存在するとします。この更新により、ファイルが更新され、フィールドxCommentsが'changeFile'に設定されます。
リクエスト
PUT …/documents/wcc/api/v1.1/files/.by.did/7603
リクエスト本文
FormDataパラメータ
metadataValues = {“xComments”: “changeFile”}
primaryFile = [filePath]
HTTPレスポンス
ステータス = 204
ヘッダー
Location = …/documents/wcc/api/v1.1/files/ID14007635
ドキュメントのチェックアウト
POST /documents/wcc/api/v1.1/files/{dDocName}/.checkout
説明
ファイルの最新バージョンをチェックアウトします。(CHECKOUT_BY_NAME)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | チェックアウトするドキュメントのdDocName。 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | ドキュメントが正常にチェックアウトされました。 ドキュメントのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
コンテンツ・アイテムID14045102をチェックアウトします
リクエスト
POST …/documents/wcc/api/v1.1/files/ID14045102/.checkout
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ヘッダー
Location = …/documents/wcc/api/v1.1/files/ID14045102
コンテンツ・アイテムのワークフロー情報の取得
GET /documents/wcc/api/v1.1/files/{dDocName}/workflow
説明
ワークフロー内のドキュメントのdDocNameに基づくワークフロー情報。(GET_WORKFLOW_INFO_BYNAME)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | アクティブなワークフロー内のドキュメントの名前 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ワークフロー内のドキュメントのdDocNameに基づくワークフロー情報。 | WorkflowInfoResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
コンテンツ・アイテムID45654のワークフロー状態に関する情報を取得します。
リクエスト
GET …documents/wcc/api/v1.1/files/ID45654/workflow
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"dWfName": "criteriawf1",
"dWfStepID": 4,
"remainingStepUsers": "weblogic",
"doc_info": {
"dDocName": "ID45654",
"dID": 8446,
"dDocType": "Document",
"dDocTitle": "workflow demo",
"dRevLabel": "1",
"dSecurityGroup": "Public",
"dDocAuthor": "weblogic",
"dStatus": "REVIEW",
"dOriginalName": "Desert.jpg",
"dFormat": "image/jpeg",
"dFileSize": 845941,
"dVitalState": "Y",
"xReportType": null,
"xRecordSupersededDate": null,
"xDeleteApproveDate": null,
"xIsEditable": 1,
"xHasFixedClone": 0,
"xIsACLReadOnlyOnUI": 0,
"dCharacterSet": null,
"xComments": "criteriawf1",
"xRelatedContentTriggerDate": null,
"dRendition1": null,
"xNewRevisionDate": "5/22/24 9:34 AM",
"dRendition2": null,
"xRecordCancelledDate": null,
"xRecordCutoffDate": null,
"dLastModifiedDate": "5/22/24 9:34 AM",
"dRecordState": null,
"dRmaSegmentID": 3,
"dMessage": null,
"dWebExtension": "jpg",
"dCheckoutUser": null,
"xClassifiedMarkings": null,
"xRecordExpirationDate": null,
"xVitalPeriod": 0,
"dIsPrimary": false,
"dExtension": "jpg",
"xStorageRule": "DispByContentId",
"dProcessingState": "Y",
"xIsFrozen": 0,
"dWorkflowState": "W",
"dIndexerState": null,
"xIsRevisionable": 1,
"xSuperSupersededDate": null,
"dReleaseDate": null,
"xRecordActivationDate": null,
"dOutDate": null,
"dRevClassID": 7846,
"xIsVital": 0,
"dLanguage": null,
"xRelatedContentList": null,
"dIsCheckedOut": false,
"xIsDeletable": 1,
"xSupersededContent": null,
"xIdcProfile": null,
"dIsWebFormat": false,
"xFreezeID": 0,
"xIsSubjectToAudit": 0,
"dRmaProcessState": "Y",
"xRecordDestroyDate": null,
"xFreezeReason": null,
"dPublishType": null,
"xVitalPeriodUnits": null,
"xClbraUserList": null,
"xSource": null,
"xIsRecord": 0,
"xRecordFilingDate": "5/22/24 9:32 AM",
"xFolderID": null,
"dInDate": "2024-05-22 16:32:00Z",
"dRevRank": "0",
"xRecordReviewDate": null,
"dDocID": 13691,
"xClbraAliasList": null,
"dLocation": null,
"xSupplementalMarkings": null,
"xCpdIsTemplateEnabled": 0,
"xPartitionId": null,
"xWebFlag": null,
"dReleaseState": "E",
"xCpdIsLocked": 0,
"xRecordObsoleteDate": null,
"xAnnotationDetails": 0,
"xVitalReviewer": null,
"dFlag1": null,
"dCreateDate": "2024-05-22 16:34:00Z",
"xIsFixedClone": 0,
"xRecordRescindedDate": null,
"xExternalDataSet": null,
"xReportContentType": null,
"dRevisionID": 1,
"xLongName": null,
"xCategoryID": null,
"dPublishState": null,
"xAuditPeriod": null,
"dDocAccount": null,
"xIsCutoff": 0,
"xNoLatestRevisionDate": null,
"xLibraryGUID": null
},
"workflowInfo": {
"dWfID": 2,
"dWfName": "criteriawf1",
"dWfDescription": "Criteria Workflow1",
"dCompletionDate": null,
"dSecurityGroup": "Public",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
},
"wf_doc_info": {
"dWfID": 2,
"dDocName": "ID45654",
"dWfDocState": "INPROCESS",
"dWfComputed": null,
"dWfCurrentStepID": 4,
"dWfDirectory": "public"
},
"workflowStep": {
"dWfStepID": 4,
"dWfStepName": "step1",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":R:C:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0,
"dUsers": "weblogic",
"dHasTokens": "false"
},
"workflowSteps": [
{
"dWfStepID": 3,
"dWfStepName": "contribution",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":C:CA:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0
},
{
"dWfStepID": 4,
"dWfStepName": "step1",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":R:C:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0
}
],
"workflowActionHistory": [
{
"dWfName": "criteriawf1",
"dWfStepName": "contribution",
"wfAction": "CHECKIN",
"wfActionTs": "2024-05-22 16:34:05Z",
"wfUsers": "weblogic",
"wfMessage": null
},
{
"dWfName": "criteriawf1",
"dWfStepName": "contribution",
"wfAction": "APPROVE",
"wfActionTs": "2024-05-22 16:34:05Z",
"wfUsers": "weblogic",
"wfMessage": null
},
{
"dWfName": "criteriawf1",
"dWfStepName": "step1",
"wfAction": "WORK_NOTIFICATION",
"wfActionTs": "2024-05-22 16:34:05Z",
"wfUsers": "weblogic",
"wfMessage": "Content item 'ID45654' is ready for workflow step 'step1'.\n"
}
]ワークフローの承認
POST /documents/wcc/api/v1.1/files/{dDocName}/workflow/.approve
説明
ワークフロー内のコンテンツ・アイテムを承認します。(WORKFLOW_APPROVE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | ワークフロー内のドキュメントのdDocName | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | コンテンツ・アイテムは承認されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフロー内のコンテンツ・アイテムID9400002010を承認します。
リクエスト
POST …/documents/wcc/api/v1.1/files/ID9400002010/workflow/.approve
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ワークフローの承認
POST /documents/wcc/api/v1.1/files/.by.did/{dID}/workflow/.approve
説明
ワークフロー内のコンテンツ・アイテム・リビジョンを承認します。(WORKFLOW_APPROVE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | ワークフロー内のドキュメントのdID。 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | コンテンツ・アイテムは承認されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフロー内のアイテム・リビジョン23454323を承認します。
リクエスト
POST …/documents/wcc/api/v1.1/files/.by.did/23454323/workflow/.approve
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ワークフローの拒否
POST /documents/wcc/api/v1.1/files/{dDocName}/workflow/.reject
説明
ワークフロー内のコンテンツ・アイテムを拒否します。(WORKFLOW_REJECT)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dDocName | path | ワークフロー内のドキュメントのdDocName | はい | 文字列 |
| rejectMessage | query | 拒否メッセージ。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | コンテンツ・アイテムは拒否されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフロー内のコンテンツ・アイテムID9400002011を拒否します。
リクエスト
POST …/documents/wcc/api/v1.1/files/ID9400002011/workflow/.reject
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ワークフローの拒否
POST /documents/wcc/api/v1.1/files/.by.did/{dID}/workflow/.reject
説明
ワークフロー内のコンテンツ・アイテムのリビジョンを拒否します。(WORKFLOW_REJECT)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dID | path | ワークフロー内のコンテンツ・アイテムのリビジョン識別子。 | はい | 文字列 |
| rejectMessage | query | 拒否メッセージ。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | コンテンツ・アイテムは拒否されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフロー内のアイテム・リビジョン24353523を拒否します。
リクエスト
POST …/documents/wcc/api/v1.1/files/.by.did/24353523/workflow/.reject
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ワークフロー
ワークフロー情報の取得
GET /documents/wcc/api/v1.1/workflows/{dWfName}
説明
名前でワークフロー情報を取得します。(GET_WORKFLOW)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dWfName | path | ワークフロー名 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ワークフロー情報 | WorkflowInformationResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフローcriteriawf1に関する情報を取得します。
リクエスト
GET …/documents/wcc/api/v1.1/workflows/criteriawf1
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"workflow": {
"dWfID": 2,
"dWfName": "criteriawf1",
"dWfDescription": "Criteria Workflow1",
"dCompletionDate": null,
"dSecurityGroup": "Public",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
},
"workflowSteps": [
{
"dWfStepID": 3,
"dWfStepName": "contribution",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":C:CA:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0
},
{
"dWfStepID": 4,
"dWfStepName": "step1",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":R:C:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0,
"dAliases": "weblogic\tuser"
}
],
"workflowStepEvents": [
{
"dWfStepName": "step1",
"wfEntryScript": null,
"wfExitScript": null,
"wfUpdateScript": null
}
]ワークフロー内のコンテンツ・アイテム・リビジョンの取得
GET /documents/wcc/api/v1.1/workflows/{dWfName}/docrevisions
説明
ワークフロー内のコンテンツ・アイテム・リビジョンのリストを取得します。(GET_WORKFLOWDOCREVISIONS)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dWfName | path | ワークフロー名 | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ワークフロー情報 | WorkflowInformationRevisionsResponse |
| 204 | このワークフローにコンテンツ・アイテムはありません。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ワークフローcriteriawf1のリビジョンに関する情報を取得します。
リクエスト
GET …documents/wcc/api/v1.1/workflows/criteriawf1/docrevisions
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"wf_info": {
"dWfID": 2,
"dWfName": "criteriawf1",
"dWfDescription": "Criteria Workflow1",
"dCompletionDate": null,
"dSecurityGroup": "Public",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
},
"workflowSteps": [
{
"dWfStepID": 3,
"dWfStepName": "contribution",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":C:CA:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0,
"dHasTokens": "false"
},
{
"dWfStepID": 4,
"dWfStepName": "step1",
"dWfID": 2,
"dWfStepDescription": null,
"dWfStepType": ":R:C:CE:",
"dWfStepIsAll": 0,
"dWfStepWeight": 1,
"dWfStepIsSignature": 0,
"dUsers": "user:weblogic",
"dHasTokens": "false"
}
],
"wfDocuments": [
{
"dWfID": 2,
"dDocName": "ID45654",
"dWfDocState": "INPROCESS",
"dWfComputed": null,
"dWfCurrentStepID": 4,
"dWfDirectory": "public",
"dVitalState": "Y",
"xReportType": null,
"xIsEditable": "1",
"xHasFixedClone": 0,
"dCharacterSet": null,
"xRelatedContentTriggerDate": null,
"xRecordCutoffDate": null,
"dLastModifiedDate": "2024-05-22 16:34:18Z",
"dRecordState": null,
"dMessage": null,
"dWebExtension": "jpg",
"xClassifiedMarkings": null,
"xStorageRule": "DispByContentId",
"dIndexerState": null,
"xSuperSupersededDate": null,
"dReleaseDate": null,
"dOutDate": null,
"dRevClassID": 7846,
"xIsVital": "0",
"xRelatedContentList": null,
"xIsDeletable": "1",
"dRmaProcessState": "Y",
"xRecordDestroyDate": null,
"xVitalPeriodUnits": null,
"xSource": null,
"xRecordFilingDate": "2024-05-22 16:32:00Z",
"dStatus": "REVIEW",
"dInDate": "2024-05-22 16:32:00Z",
"xRecordReviewDate": null,
"xCpdIsTemplateEnabled": 0,
"xPartitionId": null,
"dReleaseState": "E",
"xCpdIsLocked": 0,
"xIsFixedClone": 0,
"xReportContentType": null,
"xCategoryID": null,
"dPublishState": null,
"xAuditPeriod": null,
"dID": 8446,
"xLibraryGUID": null,
"xRecordSupersededDate": null,
"xDeleteApproveDate": null,
"xIsACLReadOnlyOnUI": 0,
"xComments": "criteriawf1",
"dRendition1": null,
"xNewRevisionDate": "2024-05-22 16:34:05Z",
"dRendition2": null,
"xRecordCancelledDate": null,
"dRmaSegmentID": 3,
"dDocTitle": "workflow demo",
"dCheckoutUser": null,
"dFileSize": 845941,
"xRecordExpirationDate": null,
"xVitalPeriod": 0,
"dIsPrimary": 1,
"dExtension": "jpg",
"dProcessingState": "Y",
"xIsFrozen": "0",
"dWorkflowState": "W",
"xIsRevisionable": "1",
"dDocType": "Document",
"xRecordActivationDate": null,
"dLanguage": null,
"dIsCheckedOut": 0,
"xSupersededContent": null,
"xIdcProfile": null,
"dDocAuthor": "weblogic",
"dIsWebFormat": 0,
"xFreezeID": "0",
"xIsSubjectToAudit": "0",
"xFreezeReason": null,
"dPublishType": null,
"dFormat": "image/jpeg",
"xClbraUserList": null,
"xIsRecord": "0",
"xFolderID": null,
"dRevRank": 0,
"dDocID": 13691,
"xClbraAliasList": null,
"dLocation": null,
"xSupplementalMarkings": null,
"xWebFlag": null,
"dOriginalName": "Desert.jpg",
"xRecordObsoleteDate": null,
"xAnnotationDetails": 0,
"dSecurityGroup": "Public",
"xVitalReviewer": null,
"dFlag1": null,
"dCreateDate": "2024-05-22 16:34:05Z",
"xRecordRescindedDate": null,
"xExternalDataSet": null,
"dRevisionID": 1,
"xLongName": null,
"dRevLabel": "1",
"dDocAccount": null,
"xIsCutoff": "0",
"xNoLatestRevisionDate": null
}
]アクティブなワークフロー
GET /documents/wcc/api/v1.1/workflows/active/items
説明
アクティブなワークフローを取得します。(GET_ACTIVE_WORKFLOWS)
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | アクティブなワークフローのリスト。 | WorkflowActiveResponse |
| 204 | システム内にアクティブな標準ワークフローがありません。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
アクティブなワークフローを一覧表示します。
リクエスト
GET …/documents/wcc/api/v1.1/workflows/active/items
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"count": 3,
"items": [
{
"dWfID": 2,
"dWfName": "criteriawf1",
"dWfDescription": "Criteria Workflow1",
"dCompletionDate": null,
"dSecurityGroup": "Public",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
},
{
"dWfID": 201,
"dWfName": "criteriawf2",
"dWfDescription": null,
"dCompletionDate": null,
"dSecurityGroup": "Public",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
},
{
"dWfID": 402,
"dWfName": "criteriawf4",
"dWfDescription": "Criteria 4 on Secure Group",
"dCompletionDate": null,
"dSecurityGroup": "Secure",
"dWfStatus": "INPROCESS",
"dWfType": "Criteria",
"dIsCollaboration": 0
}
]現在のワークフロー割当ての取得
GET …/documents/wcc/api/v1.1/workflows/inqueue/items
説明
ユーザーの現在のワークフロー割当てを取得します。(GET_WORKFLOW_INQUEUE_LIST、GET_WORKFLOW_INQUEUE_LIST_EX)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fields | query | 各コンテンツ・アイテムに対して返されるフィールドのカンマ区切りリスト。デフォルトでは、すべてのフィールドが返されます。 | いいえ | 文字列 |
| orderBy | query | フィルタされたコンテンツ・アイテムのソートに使用されるソート・フィールドおよびソート順序。たとえば、dwfQueueLastActionTs:Descは、指定されたフィールドを降順でソートします。 |
いいえ | 文字列 |
| limit | query | 1ページにリストされるアイテムの最大数。指定しない場合、制限は構成設定WfInqueueMaxRowsから計算されます。どちらも設定されていない場合、デフォルトは20です。 |
いいえ | 数値 |
| offset | query | レスポンスにアイテムがリストされる起点を指定します。 | いいえ | 数値 |
| doMarkSubscribed | query | 1の場合、フォルダがサブスクライブされているかどうかを示すfIsSubscribedフィールドが結果セットに追加されます。 |
いいえ | 数値 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ユーザーのキュー内のワークフロー。 | WorkflowInQueueResponse |
| 204 | キュー内のワークフローが空です。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ユーザーのワークフロー割当て。
リクエスト
GET …/documents/wcc/api/v1.1/workflows/inqueue/items
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"count": 1,
"hasMore": false,
"numPages": 1,
"pageNumber": 1,
"totalRows": 1,
"startRow": 1,
"endRow": 1,
"items": [
{
"dUser": "weblogic",
"dDocName": "ID45654",
"dID": 8446,
"dWfID": 2,
"dWfName": "criteriawf1",
"dWfStepName": "step1",
"dwfQueueActionState": null,
"dwfQueueEnterTs": "2024-05-22 16:34:05Z",
"dwfQueueLastActionTs": "2024-05-22 16:34:05Z",
"wfMessage": null,
"dVitalState": "Y",
"xReportType": null,
"xIsEditable": "1",
"xHasFixedClone": 0,
"dCharacterSet": null,
"xRelatedContentTriggerDate": null,
"dwfMessage": null,
"xRecordCutoffDate": null,
"dLastModifiedDate": "2024-05-22 16:34:18Z",
"dWfStepType": ":R:C:CE:",
"dRecordState": null,
"dMessage": null,
"dWebExtension": "jpg",
"xClassifiedMarkings": null,
"xStorageRule": "DispByContentId",
"dIndexerState": null,
"dWfStepID": 4,
"xSuperSupersededDate": null,
"dReleaseDate": null,
"dOutDate": null,
"dRevClassID": 7846,
"xIsVital": "0",
"xRelatedContentList": null,
"xIsDeletable": "1",
"dWfStepDescription": null,
"wfQueueLastActionTs": "2024-05-22 16:34:05Z",
"dRmaProcessState": "Y",
"xRecordDestroyDate": null,
"xVitalPeriodUnits": null,
"dWfStepWeight": 1,
"xSource": null,
"xRecordFilingDate": "2024-05-22 16:32:00Z",
"dStatus": "REVIEW",
"dInDate": "2024-05-22 16:32:00Z",
"xRecordReviewDate": null,
"dWfStepIsAll": 0,
"xCpdIsTemplateEnabled": 0,
"xPartitionId": null,
"dReleaseState": "E",
"xCpdIsLocked": 0,
"xIsFixedClone": 0,
"xReportContentType": null,
"xCategoryID": null,
"dPublishState": null,
"xAuditPeriod": null,
"xLibraryGUID": null,
"xRecordSupersededDate": null,
"xDeleteApproveDate": null,
"xIsACLReadOnlyOnUI": 0,
"xComments": "criteriawf1",
"dRendition1": null,
"xNewRevisionDate": "2024-05-22 16:34:05Z",
"dRendition2": null,
"xRecordCancelledDate": null,
"wfQueueActionState": null,
"dRmaSegmentID": 3,
"dDocTitle": "workflow demo",
"dCheckoutUser": null,
"dFileSize": 845941,
"xRecordExpirationDate": null,
"xVitalPeriod": 0,
"dIsPrimary": 1,
"dExtension": "jpg",
"dProcessingState": "Y",
"xIsFrozen": "0",
"dWorkflowState": "W",
"xIsRevisionable": "1",
"dDocType": "Document",
"xRecordActivationDate": null,
"dLanguage": null,
"dIsCheckedOut": 0,
"xSupersededContent": null,
"xIdcProfile": null,
"dDocAuthor": "weblogic",
"dIsWebFormat": 0,
"xFreezeID": "0",
"xIsSubjectToAudit": "0",
"xFreezeReason": null,
"dPublishType": null,
"dFormat": "image/jpeg",
"xClbraUserList": null,
"xIsRecord": "0",
"xFolderID": null,
"dRevRank": 0,
"dDocID": 13691,
"xClbraAliasList": null,
"dLocation": null,
"xSupplementalMarkings": null,
"wfQueueEnterTs": "2024-05-22 16:34:05Z",
"xWebFlag": null,
"dOriginalName": "Desert.jpg",
"dWfStepIsSignature": 0,
"xRecordObsoleteDate": null,
"xAnnotationDetails": 0,
"dSecurityGroup": "Public",
"xVitalReviewer": null,
"dFlag1": null,
"dCreateDate": "2024-05-22 16:34:05Z",
"xRecordRescindedDate": null,
"xExternalDataSet": null,
"dRevisionID": 1,
"xLongName": null,
"dRevLabel": "1",
"dDocAccount": null,
"xIsCutoff": "0",
"xNoLatestRevisionDate": null
}
]}
システム
サーバーへのPING
GET /documents/wcc/api/v1.1/system/ping
説明
サーバーが動作していることを確認します(PING_SERVER)。
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | サーバーが使用可能です | |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
サーバーが応答していることを確認します。
リクエスト
POST …/documents/wcc/api/v1.1/system/ping
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
データ・ソースの問合せ
GET /documents/wcc/api/v1.1/system/{dataSource}/items
説明
定義済データ・ソースを介してデータベースを問い合せます。(GET_DATARESULTSET)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dataSource | path | 問い合せるサーバー・データ・ソース。サーバー表DataSourcesには、サポートされているソースがリストされます。 |
はい | 文字列 |
| whereClause | query | 選択問合せのWHERE句。 | いいえ | 文字列 |
| orderClause | query | 選択問合せのORDER句。 | いいえ | 文字列 |
| maxRows | query | 返される行の最大数を設定します。 | いいえ | 数値 |
| startRow | query | 表が返されるときにスキップする行数。 | いいえ | 数値 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | dataSourceが正常に問合せされました。レスポンスは問合せ対象のデータ・ソースに依存し、このドキュメントでは明示的に定義されていません。 | DataSourceResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
フォルダ
ルート・フォルダの参照
GET /documents/wcc/api/v1.1/folders/browse/
説明
ルート(FLD_ROOT)フォルダのコンテンツおよび構造をリストします。(FLD_BROWSE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fldapp | query | 返される場所のフォルダ・アプリケーションを指定します | いいえ | 文字列 |
| doCombinedBrowse | query | trueの場合、データは結合ページ区切りモードで返されます。 | いいえ | ブール |
| foldersFirst | query | trueの場合、結合ページ区切りモードではフォルダがファイルの前にリストされます。 | いいえ | ブール |
| folderCount | query | 返すフォルダの数。 | いいえ | 整数 |
| folderStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| fileCount | query | 返すファイルの数。 | いいえ | 整数 |
| fileStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| combinedCount | query | 返すアイテム(フォルダとファイル)の数。 | いいえ | 整数 |
| combinedStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| doRetrieveTargetInfo | query | trueの場合、結果セットChildTargetFoldersで取得されたすべてのショートカットについて、ターゲット・フォルダの情報を返します。 | いいえ | ブール |
| doMarkFavorites | query | trueの場合、結果セットに'fIsFavorite'フィールドを追加して、フォルダ/ファイルがお気に入りかどうかを示します。お気に入りフォルダにショートカットがある場合はお気に入りです。 | いいえ | ブール |
| doMarkSubscribed | query | trueの場合、結果セットに'fIsSubscribed'フィールドを追加して、フォルダがサブスクライブされているかどうかを示します。サブスクリプション表にフォルダとAPIをコールしているユーザーのエントリがある場合、フォルダはサブスクライブされています。 | いいえ | ブール |
| doRetrieveDocumentURL | query | trueの場合、返されるデータにURLフィールド(ドキュメントのWebの場所)を追加します。 | いいえ | ブール |
| doRetrieveUniqueLinks | query | trueの場合、配列を後処理して一意のリンクのみを返します。たとえば、フォルダのショートカットとそのフォルダそのものが配列にある場合、フォルダそのもののみが返されます。 | いいえ | ブール |
| foldersSortField | query | レコードをソートする、FolderFolders表内のフィールド名。 | いいえ | 文字列 |
| foldersSortOrder | query | foldersSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| filesSortField | query | レコードをソートする、FolderFiles表内のフィールド名。 | いいえ | 文字列 |
| filesSortOrder | query | filesSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| combinedSortField | query | アイテムをソートするフィールド名(FolderFiles表とFolderFolders表の両方に共通)。 | いいえ | 文字列 |
| combinedSortOrder | query | combinedSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| foldersFilterParams | query | 参照のフィルタ・パラメータのカンマ区切りリスト。たとえば、foldersFilterParams=fIsContribution&fIsContribution=1では、fIsContribution=1のフォルダが返されます。 |
いいえ | 文字列 |
| foldersFilterQuery | query | フォルダをフィルタするための標準問合せ構文。この形式は、FolderFolders表に対するDATABASEエンジンの形式です。例: foldersFilterQuery=fFolderName |
いいえ | 文字列 |
| fieldName | query | foldersFilterParamsおよびfilesFilterParamsで指定したフィールドの値 |
いいえ | 文字列 |
| filesFilterParams | query | 参照のフィルタ・パラメータのカンマ区切りリスト。たとえば、filesFilterParams=fOwner&fOwner=sysadminでは、fOwner=sysadminのフォルダが返されます |
いいえ | 文字列 |
| filesFilterQuery | query | ファイルをフィルタするための標準問合せ構文。この形式は、FolderFiles表に対するDATABASEエンジンの形式です。例: filesFilterQuery=fFileName |
いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | フォルダの構造。 | FolderBrowseResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
FLD_ROOTフォルダを参照します。この例では、追加のフォルダとファイルを示します。
リクエスト
GET …/documents/wcc/api/v1.1/folders/browse/
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"numFolders": 3,
"hasMoreChildFolders": 0,
"numFiles": 1,
"totalChildFoldersCount": 3,
"totalChildFilesCount": 1,
"hasMoreChildFiles": 0,
"hasMoreChildItems": 0,
"folderPath": "/",
"folderInfo": {
"fFolderGUID": "FLD_ROOT",
"fParentGUID": "idcnull",
"fFolderName": "/",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "sysadmin",
"fCreator": "sysadmin",
"fLastModifier": "sysadmin",
"fCreateDate": "2024-03-18 20:15:54Z",
"fLastModifiedDate": "2024-03-18 20:15:54Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 5,
"fChildFilesCount": 1,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "/",
"fDisplayDescription": null,
"fIsBrokenShortcut": null,
"isLeaf": "0",
"itemType": "1",
"folderPermissions": "RWDA"
},
"childFolders": [
{
"fFolderGUID": "FLD_ENTERPRISE_LIBRARY",
"fParentGUID": "FLD_ROOT",
"fFolderName": "Enterprise Libraries",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "sysadmin",
"fCreator": "sysadmin",
"fLastModifier": "sysadmin",
"fCreateDate": "2024-03-18 20:15:54Z",
"fLastModifiedDate": "2024-03-18 20:15:54Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": "Enterprise Libraries",
"fChildFoldersCount": 0,
"fChildFilesCount": 0,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "Enterprise Libraries",
"fDisplayDescription": "Enterprise Libraries"
},
{
"fFolderGUID": "D6413BD3FD74C638A5ED5352AEF456C1",
"fParentGUID": "FLD_ROOT",
"fFolderName": "Folder",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 20:46:39Z",
"fLastModifiedDate": "2024-05-22 20:46:39Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 0,
"fChildFilesCount": 0,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "Folder",
"fDisplayDescription": null
},
{
"fFolderGUID": "FLD_USERS",
"fParentGUID": "FLD_ROOT",
"fFolderName": "Users",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "sysadmin",
"fCreator": "sysadmin",
"fLastModifier": "sysadmin",
"fCreateDate": "2024-03-18 20:15:54Z",
"fLastModifiedDate": "2024-03-18 20:15:54Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 0,
"fChildFilesCount": 0,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "Users",
"fDisplayDescription": "Users"
}
],
"childFiles": [
{
"fFileGUID": "D7B229794E0E9A57985D771CD070C750",
"fParentGUID": "FLD_ROOT",
"fTargetGUID": null,
"fFileName": "Mugs.jpg",
"fPublishedFileName": "Mugs.jpg",
"fFileType": "owner",
"fIsInTrash": 0,
"fRealItemGUID": null,
"fDocClass": "Base",
"fInhibitPropagation": 0,
"dDocName": "ID14006204",
"dRevisionID": 1,
"dPublishedRevisionID": 1,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 20:48:40Z",
"fLastModifiedDate": "2024-05-22 20:48:40Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fIsACLReadOnlyOnUI": "0",
"dID": 6207,
"dDocType": "Document",
"dDocTitle": "file",
"dDocAuthor": "weblogic",
"dRevClassID": 6205,
"dRevLabel": "1",
"dIsCheckedOut": 0,
"dCheckoutUser": null,
"dSecurityGroup": "Public",
"dCreateDate": "2024-05-22 20:48:40Z",
"dInDate": "2024-05-22 20:46:00Z",
"dOutDate": null,
"dStatus": "RELEASED",
"dReleaseState": "Y",
"dFlag1": null,
"dWebExtension": "jpg",
"dProcessingState": "Y",
"dMessage": null,
"dDocAccount": null,
"dReleaseDate": "2024-05-22 20:48:42Z",
"dRendition1": null,
"dRendition2": null,
"dIndexerState": null,
"dPublishType": null,
"dPublishState": null,
"dWorkflowState": null,
"dRevRank": 0,
"dDocID": 6413,
"dIsPrimary": 1,
"dIsWebFormat": 0,
"dLocation": null,
"dOriginalName": "Mugs.jpg",
"dFormat": "image/jpeg",
"dExtension": "jpg",
"dFileSize": 53834,
"dLanguage": null,
"dCharacterSet": null,
"xComments": null,
"xExternalDataSet": null,
"xIdcProfile": null,
"xAnnotationDetails": 0,
"xPartitionId": null,
"xWebFlag": null,
"xStorageRule": "DispByContentId",
"xTest": 0,
"xReqText": null,
"xLongText": null,
"xMemo": "Test memo",
"xDate": null,
"xDecimal": null,
"xOptionList": null,
"xLibraryGUID": null,
"xIsACLReadOnlyOnUI": 0,
"dIndexedID": 6207,
"dDocCreatedDate": "2024-05-22 20:48:40Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-22 20:48:40Z",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dDocFunction": null,
"dDocClass": null,
"fDisplayName": "Mugs.jpg"
}
]}
フォルダの参照
GET /documents/wcc/api/v1.1/folders/browse/{fFolderGUID}
説明
指定されたフォルダの内容と構造を一覧表示します。(FLD_BROWSE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFolderGUID | path | フォルダGUID。 | はい | 文字列 |
| fldapp | query | 返される場所のフォルダ・アプリケーションを指定します | いいえ | 文字列 |
| doCombinedBrowse | query | trueの場合、データは結合ページ区切りモードで返されます。 | いいえ | ブール |
| foldersFirst | query | trueの場合、結合ページ区切りモードではフォルダがファイルの前にリストされます。 | いいえ | ブール |
| folderCount | query | 返すフォルダの数。 | いいえ | 整数 |
| folderStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| fileCount | query | 返すファイルの数。 | いいえ | 整数 |
| fileStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| combinedCount | query | 返すアイテム(フォルダとファイル)の数。 | いいえ | 整数 |
| combinedStartRow | query | データを返す最初の行番号。ページ区切りに使用されます。 | いいえ | 整数 |
| doRetrieveTargetInfo | query | trueの場合、結果セットChildTargetFoldersで取得されたすべてのショートカットについて、ターゲット・フォルダの情報を返します。 | いいえ | ブール |
| doMarkFavorites | query | trueの場合、結果セットに'fIsFavorite'フィールドを追加して、フォルダ/ファイルがお気に入りかどうかを示します。お気に入りフォルダにショートカットがある場合はお気に入りです。 | いいえ | ブール |
| doMarkSubscribed | query | trueの場合、結果セットに'fIsSubscribed'フィールドを追加して、フォルダがサブスクライブされているかどうかを示します。サブスクリプション表にフォルダとAPIをコールしているユーザーのエントリがある場合、フォルダはサブスクライブされています。 | いいえ | ブール |
| doRetrieveDocumentURL | query | trueの場合、返されるデータにURLフィールド(ドキュメントのWebの場所)を追加します。 | いいえ | ブール |
| doRetrieveUniqueLinks | query | trueの場合、配列を後処理して一意のリンクのみを返します。たとえば、フォルダのショートカットとそのフォルダそのものが配列にある場合、フォルダそのもののみが返されます。 | いいえ | ブール |
| foldersSortField | query | レコードをソートする、FolderFolders表内のフィールド名。 | いいえ | 文字列 |
| foldersSortOrder | query | foldersSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| filesSortField | query | レコードをソートする、FolderFiles表内のフィールド名。 | いいえ | 文字列 |
| filesSortOrder | query | filesSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| combinedSortField | query | アイテムをソートするフィールド名(FolderFiles表とFolderFolders表の両方に共通)。 | いいえ | 文字列 |
| combinedSortOrder | query | combinedSortFieldフィールドでのソート順。 |
いいえ | 文字列 |
| foldersFilterParams | query | 参照のフィルタ・パラメータのカンマ区切りリスト。たとえば、foldersFilterParams=fIsContribution&fIsContribution=1では、fIsContribution=1のフォルダが返されます |
いいえ | 文字列 |
| foldersFilterQuery | query | フォルダをフィルタするための標準問合せ構文。この形式は、FolderFolders表に対するDATABASEエンジンの形式です。例: foldersFilterQuery=fFolderName |
いいえ | 文字列 |
| fieldName | query | foldersFilterParamsおよびfilesFilterParamsで指定したフィールドの値 |
いいえ | 文字列 |
| filesFilterParams | query | 参照のフィルタ・パラメータのカンマ区切りリスト。たとえば、filesFilterParams=fOwner&fOwner=sysadminでは、fOwner=sysadminのフォルダが返されます |
いいえ | 文字列 |
| filesFilterQuery | query | ファイルをフィルタするための標準問合せ構文。この形式は、FolderFiles表に対するDATABASEエンジンの形式です。例: filesFilterQuery=fFileName |
いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | フォルダの構造。 | FolderBrowseResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
任意のフォルダを参照します。
リクエスト
GET …/documents/wcc/api/v1.1/folders/browse/D6413BD3FD74C638A5ED5352AEF456C1
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"numFolders": 1,
"hasMoreChildFolders": 0,
"numFiles": 1,
"totalChildFoldersCount": 1,
"totalChildFilesCount": 1,
"hasMoreChildFiles": 0,
"hasMoreChildItems": 0,
"folderPath": "/Folder",
"folderInfo": {
"fFolderGUID": "D6413BD3FD74C638A5ED5352AEF456C1",
"fParentGUID": "FLD_ROOT",
"fFolderName": "Folder",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 20:46:39Z",
"fLastModifiedDate": "2024-05-22 20:46:39Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 1,
"fChildFilesCount": 1,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "Folder",
"fDisplayDescription": null,
"fIsBrokenShortcut": null,
"isLeaf": "0",
"itemType": "1",
"folderPermissions": "RWDA"
},
"childFolders": [
{
"fFolderGUID": "4B4AFD71D5A999DBABB16704FEABCEBD",
"fParentGUID": "D6413BD3FD74C638A5ED5352AEF456C1",
"fFolderName": "jpgs",
"fFolderType": "owner",
"fInhibitPropagation": 17,
"fPromptForMetadata": 0,
"fIsContribution": 0,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "query",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 21:01:13Z",
"fLastModifiedDate": "2024-05-22 21:01:13Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 0,
"fChildFilesCount": 0,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "jpgs",
"fDisplayDescription": null
}
],
"childFiles": [
{
"fFileGUID": "2D09591B678E8AF05D8F6B1EB1879EA9",
"fParentGUID": "D6413BD3FD74C638A5ED5352AEF456C1",
"fTargetGUID": null,
"fFileName": "sample.txt",
"fPublishedFileName": "sample.txt",
"fFileType": "owner",
"fIsInTrash": 0,
"fRealItemGUID": null,
"fDocClass": "Base",
"fInhibitPropagation": 0,
"dDocName": "ID798656784",
"dRevisionID": 1,
"dPublishedRevisionID": 1,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 21:03:08Z",
"fLastModifiedDate": "2024-05-22 21:03:08Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fIsACLReadOnlyOnUI": "0",
"dID": 6208,
"dDocType": "Document",
"dDocTitle": "sample",
"dDocAuthor": "weblogic",
"dRevClassID": 6206,
"dRevLabel": "1",
"dIsCheckedOut": 0,
"dCheckoutUser": null,
"dSecurityGroup": "Public",
"dCreateDate": "2024-05-22 21:03:08Z",
"dInDate": "2024-05-22 21:01:00Z",
"dOutDate": null,
"dStatus": "RELEASED",
"dReleaseState": "Y",
"dFlag1": null,
"dWebExtension": "txt",
"dProcessingState": "Y",
"dMessage": null,
"dDocAccount": null,
"dReleaseDate": "2024-05-22 21:03:09Z",
"dRendition1": null,
"dRendition2": null,
"dIndexerState": null,
"dPublishType": null,
"dPublishState": null,
"dWorkflowState": null,
"dRevRank": 0,
"dDocID": 6415,
"dIsPrimary": 1,
"dIsWebFormat": 0,
"dLocation": null,
"dOriginalName": "sample.txt",
"dFormat": "text/plain",
"dExtension": "txt",
"dFileSize": 6,
"dLanguage": null,
"dCharacterSet": null,
"xComments": null,
"xExternalDataSet": null,
"xIdcProfile": null,
"xAnnotationDetails": 0,
"xPartitionId": null,
"xWebFlag": null,
"xStorageRule": "DispByContentId",
"xTest": 0,
"xReqText": null,
"xLongText": null,
"xMemo": "Test memo",
"xDate": null,
"xDecimal": null,
"xOptionList": null,
"xLibraryGUID": null,
"xIsACLReadOnlyOnUI": 0,
"dIndexedID": 6208,
"dDocCreatedDate": "2024-05-22 21:03:08Z",
"dDocCreator": "weblogic",
"dDocLastModifiedDate": "2024-05-22 21:03:08Z",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dDocFunction": null,
"dDocClass": null,
"fDisplayName": "sample.txt"
}
]}
フォルダの作成
POST /documents/wcc/api/v1.1/folders
説明
フォルダまたはフォルダへのショートカットを作成します。(FLD_CREATE_FOLDER)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFolderName | query | 作成するフォルダの名前。 | はい | 文字列 |
| fParentGUID | query | 新しいフォルダを作成する親フォルダのGUID。 | はい | 文字列 |
| fSecurityGroup | query | 新規フォルダのセキュリティ・グループ。デフォルトはPublicです。 |
いいえ | 文字列 |
| fFolderType | query | 作成するフォルダのタイプ。 | いいえ | 文字列 |
| fOwner | query | フォルダの所有者。デフォルトは、コールを行うユーザーです。 | いいえ | 文字列 |
| fInhibitPropagation | query | ファイル/フォルダの親からの値の伝播の制限を決定するために使用されるビットマップ。ビットマップには次のものが含まれます: 0 - 伝播禁止がnoneに設定されている場合、親から値を継承できることを示します 1 - メタデータの伝播の禁止。メタデータが親から継承されないことを示します 16 - フォルダ・セキュリティの伝播の禁止。フォルダ・セキュリティが親から継承されないことを示します 17 - メタデータおよびフォルダ・セキュリティの伝播の禁止 |
いいえ | 数値 |
| fTargetGUID | query | フォルダ・ショートカット作成時のターゲット・フォルダのGUID。 | いいえ | 文字列 |
| ConflictResolutionMethod | query | フォルダ名の競合を解決するために使用する方法: •ResolveDuplicates – 作成されたフォルダには、 fFolderNameパラメータに基づいて一意の名前が付けられます•SkipDuplicates - 名前がすでに存在する場合、フォルダは作成されません |
いいえ | 文字列 |
| isForceInheritSecurityForFolderCreation | query | trueの場合、フォルダは親フォルダからセキュリティを継承します。 | いいえ | ブール |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 201 | フォルダが正常に作成されました。 新しいフォルダのメタデータを取得するためのURIであるヘッダー Locationを返します。 |
|
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 409 | ConflictResolutionMethodがSkipDuplicatesで、フォルダ名が存在する場合、新しいフォルダは作成されません |
|
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
FLD_ROOTの下にRestCreatedFolderという名前のフォルダを作成します
リクエスト
POST …/documents/wcc/api/v1.1/folders?fParentGUID=FLD_ROOT&fFolderName=RestCreatedFolder
リクエストのパラメータ
fParentGUID = FLD_ROOT
fFolderName = RestCreatedFolder
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 201
ヘッダー
Location = …/documents/wcc/api/v1.1/folders/BE8851AE80FBAFAB3C2BB4AA127402C0
フォルダ情報の取得
GET /documents/wcc/api/v1.1/folders/{fFolderGUID}
説明
指定したフォルダに関する情報を取得します(FLD_INFO)。
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFolderGUID | path | フォルダGUID | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | フォルダ情報。 | FolderInfoResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
GUIDがD6413BD3FD74C638A5ED5352AEF456C1のフォルダのフォルダ情報を取得します。
リクエスト
GET …/documents/wcc/api/v1.1/folders/D6413BD3FD74C638A5ED5352AEF456C1
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"folderPath": "/Folder",
"folderInfo": {
"fFolderGUID": "D6413BD3FD74C638A5ED5352AEF456C1",
"fParentGUID": "FLD_ROOT",
"fFolderName": "Folder",
"fFolderType": "owner",
"fInhibitPropagation": 0,
"fPromptForMetadata": 0,
"fIsContribution": 1,
"fIsInTrash": 0,
"fRealItemGUID": null,
"fLibraryType": null,
"fIsLibrary": 0,
"fDocClasses": null,
"fTargetGUID": null,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 20:46:39Z",
"fLastModifiedDate": "2024-05-22 20:46:39Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fFolderDescription": null,
"fChildFoldersCount": 1,
"fChildFilesCount": 1,
"fFolderSize": 0,
"fAllocatedFolderSize": -1,
"fAllocatorParentFolderGUID": null,
"fApplicationGUID": null,
"fIsReadOnly": 0,
"fIsACLReadOnlyOnUI": 0,
"fDisplayName": "Folder",
"fDisplayDescription": null,
"fIsBrokenShortcut": null,
"isLeaf": "0",
"itemType": "1",
"folderPermissions": "RWDA"
}}
ファイル情報の取得
GET /documents/wcc/api/v1.1/folders/files/{fFileGUID}
説明
フォルダ内の指定したファイルに関する情報を取得します。(FLD_INFO)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFileGUID | path | ファイルGUID | はい | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ファイル情報およびメタデータ。 | FileInfoResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
GUIDがD7B229794E0E9A57985D771CD070C750のファイルのファイル情報を取得します。
リクエスト
GET …/documents/wcc/api/v1.1/folders/files/D7B229794E0E9A57985D771CD070C750
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"filePath": "/Mugs.jpg",
"fileInfo": {
"fFileGUID": "D7B229794E0E9A57985D771CD070C750",
"fParentGUID": "FLD_ROOT",
"fTargetGUID": null,
"fFileName": "Mugs.jpg",
"fPublishedFileName": "Mugs.jpg",
"fFileType": "owner",
"fIsInTrash": 0,
"fRealItemGUID": null,
"fDocClass": "Base",
"fInhibitPropagation": 0,
"dDocName": "ID14006204",
"dRevisionID": 1,
"dPublishedRevisionID": 1,
"fApplication": "framework",
"fOwner": "weblogic",
"fCreator": "weblogic",
"fLastModifier": "weblogic",
"fCreateDate": "2024-05-22 20:48:40Z",
"fLastModifiedDate": "2024-05-22 20:48:40Z",
"fSecurityGroup": "Public",
"fDocAccount": null,
"fClbraUserList": null,
"fClbraAliasList": null,
"fClbraRoleList": null,
"fIsACLReadOnlyOnUI": "0",
"fDisplayName": "Mugs.jpg",
"fDisplayDescription": null,
"dCharacterSet": null,
"dCheckoutUser": null,
"dCreateDate": "2024-05-22 20:48:40Z",
"dDocAccount": null,
"dDocAuthor": "weblogic",
"dDocCreatedDate": "{ts '2024-05-22 15:48:40.640'}",
"dDocCreator": "weblogic",
"dDocID": 6413,
"dDocLastModifiedDate": "{ts '2024-05-22 15:48:40.640'}",
"dDocLastModifier": "weblogic",
"dDocOwner": "weblogic",
"dDocTitle": "file",
"dDocType": "Document",
"dExtension": "jpg",
"dFileSize": 53834,
"dFlag1": null,
"dFormat": "image/jpeg",
"dID": 6207,
"dInDate": "2024-05-22 20:46:00Z",
"dIndexerState": null,
"dIsCheckedOut": 0,
"dIsPrimary": 1,
"dIsWebFormat": 0,
"dLanguage": null,
"dLocation": null,
"dMessage": null,
"dOriginalName": "Mugs.jpg",
"dOutDate": null,
"dProcessingState": "Y",
"dPublishState": null,
"dPublishType": null,
"dReleaseDate": "2024-05-22 20:48:42Z",
"dReleaseState": "Y",
"dRendition1": null,
"dRendition2": null,
"dRevClassID": 6205,
"dRevLabel": "1",
"dRevRank": 0,
"dSecurityGroup": "Public",
"dStatus": "RELEASED",
"dWebExtension": "jpg",
"dWorkflowState": null,
"fFolderType": "soft",
"isLeaf": "1",
"itemType": "2",
"xAnnotationDetails": 0,
"xComments": null,
"xDate": null,
"xDecimal": null,
"xExternalDataSet": null,
"xIdcProfile": null,
"xIsACLReadOnlyOnUI": 0,
"xLibraryGUID": null,
"xLongText": null,
"xMemo": "Test memo",
"xOptionList": null,
"xPartitionId": null,
"xReqText": null,
"xStorageRule": "DispByContentId",
"xTest": 0,
"xWebFlag": null,
"permissions": "RWDA"
}}
ファイルの削除
DELETE /documents/wcc/api/v1.1/folders/files/{fFileGUID}
説明
フォルダ内の指定されたファイルを削除します。(FLD_DELETE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFileGUID | path | ファイルGUID | はい | 文字列 |
| permanentDelete | query | デフォルトはfalseで、ファイルはごみ箱に移動されます。trueの場合、ファイルは完全に削除されます。 | いいえ | ブール |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | ドキュメントが正常に削除されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | GeneralErrorResponse |
| 404 | ファイルが見つかりません | GeneralErrorResponse |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
GUID 3C0A71FAA57BFA57D8CAB45097BA8D85で識別されるファイルを削除します
リクエスト
DELETE …/documents/wcc/api/v1.1/folders/files/3C0A71FAA57BFA57D8CAB45097BA8D85
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
フォルダの削除
DELETE /documents/wcc/api/v1.1/folders/{fFolderGUID}
説明
指定されたフォルダを削除します。(FLD_DELETE)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| fFolderGUID | path | フォルダGUID | はい | 文字列 |
| permanentDelete | query | デフォルトはfalseで、ファイルはごみ箱に移動されます。trueの場合、ファイルは完全に削除されます。 | いいえ | ブール |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 204 | フォルダが正常に削除されました。 | |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | GeneralErrorResponse |
| 404 | フォルダが見つかりません | GeneralErrorResponse |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
GUID 1BC11C2415A60641882C48EAF488A1E6で識別されるフォルダを削除します
リクエスト
DELETE …/documents/wcc/api/v1.1/folders/1BC11C2415A60641882C48EAF488A1E6
リクエスト本文
ありません。
HTTPレスポンス
ステータス = 204
本文
ありません。
ファイルおよびフォルダの検索
GET /documents/wcc/api/v1.1/folders/search/items
説明
フォルダ構造内のファイルおよびフォルダを検索します。(FLD_FOLDER_SEARCH)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| q | query | コンテンツ・アイテムのフィルタに使用される検索問合せ。 | いいえ | 文字列 |
| fields | query | 返されるメタデータ・フィールドのカンマ区切りリスト。デフォルトでは、メタデータ・フィールドが返されます。 | いいえ | 文字列 |
| orderBy | query | フィルタされたコンテンツ・アイテムのソートに使用されるソート・フィールドおよびソート順序。 | いいえ | 文字列 |
| limit | query | 1ページにリストされるアイテムの最大数。 | いいえ | 整数 |
| offset | query | レスポンスにアイテムがリストされる起点を指定します。 | いいえ | 整数 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | 検索結果が正常に返されました | FoldersSearchResultsResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | GeneralErrorResponse |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
Secureセキュリティ・グループで4つのフォルダを検索し、3つの特定のフィールドのみを返します。
リクエスト
GET …/documents/wcc/api/v1.1/folders/search/items
リクエスト本文
問合せパラメータ: itemType=Folder & q=fSecurityGroup <matches> `Secure` & fields=fFolderGUID, fSecurityGroup, fCreateDate & limit=4
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"itemType": "Folder",
"q": " fSecurityGroup LIKE 'Secure' AND ((fLibraryType != '2' OR fLibraryType IS NULL)) AND ((fLibraryType != '3' OR fLibraryType IS NULL)) AND ((UPPER(fFolderName) != UPPER('Trash') OR (UPPER(fFolderName) IS NULL))) AND ((UPPER(fFolderName) != UPPER('_REAL_ITEMS') OR (UPPER(fFolderName) IS NULL))) AND ((fIsInTrash != '1' OR fIsInTrash IS NULL)) ",
"count": 4,
"hasMore": true,
"totalCount": 16,
"orderBy": "fFolderName:Asc",
"offset": 0,
"limit": 4,
"startRow": 0,
"nextRow": 4,
"dataSource": "FldFolders",
"searchEngineName": "DATABASE.METADATA.FOLDERS",
"items": [
{
"fFolderGUID": "802062EE2F5EC5A3E2DAAA27B72D14CD",
"fCreateDate": "2024-07-07 12:08:50Z",
"fSecurityGroup": "Secure"
},
{
"fFolderGUID": "81D398B26CCA513DD66AC0315F3949FD",
"fCreateDate": "2024-07-07 12:08:52Z",
"fSecurityGroup": "Secure"
},
{
"fFolderGUID": "4B8EB5A37E29FA7752A58EAE2D2C0236",
"fCreateDate": "2024-07-24 06:39:40Z",
"fSecurityGroup": "Secure"
},
{
"fFolderGUID": "8FD8B4C33F4C5ACB3A7B25820AA6CFBE",
"fCreateDate": "2024-07-24 06:39:50Z",
"fSecurityGroup": "Secure"
}
]}
ユーザー
権限情報の取得
GET /documents/wcc/api/v1.1/users/permissions
説明
現在のユーザーがsecurityGroupsおよびdocumentAccountsに対して持っている権限のリストを取得します。(GET_USER_PERMISSIONS)
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | ユーザー権限情報が正常に返されました。 | UserPermissionResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
ユーザーが持っているすべての権限をリストします。
リクエスト
GET …/documents/wcc/api/v1.1/users/permissions
リクエスト本文
なし
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"dName": "weblogic",
"securityGroups": [
{
"dGroupName": "Public",
"privilege": "15"
},
{
"dGroupName": "RecordsGroup",
"privilege": "15"
},
{
"dGroupName": "Reservation",
"privilege": "15"
},
{
"dGroupName": "Secure",
"privilege": "15"
}
],
"userSecurityFlags": [
{
"flag": "IsAdmin",
"value": "1"
},
{
"flag": "AdminAtLeastOneGroup",
"value": "1"
},
{
"flag": "IsSubAdmin",
"value": "1"
},
{
"flag": "IsSysManager",
"value": "1"
},
{
"flag": "IsContributor",
"value": "1"
},
{
"flag": "ActAsAnonymous",
"value": "0"
}
]}
ページ
カスタム・フィールドの取得
GET /documents/wcc/api/v1.1/pages/displayFields
説明
様々なコンテンツ・サーバー・ページのカスタム・メタデータ・フィールドに関する情報を取得します。(GET_DISPLAY_FIELDS)
パラメータ
| 名前 | 場所 | 説明 | 必須 | スキーマ |
|---|---|---|---|---|
| dpAction | query | アクションのタイプ。次のいずれかである必要があります: •CheckinNew •CheckinSel •CheckinSimilar •Info •Update •Search •FLDMetadataUpdate •FLDMetadataInfo |
はい | 文字列 |
| dID | query | dpActionが次のいずれかの場合は必須: •CheckinSel •CheckinSimilar •Info •Update |
場合による | 整数 |
| fFolderGUID | query | dpActionが次のいずれかの場合は必須:•FLDMetadataUpdate •FLDMetadataInfo |
場合による | 文字列 |
| dpTriggerValue | query | プロファイルのロードに使用されるトリガー値。 | いいえ | 文字列 |
レスポンス
| コード | 説明 | スキーマ |
|---|---|---|
| 200 | DisplayFields情報が正常に返されました。 | CustomFieldsResponse |
| 400 | 不正なリクエストです | GeneralErrorResponse |
| 401 | 権限がありません | |
| 403 | ユーザーはこのアクションを実行できません | |
| 500 | サーバーで予期しない状態が発生し、リクエストを処理できませんでした | GeneralErrorResponse |
例
Searchアクションの表示フィールドをリストします。
リクエスト
GET …/documents/wcc/api/v1.1/pages/displayFields
リクエスト本文
問合せパラメータ: dpAction = Search
HTTPレスポンス
ステータス = 200
本文
本文の展開
{
"displayFieldInfo": [
{
"fieldName": "dOriginalName",
"fieldType": "Text",
"fieldLabel": "Name",
"fieldLength": "255",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a file name.",
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "5",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dDocName",
"fieldType": "Text",
"fieldLabel": "Content ID",
"fieldLength": "100",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "10",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dDocType",
"fieldType": "Text",
"fieldLabel": "Type",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a type.",
"defaultValue": "Document",
"displayValue": "Document - Any generic document",
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "dDocType.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "20",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dDocTitle",
"fieldType": "Text",
"fieldLabel": "Title",
"fieldLength": "255",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a title.",
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "30",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dDocAuthor",
"fieldType": "Text",
"fieldLabel": "Author",
"fieldLength": "200",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify an author.",
"defaultValue": "weblogic",
"displayValue": "weblogic",
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "dDocAuthor.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "40",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "1"
},
{
"fieldName": "dSecurityGroup",
"fieldType": "Text",
"fieldLabel": "Security Group",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a security group.",
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "dSecurityGroup.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "50",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "primaryFile",
"fieldType": "File",
"fieldLabel": "Primary File",
"fieldLength": null,
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a primary file.",
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "100",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "alternateFile",
"fieldType": "File",
"fieldLabel": "Alternate File",
"fieldLength": null,
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "110",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dRevLabel",
"fieldType": "Text",
"fieldLabel": "Revision",
"fieldLength": "10",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a revision label.",
"defaultValue": "1",
"displayValue": "1",
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "200",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dInDate",
"fieldType": "Date",
"fieldLabel": "Release Date",
"fieldLength": "20",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "1",
"requiredMsg": "Please specify a release date.",
"defaultValue": "5/21/24 11:45 PM",
"displayValue": "5/21/24 11:45 PM",
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "1000",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "dOutDate",
"fieldType": "Date",
"fieldLabel": "Expiration Date",
"fieldLength": "20",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "1010",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xComments",
"fieldType": "Memo",
"fieldLabel": "Comments",
"fieldLength": "2000",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "5001",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xIdcProfile",
"fieldType": "Text",
"fieldLabel": "Profile",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "xIdcProfile.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "5006",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xTemplateType",
"fieldType": "Text",
"fieldLabel": "Template Type",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "xTemplateType.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "5040",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xParentFolders",
"fieldType": "Memo",
"fieldLabel": "Parent Folder",
"fieldLength": null,
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": null,
"isTreeOptionList": null,
"optionList": null,
"optionListType": null,
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "5100",
"decimalScale": null,
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xTestField2",
"fieldType": "Text",
"fieldLabel": "TestField2",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": "1",
"optionList": "xTestField2.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": "/",
"treeNodeStorageSeparator": "/",
"order": "20010",
"decimalScale": "1",
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xTestMetadata",
"fieldType": "Text",
"fieldLabel": "TestMetadata",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "xTestMetadata.options",
"optionListType": "combo",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "20011",
"decimalScale": "1",
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xTestRelField",
"fieldType": "Text",
"fieldLabel": "TestRelField",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": "1",
"optionList": "xTestRelField.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": "/",
"treeNodeStorageSeparator": "/",
"order": "20012",
"decimalScale": "1",
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xTestUseView",
"fieldType": "Text",
"fieldLabel": "TestUseView",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": "1",
"optionList": "xTestUseView.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": "/",
"treeNodeStorageSeparator": "/",
"order": "20013",
"decimalScale": "1",
"isError": "0",
"errorMsg": null,
"isUserName": "0"
},
{
"fieldName": "xtestUseView1",
"fieldType": "Text",
"fieldLabel": "testUseView1",
"fieldLength": "30",
"isHidden": "0",
"isReadOnly": "0",
"isRequired": "0",
"requiredMsg": null,
"defaultValue": null,
"displayValue": null,
"isOptionList": "1",
"isTreeOptionList": null,
"optionList": "xtestUseView1.options",
"optionListType": "choice",
"isDependent": "0",
"dependentOnField": null,
"isPadMultiselectStorage": "0",
"multiselectStorageSeparator": null,
"multiselectDisplaySeparator": null,
"isShowSelectionPath": "0",
"isStoreSelectionPath": "0",
"treeNodeDisplaySeparator": null,
"treeNodeStorageSeparator": null,
"order": "20014",
"decimalScale": "1",
"isError": "0",
"errorMsg": null,
"isUserName": "0"
}
],
"dDocType.options": [
{
"dOption": "Application",
"dDescription": "Application - Files owned by Content Server applications"
},
{
"dOption": "Binary",
"dDescription": "Binary - Executables, zip files, etc"
},
{
"dOption": "DigitalMedia",
"dDescription": "DigitalMedia - Audio, video, and images"
},
{
"dOption": "Document",
"dDescription": "Document - Any generic document"
},
{
"dOption": "RetentionCategory",
"dDescription": "wwDocTypeDesc_RetentionCategory"
},
{
"dOption": "System",
"dDescription": "System - System configuration, templates, settings"
}
],
"xTemplateType.options": [
{
"dOption": "HC Template",
"dDescription": "HTML Conversion Template"
},
{
"dOption": "GUI Template",
"dDescription": "Classic HTML Conversion Template"
},
{
"dOption": "Layout Template",
"dDescription": "Classic HTML Conversion Layout"
},
{
"dOption": "Script Template",
"dDescription": "Script Template"
},
{
"dOption": "Viewer Cache Template",
"dDescription": "Viewer Cache Template"
}
],
"dDocAuthor.options": [
{
"dOption": "LCMUser",
"dDescription": "LCMUser"
},
{
"dOption": "OracleSystemUser",
"dDescription": "OracleSystemUser"
},
{
"dOption": "sysadmin",
"dDescription": "sysadmin"
},
{
"dOption": "weblogic",
"dDescription": "weblogic"
}
],
"dSecurityGroup.options": [
{
"dOption": "Public",
"dDescription": "Public"
},
{
"dOption": "RecordsGroup",
"dDescription": "RecordsGroup"
},
{
"dOption": "Reservation",
"dDescription": "Reservation"
},
{
"dOption": "Secure",
"dDescription": "Secure"
}
]モデル
GeneralErrorResponse
一般的なエラー・レスポンス
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| type | 文字列 | エラーのタイプを説明するリンク。 | いいえ |
| title | 文字列 | 簡単なサマリー・エラー・メッセージ。 | いいえ |
| detail | 文字列 | サーバーからのエラーの詳細。サービスStatusMessage。 |
いいえ |
| errorKey | 文字列 | エラーがサービス・レイヤーから発生した場合、サービスStatusMessageKey |
いいえ |
| o:errorCode | 数値 | エラーがサービス・レイヤーから発生した場合、サービスStatusCode |
いいえ |
ResubmitConflictErrorResponse
再送信の競合409レスポンス
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| type | 文字列 | https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | いいえ |
| title | 文字列 | 再送信できません。 | いいえ |
| detail | 文字列 | コンテンツ・アイテムを再送信できません。コンテンツ・アイテムは、変換に失敗した状態ではありません。 | いいえ |
| errorKey | 文字列 | !csUnableToResubmitItem2!csResubmitNotFailed | いいえ |
| o:errorCode | 数値 | -1 | いいえ |
MetadataChangeObjectParameter
次のフィールドは、コンテンツ・アイテムのメタデータとして変更できるものの例です。他のフィールドが許可される場合もあります。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dDocType | 文字列 | ドキュメントのタイプ | いいえ |
| dDocTitle | 文字列 | ドキュメントのタイトル | いいえ |
| dRevLabel | 文字列 | ドキュメントのリビジョン | いいえ |
| dSecurityGroup | 文字列 | ドキュメントのセキュリティ・グループ | いいえ |
| dDocName | 文字列 | ドキュメントのID | いいえ |
| dDocAuthor | 文字列 | ドキュメントの作成者 | いいえ |
| xComments | 文字列 | ドキュメントに関する文字列コメント | いいえ |
MetadataObjectResponse
次のフィールドは、コンテンツ・アイテムのメタデータとして返される可能性があるものの例です。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dDocType | 文字列 | ドキュメントのタイプ | いいえ |
| dDocTitle | 文字列 | ドキュメントのタイトル | いいえ |
| dRevLabel | 文字列 | ドキュメントのリビジョン | いいえ |
| dSecurityGroup | 文字列 | ドキュメントのセキュリティ・グループ | いいえ |
| dDocName | 文字列 | ドキュメントのID | いいえ |
| dDocAuthor | 文字列 | ドキュメントの作成者 | いいえ |
| dStatus | 文字列 | このフィールドは、他のステータス・フィールドからの計算のサマリー・フィールドです。 | いいえ |
| dOriginalName | 文字列 | ドキュメント・ファイル名 | いいえ |
| dFormat | 文字列 | ドキュメントのMIMEタイプ | いいえ |
| dFileSize | 数値 | ドキュメント・ファイル・サイズ(バイト) | いいえ |
| dDocCreatedDate | 文字列 | ドキュメントが最初にサーバーにアップロードされた日時(ISO-8601形式) | いいえ |
| dDocCreator | 文字列 | ドキュメントを最初に作成したユーザー | いいえ |
| dDocLastModifiedDate | 文字列 | ドキュメントのリビジョンが最後に変更された日時(ISO-8601形式) | いいえ |
| dDocLastModifier | 文字列 | ドキュメントを最後に変更したユーザー | いいえ |
MetadataVersionsResponse
ドキュメントのすべてのバージョンのメタデータを返すレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dDocName | 文字列 | ドキュメントのID | いいえ |
| count | 数値 | 返されるバージョンの数 | いいえ |
| dRevLabelLatest | 文字列 | このドキュメントの最新リビジョン | いいえ |
| items | 配列 MetadataObjectResponse | 各リビジョンのメタデータ・オブジェクトの配列 | いいえ |
SearchResultsResponse
検索結果を返すレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| count | 数値 | 返されるドキュメントの数。 | いいえ |
| hasMore | ブール | falseの場合、検索のすべての結果が返されます。 | いいえ |
| offset | 数値 | 限られた数の検索結果を返すために使用する場合のオフセット。 | いいえ |
| totalResults | 数値 | 検索を満たすドキュメントの合計数。 | いいえ |
| limit | 数値 | リストされるアイテムの最大数。 | いいえ |
| q | 文字列 | このレスポンスの生成に使用される検索問合せ。 | いいえ |
| orderBy | 文字列 | このレスポンスの生成に使用されるソート・フィールドおよびソート順序。 | いいえ |
| pageNumber | 数値 | レスポンス内のアイテムのページ番号(ページ区切りに有用)。 | いいえ |
| numPages | 数値 | 返されるページの合計数。 | いいえ |
| totalRows | 数値 | 返される合計行数。 | いいえ |
| startRow | 数値 | 返されるitemsの開始行番号。 |
いいえ |
| endRow | 数値 | 返されるitemsの終了行番号。 |
いいえ |
| items | 配列 MetadataObjectResponse | 検索問合せを満たすドキュメントのメタデータ・オブジェクトの配列。 | いいえ |
WorkInProgressResponse
処理中の作業を返すレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| count | 数値 | 返されるドキュメントの数。 | いいえ |
| hasMore | ブール | falseの場合、すべての結果が返されます。 | いいえ |
| offset | 数値 | 限られた数の検索結果を返すために使用する場合のオフセット。 | いいえ |
| totalResults | 数値 | 検索を満たすドキュメントの合計数。 | いいえ |
| limit | 数値 | リストされるアイテムの最大数。 | いいえ |
| orderBy | 文字列 | このレスポンスの生成に使用されるソート・フィールドおよびソート順序。 | いいえ |
| pageNumber | 数値 | レスポンス内のアイテムのページ番号(ページ区切りに有用)。 | いいえ |
| repository | 文字列 | リポジトリの名前 | いいえ |
| computedSearchEngineName | 文字列 | 検索エンジンの名前。 | いいえ |
| items | 配列 MetadataObjectResponse | 処理中のドキュメントのメタデータ・オブジェクトの配列。 | いいえ |
FolderBrowseResponse
フォルダを参照する際のレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| numFolders | 数値 | フォルダ内のフォルダの数。 | いいえ |
| hasMoreChildFolders | 数値 | すべての子フォルダがリクエストによって返されたわけではない場合、これは1です。これは、folderCountに達し、さらに返される可能性のあるフォルダが存在する場合に発生します。 |
いいえ |
| numFiles | 数値 | フォルダ内のファイル数。 | いいえ |
| totalChildFoldersCount | 数値 | 親フォルダ内のフォルダの合計数。 | いいえ |
| totalChildFilesCount | 数値 | 親フォルダ内のファイルの合計数。 | いいえ |
| hasMoreChildFiles | 数値 | すべての子ファイルがリクエストによって返されたわけではない場合、これは1です。これはfileCountに到達したときに発生します。返すことができる追加のドキュメントがあった可能性があります。 |
いいえ |
| hasMoreChildItems | 数値 | すべての子アイテム(フォルダとファイル)がリクエストによって返されたわけではない場合、これは1です。これはカウントに到達したときに発生します。返すことができる追加のアイテムがあった可能性があります。 |
いいえ |
| folderPath | 文字列 | フォルダのパス。 | いいえ |
| folderInfo | FileInfoObject | フォルダに関する情報。 | いいえ |
| childFolders | FileInfoObjectの配列 | フォルダに存在するすべてのフォルダに関する情報の配列。 | いいえ |
| childTargetFolders | FileInfoObjectの配列 | フォルダに存在するすべてのフォルダ・ターゲットに関する情報の配列。 | いいえ |
| childFiles | FileInfoObject | フォルダ内のすべてのファイルに関する情報。 | いいえ |
FolderInfoResponse
フォルダ情報のレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| folderPath | 文字列 | フォルダのパス。 | いいえ |
| targetPath | 文字列 | パスがショートカットの場合、ターゲット・フォルダへのパス。 | いいえ |
| folderInfo | FolderInfoObject | フォルダに関する情報。 | いいえ |
| targetInfo | FolderInfoObject | パスがショートカットの場合、ターゲット・フォルダに関する情報。 | いいえ |
FileInfoResponse
ファイル情報のレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| filePath | 文字列 | ファイルへのパス。 | いいえ |
| fileInfo | FileInfoObject | ファイルに関する情報。 | いいえ |
FolderInfoObject
フォルダ情報。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| fFolderGUID | 文字列 | フォルダGUID。 | いいえ |
| fParentGUID | 文字列 | 親フォルダのGUID | いいえ |
| fFolderName | 文字列 | フォルダ名。 | いいえ |
| fFolderType | 文字列 | フォルダ・タイプ。作成されたフォルダの場合はowner、ショートカットの場合はsoftです。 |
いいえ |
| fInhibitPropagation | 数値 | ファイル/フォルダの親からの値の伝播の制限を決定するために使用されるビットマップ。ビットマップには次のものが含まれます: 0 - 伝播禁止がnoneに設定されている場合、親から値を継承できることを示します 1 - メタデータの伝播の禁止。メタデータが親から継承されないことを示します 16 - フォルダ・セキュリティの伝播の禁止。フォルダ・セキュリティが親から継承されないことを示します 17 - メタデータおよびフォルダ・セキュリティの伝播の禁止 |
いいえ |
| fPromptForMetadata | 数値 | メタデータの入力を求める方法を示します。0の場合、メタデータの入力を要求する必要はありません。 |
いいえ |
| fIsContribution | 数値 | 1の場合、アイテムをフォルダにコントリビュートできます。 |
いいえ |
| fIsInTrash | 数値 | 1の場合、フォルダはごみ箱にあります。 |
いいえ |
| fRealItemGUID | 文字列 | フォルダの実際のGUID。 | いいえ |
| fLibraryType | 数値 | ライブラリ・タイプ。受け入れられる値は次のとおりです: 0 - ライブラリ・フォルダではありません 1 - エンタープライズ・ライブラリ・フォルダ 2 - アプリケーション・ライブラリ・フォルダ 3 - システム・ライブラリ・フォルダ |
いいえ |
| fIsLibrary | 数値 | 1の場合、フォルダはライブラリ・フォルダです。 |
いいえ |
| fDocClasses | 文字列 | フォルダ・クラスのリスト。 | いいえ |
| fTargetGUID | 文字列 | フォルダがショートカットの場合、ターゲットGUID | いいえ |
| fApplication | 文字列 | フォルダ・アプリケーション。 | いいえ |
| fOwner | 文字列 | フォルダの所有者。 | いいえ |
| fCreator | 文字列 | フォルダの作成者。 | いいえ |
| fLastModifier | 文字列 | フォルダの最後の変更者 | いいえ |
| fCreateDate | 文字列 | フォルダが作成された日付(ISO-8601形式)。 | いいえ |
| fLastModifiedDate | 文字列 | フォルダが変更された日付(ISO-8601形式)。 | いいえ |
| fSecurityGroup | 文字列 | フォルダ・セキュリティ・グループ。 | いいえ |
| fDocAccount | 文字列 | フォルダ・アカウント。 | いいえ |
| fClbraUserList | 文字列 | フォルダ・コラボレーション・ユーザー・リスト。 | いいえ |
| fClbraAliasList | 文字列 | フォルダ・コラボレーション別名リスト。 | いいえ |
| fClbraRoleList | 文字列 | フォルダ・コラボレーション・ロール・リスト。 | いいえ |
| fFolderDescription | 文字列 | フォルダの説明。 | いいえ |
| fChildFoldersCount | 数値 | フォルダ内のフォルダの数。 | いいえ |
| fChildFilesCount | 数値 | フォルダ内のファイル数。 | いいえ |
| fFolderSize | 数値 | フォルダが使用するバイト数。 | いいえ |
| fAllocatedFolderSize | 数値 | フォルダに割り当てられているバイト数。制限が設定されていない場合は、-1が使用されます。 |
いいえ |
| fAllocatorParentFolderGUID | 文字列 | 割当ての影響を受ける親フォルダのGUID。 | いいえ |
| fApplicationGUID | 文字列 | フォルダ・アプリケーションGUID | いいえ |
| fIsReadOnly | 数値 | 1の場合、フォルダは読取り専用です。 |
いいえ |
| fIsACLReadOnlyOnUI | 数値 | 1の場合、フォルダは読取り専用として表示されます。 |
いいえ |
| fDisplayName | 文字列 | フォルダの表示名。 | いいえ |
| fDisplayDescription | 文字列 | フォルダ表示の説明。 | いいえ |
| fIsBrokenShortcut | 数値 | 1の場合、ショートカットは破損しています。 |
いいえ |
| isLeaf | 文字列 | 1の場合、フォルダはリーフです。 |
いいえ |
| itemType | 文字列 | フォルダ・タイプ。値1はフォルダ、2はファイル、3はドキュメントです。 |
いいえ |
| folderPermissions | 文字列 | フォルダに対するユーザー権限。なし、またはR(読取り)、W(書込み)、D(削除)またはA(アクセス)の組合せのいずれかです。 |
いいえ |
FileInfoObject
ファイル情報およびファイルに関連付けられたメタデータ。このオブジェクトには、MetadataObjectResponseのフィールドを含めることができます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| fFileGUID | 文字列 | ファイルGUID。 | いいえ |
| fParentGUID | 文字列 | ファイルの親GUID。 | いいえ |
| fTargetGUID | 文字列 | ターゲット・ファイルのGUID。 | いいえ |
| fFileName | 文字列 | ファイルのファイル名。 | いいえ |
| fPublishedFileName | 文字列 | 公開時のファイル名。 | いいえ |
| fFolderType | 文字列 | フォルダ・タイプ。作成されたフォルダの場合はowner、ショートカットの場合はsoftです。 |
いいえ |
| fIsInTrash | 数値 | 1の場合、ファイルはごみ箱にあります。 |
いいえ |
| fRealItemGUID | 文字列 | 実際のファイルGUID。 | いいえ |
| fDocClass | 文字列 | ファイル・クラス。 | いいえ |
| fInhibitPropagation | 数値 | ファイル/フォルダの親からの値の伝播の制限を決定するために使用されるビットマップ。ビットマップには次のものが含まれます: 0 - 伝播禁止がnoneに設定されている場合、親から値を継承できることを示します 1 - メタデータの伝播の禁止。メタデータが親から継承されないことを示します 16 - フォルダ・セキュリティの伝播の禁止。フォルダ・セキュリティが親から継承されないことを示します 17 - メタデータおよびフォルダ・セキュリティの伝播の禁止 |
いいえ |
| fApplication | 文字列 | ファイル・アプリケーション。 | いいえ |
| fOwner | 文字列 | ファイルの所有者 | いいえ |
| fCreator | 文字列 | ファイルの作成者。 | いいえ |
| fLastModifier | 文字列 | ファイルの最後の変更者 | いいえ |
| fCreateDate | 文字列 | ファイルが作成された日付(ISO-8601形式)。 | いいえ |
| fLastModifiedDate | 文字列 | ファイルが変更された日付(ISO-8601形式)。 | いいえ |
| fSecurityGroup | 文字列 | ファイル・セキュリティ・グループ。 | いいえ |
| fDocAccount | 文字列 | ファイル・アカウント。 | いいえ |
| fClbraUserList | 文字列 | ファイル・コラボレーション・ユーザー・リスト。 | いいえ |
| fClbraAliasList | 文字列 | ファイル・コラボレーション別名リスト。 | いいえ |
| fClbraRoleList | 文字列 | ファイル・コラボレーション・ロール・リスト。 | いいえ |
| fIsACLReadOnlyOnUI | 数値 | 1の場合、ファイルは読取り専用として表示されます。 |
いいえ |
| fDisplayName | 文字列 | ファイル表示名。 | いいえ |
| fDisplayDescription | 文字列 | ファイル表示の説明。 | いいえ |
| fIsBrokenShortcut | 数値 | 1の場合、ショートカットは破損しています。 |
いいえ |
| isLeaf | 文字列 | 1の場合、フォルダはリーフです。 |
いいえ |
| itemType | 文字列 | フォルダ・タイプ。値1はフォルダ、2はファイル、3はドキュメントです。 |
いいえ |
| folderPermissions | 文字列 | フォルダに対するユーザー権限。なし、またはR(読取り)、W(書込み)、D(削除)またはA(アクセス)の組合せのいずれかです。 |
いいえ |
WorkflowInfoResponse
ワークフロー内のコンテンツ・アイテムのレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfName | 文字列 | ワークフローの名前。 | いいえ |
| dWfStepID | 数値 | ワークフロー内のステップの一意のID。 | いいえ |
| remainingStepUsers | 文字列 | ワークフロー・ステップを処理する必要があるユーザー名のリスト | いいえ |
| dName | 文字列 | ワークフロー内のドキュメントの作成者。 | いいえ |
| authorAddress | 文字列 | 作成者の電子メール・アドレス。 | いいえ |
| doc_info | MetadataObjectResponse | ドキュメントのメタデータ。 | いいえ |
| workflowInfo | WorkflowObject | ワークフローのメタデータ。 | いいえ |
| wf_doc_info | WorkflowDocumentObject | 追加のワークフロー・メタデータ。 | いいえ |
| workflowStep | WorkflowStepObject | 現在のワークフロー・ステップ。 | いいえ |
| workflowSteps | WorkflowStepObjectの配列 | このドキュメントのすべてのワークフロー・ステップの配列。 | いいえ |
| workflowStepEvents | WorkflowStepEventObject | ワークフロー・イベント | いいえ |
| workflowActionHistory | WorkflowActionObject | ワークフロー・アクションの履歴。 | いいえ |
WorkflowInformationResponse
ワークフロー情報のレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| workflow | WorkflowObject | ワークフローのメタデータ。 | いいえ |
| workflowSteps | WorkflowStepObjectの配列 | このワークフローのすべてのワークフロー・ステップの配列。 | いいえ |
| workflowStepEvents | WorkflowStepEventObject | ワークフロー・イベント。 | いいえ |
| wfDocuments | WorkflowDocumentObjectの配列 | このワークフローに関連付けられているコンテンツ・アイテム。 | いいえ |
WorkflowInformationRevisionsResponse
ワークフロー内のコンテンツ・アイテム・リビジョンのレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| wf_info | WorkflowObject | ワークフロー・メタデータ。 | いいえ |
| workflowSteps | WorkflowStepObjectの配列 | このドキュメントのすべてのワークフロー・ステップの配列。 | いいえ |
| workflowStates | WorkflowStateObjectの配列 | ワークフロー状態の配列。 | いいえ |
| wfDocuments | WorkflowMetaDocumentObjectの配列 | ワークフロー内のコンテンツ・アイテム・メタデータ・オブジェクトの配列 | いいえ |
WorkflowActiveResponse
アクティブなワークフローのレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| count | 数値 | アクティブなワークフローの数 | いいえ |
| items | WorkflowObjectの配列 | アクティブなワークフローの配列。 | いいえ |
WorkflowObject
次のフィールドは、ワークフローについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dWfName | 文字列 | ワークフローのユーザー割当て名。 | いいえ |
| dWfDescription | 文字列 | ワークフローの説明。 | いいえ |
| dCompletionDate | 文字列 | ワークフローが最後に完了し、すべてのドキュメントがWebにリリースされた日付(ISO-8601形式)。 | いいえ |
| dSecurityGroup | 文字列 | ワークフローが属するセキュリティ・グループ(dSecurityGroup)。 | いいえ |
| dWfStatus | 文字列 | ワークフローの状態: INIT = 未開始または非アクティブ INPROCESS = アクティブ |
いいえ |
| dWfType | 文字列 | ワークフローのタイプ: Basic Criteria Sub-workflow |
いいえ |
| dProjectID | 文字列 | 設定した場合、このワークフローはステージング・ワークフローです。 | いいえ |
| dIsCollaboration | 数値 | 1の場合、ワークフローはコラボレーション・プロジェクトに関連しています。 |
いいえ |
WorkflowStepObject
次のフィールドは、ワークフローのステップについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfStepID | 数値 | ワークフロー内のステップを一意に識別するために使用される増分カウンタ。 | いいえ |
| dWfStepName | 文字列 | ユーザーによって割り当てられたワークフロー・ステップの名前。 | いいえ |
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dWfStepDescription | 文字列 | ワークフロー・ステップの説明。 | いいえ |
| dWfStepType | 文字列 | ワークフロー・ステップ・タイプ(AutoContribution、Contribution、Reviewer/Contribution、Reviewer)。 | いいえ |
| dWfStepIsAll | 数値 | すべてのユーザーが承認する必要があるかどうか(1または0)。 | いいえ |
| dWfStepHasWeight | 数値 | 制限されたレビューア・オプションを有効にします。 | いいえ |
| dWfStepWeight | 数値 | dWfStepIsAllがfalse(0)の場合に承認するユーザー数。 | いいえ |
| dWfStepIsSignature | 数値 | 現在のワークフロー・ステップに署名が必要かどうかを決定します。署名が必要な場合は"1"("ElectronicSignatures"を有効にする必要があります)、それ以外の場合は"0"です。 | いいえ |
| dAliases | 文字列 | 別名ユーザーのリスト。 | いいえ |
WorkflowStepEventObject
次のフィールドは、ワークフローのステップについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfStepName | 文字列 | ユーザーによって割り当てられたワークフロー・ステップの名前。 | いいえ |
| wfEntryScript | 文字列 | ステップ・エントリのスクリプト。 | いいえ |
| wfExitScript | 文字列 | ステップ終了スクリプト。<$および$>デリミタ内に配置される必要があります。 | いいえ |
| wfUpdateScript | 文字列 | ステップ更新スクリプト。<$および$>デリミタ内に配置される必要があります。 | いいえ |
WorkflowDocumentObject
次のフィールドは、ワークフロー内のドキュメントについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dDocName | 文字列 | ワークフローのコンテンツ・アイテム部分のdDocName。 | いいえ |
| dWfDocState | 文字列 | ワークフローの現在の状態: INIT = 未開始または非アクティブ INPROCESS = アクティブ |
いいえ |
| dWfComputed | 文字列 | 導出ワークフロー情報。 | いいえ |
| dWfCurrentStepID | 数値 | ワークフローが存在するステップの一意の識別子。 | いいえ |
| dWfDirectory | 文字列 | ワークフロー・ドキュメントのコンパニオン・ファイルの場所。 | いいえ |
| dClbraName | 文字列 | コラボレーション・プロジェクト名。 | いいえ |
WorkflowMetaDocumentObject
次のフィールドは、ワークフロー内のドキュメントについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dDocName | 文字列 | ワークフローのコンテンツ・アイテム部分のdDocName。 | いいえ |
| dWfDocState | 文字列 | ドキュメントの現在のワークフロー状態(INIT = ワークフローはアクティブではない、INPROCESS = ワークフローはアクティブ) | いいえ |
| dWfComputed | 文字列 | 導出ワークフロー情報。 | いいえ |
| dWfCurrentStepID | 数値 | ワークフローが存在するステップの一意の識別子。 | いいえ |
| dWfDirectory | 文字列 | ワークフロー・ドキュメントのコンパニオン・ファイルの場所。 | いいえ |
| dClbraName | 文字列 | コラボレーション・プロジェクト名。 | いいえ |
| dDocType | 文字列 | ドキュメントのタイプ | いいえ |
| dDocTitle | 文字列 | ドキュメントのタイトル | いいえ |
| dRevLabel | 文字列 | ドキュメントのリビジョン | いいえ |
| dSecurityGroup | 文字列 | ドキュメントのセキュリティ・グループ | いいえ |
| dDocName | 文字列 | ドキュメントのID | いいえ |
| dDocAuthor | 文字列 | ドキュメントの作成者 | いいえ |
| dStatus | 文字列 | このフィールドは、他のステータス・フィールドからの計算のサマリー・フィールドです。 | いいえ |
| dOriginalName | 文字列 | ドキュメント・ファイル名 | いいえ |
| dFormat | 文字列 | ドキュメントのMIMEタイプ | いいえ |
| dFileSize | 数値 | ドキュメント・ファイル・サイズ(バイト) | いいえ |
| dDocCreatedDate | 文字列 | ドキュメントが最初にサーバーにアップロードされた日時(ISO-8601形式) | いいえ |
| dDocCreator | 文字列 | ドキュメントを最初に作成したユーザー | いいえ |
| dDocLastModifiedDate | 文字列 | ドキュメントのリビジョンが最後に変更された日時(ISO-8601形式) | いいえ |
| dDocLastModifier | 文字列 | ドキュメントを最後に変更したユーザー | いいえ |
WorkflowStateObject
次のフィールドは、ドキュメントのワークフロー状態を示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dID | 数値 | ドキュメントのリビジョン識別子。 | いいえ |
| dDocName | 文字列 | ワークフローのドキュメント部分のdDocName。 | いいえ |
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dUserName | 文字列 | ドキュメントを承認したユーザー。 | いいえ |
| dWfEntryTs | 数値 | ワークフロー内の特定のステップへユーザーが入ったときのタイムスタンプ(ISO-8601形式)。 | いいえ |
WorkflowActionObject
次のフィールドは、data\workflow\statesディレクトリ内の対応するHDAファイルのコンテンツに対するワークフロー・アクションを示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dWfName | 文字列 | ワークフロー名。 | いいえ |
| dWfStepName | 文字列 | ワークフロー・ステップ名。 | いいえ |
| wfAction | 文字列 | ステップで実行されたアクション。 | いいえ |
| wfActionTs | 文字列 | アクション時間(ISO-8601形式)。 | いいえ |
| wfUsers | 文字列 | ワークフロー・ステップ・ユーザー。 | いいえ |
| wfMessage | 文字列 | ステップのワークフロー・メッセージ。 | いいえ |
WorkflowInQueueResponse
キュー内のワークフローのレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| count | 数値 | 返されるアイテムの数。 | いいえ |
| hasMore | ブール | falseの場合、すべてのアイテムが返されます。 |
いいえ |
| numPages | 数値 | キュー・アイテムが返されるページ数。 | いいえ |
| pageNumber | 数値 | 返される検索結果のページ番号。 | いいえ |
| totalRows | 数値 | ユーザーのキューにあるワークフロー・アイテムの合計数。 | いいえ |
| startRow | 数値 | ワークフロー・キューの開始行。 | いいえ |
| endRow | 数値 | ワークフロー・キューの最後の行。 | いいえ |
| items | 配列 | 各エントリは、WorkflowInQueueObject、WorkflowStepObjectおよびMetadataObjectResponseのフィールドの複合です | いいえ |
WorkflowInQueueObject
次のフィールドは、ワークフロー・キューについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dUser | 文字列 | ワークフローでドキュメントが割り当てられたユーザー。 | いいえ |
| dDocName | 文字列 | ワークフロー内のドキュメントのdDocName。 | いいえ |
| dID | 数値 | ワークフロー内のドキュメントのリビジョン識別子。 | いいえ |
| dWfID | 数値 | ワークフローの一意のカウンタID。 | いいえ |
| dWfName | 文字列 | ワークフローのユーザー割当て名。 | いいえ |
| dWfStepName | 文字列 | ユーザーによって割り当てられたワークフロー・ステップの名前。 | いいえ |
| dwfQueueActionState | 文字列} ワークフロー・アクションの状態。 | いいえ | |
| dwfQueueEnterTs | 文字列 | ワークフローの開始時間(ISO-8601形式)。 | いいえ |
| dwfQueueLastActionTs | 文字列 | ドキュメントに対して最後に実行されたワークフロー・アクションのタイムスタンプ(ISO-8601形式)。 | いいえ |
| wfMessage | 文字列 | ステップのワークフロー・メッセージ。 | いいえ |
| fIsFavorite | 数値 | アイテムがお気に入りのアイテムかどうかを示します。Frameworkfoldersが有効な場合にのみ適用可能です。 | いいえ |
UserPermissionResponse
レスポンスは、ユーザー権限情報に使用されます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dName | 文字列 | ユーザーの名前。 | いいえ |
| documentAccounts | UserAccountObjectの配列 | アカウントと権限の配列。 | いいえ |
| securityGroups | UserGroupObjectの配列 | セキュリティ・グループおよび権限の配列。 | いいえ |
| userSecurityFlags | UserSecurityFlagObjectの配列 | セキュリティ・フラグの配列。 | いいえ |
UserAccountObject
次のフィールドは、アカウントとアカウントの権限について示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dDocAccount | 文字列 | ユーザーがアクセスできるアカウント。 | いいえ |
| privilege | 文字列 | アカウントに対応する権限レベル。 | いいえ |
UserGroupObject
次のフィールドは、セキュリティ・グループとその権限を示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dGroupName | 文字列 | ユーザーがアクセスできるセキュリティ・グループ。 | いいえ |
| privilege | 文字列 | セキュリティ・グループに対応する権限レベル。 | いいえ |
UserSecurityFlagObject
次のフィールドは、セキュリティ・グループと値について示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| flag | 文字列 | セキュリティ・グループに関連するフラグ。 | いいえ |
| value | 文字列 | このフラグに設定された値。 | いいえ |
CustomFieldsResponse
レスポンスは、表示フィールドの情報に使用されます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| displayFieldInfo | DisplayFieldInfoObjectの配列 | カスタム・メタデータ・フィールド情報の配列。 | いいえ |
| displayGroupInfo | DisplayFieldGroupObjectの配列 | メタデータ・フィールドをグループ化する方法を示す配列。 | いいえ |
| xFieldName.options | DisplayFieldDropDownObjectの配列 | オプションを使用して特定のフィールドのドロップダウン・リストを作成する方法を示す配列。xFieldNameは名前カスタム・メタデータ・フィールドであり、レスポンスには複数の配列が含まれる場合があります。 |
いいえ |
DisplayFieldInfoObject
次のフィールドは、カスタム・メタデータ・フィールドについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| fieldName | 文字列 | フィールドの名前。 | いいえ |
| fieldType | 文字列 | フィールドのタイプ | いいえ |
| fieldLabel | 文字列 | フィールドの表示ラベル。 | いいえ |
| fieldLength | 文字列 | 許可されるフィールドの長さ。 | いいえ |
| isHidden | 文字列 | 1の場合、フィールドは非表示のフォーム・フィールドです。 |
いいえ |
| isReadOnly | 文字列 | 1の場合、フィールドは非入力フォーム・フィールドです。 |
いいえ |
| isRequired | 文字列 | 1の場合、フィールドは必須フォーム・フィールドです。 |
いいえ |
| requiredMsg | 文字列 | 必須フィールドに入力されていない場合に表示されるメッセージ。 | いいえ |
| defaultValue | 文字列 | フィールドのデフォルト値。 | いいえ |
| displayValue | 文字列 | defaultValueに使用される表示値。 |
いいえ |
| isOptionList | 文字列 | 1の場合、フィールドはドロップダウン・オプション・リストです。 |
いいえ |
| optionList | 文字列 | isOptionListが1に設定されている場合、ドロップダウン・リストの作成に使用されるオプションを含む追加表の名前。 |
いいえ |
| isTreeOptionList | 文字列 | 1の場合、オプション・リストではツリーが使用されます。 |
いいえ |
| optionListType | 文字列 | オプション・リストのタイプ。 | いいえ |
| isDependent | 文字列 | 1の場合、フィールドはDCLの一部です。このフィールドの値は、他のフィールドに依存します。 |
いいえ |
| dependentOnField | 文字列 | 1の場合、このフィールドの値を取得するフィールドの名前。 |
いいえ |
| isPadMultiselectStorage | 文字列 | multi*タイプのオプション・リストによって使用されます。 | いいえ |
| multiselectDisplaySeparator | 文字列 | multi*タイプのオプション・リストによって使用されます。 | いいえ |
| multiselectStorageSeparator | 文字列 | multi*タイプのオプション・リストによって使用されます。 | いいえ |
| isShowSelectionPath | 文字列 | 1の場合、フルパスが表示されます。このフルパスは情報ページに表示されます。 |
いいえ |
| isStoreSelectionPath | 文字列 1の場合、データベースにフルパスを格納します。 |
いいえ | |
| treeNodeDisplaySeparator | 文字列 | セパレータを表示するために使用する必要がある文字。 | いいえ |
| treeNodeStorageSeparator | 文字列 | パスをデータベースに保存するときにセパレータとして使用する必要がある文字。 | いいえ |
| order | 文字列 | フィールドの順序。 | いいえ |
| decimalScale | 文字列 | フィールドで小数値が許可されている場合、decimalScale。 | いいえ |
| isError | 文字列 | 1の場合、フィールドに関する情報の取得中にエラーが発生しました。 |
いいえ |
| errorMsg | 文字列 | フィールドのエラー・メッセージ。 | いいえ |
DisplayFieldGroupObject
次のフィールドは、カスタム・メタデータ・フィールドのグループ化について示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| parentField | 文字列 | グループで最初に表示される必要があるフィールドの名前。 | いいえ |
| groupFieldList | 文字列 | 親フィールドと一緒に表示される必要があるフィールドのリスト。 | いいえ |
| groupHeader | 文字列 | グループ名。 | いいえ |
| defaultHide | 文字列 | 1の場合、グループはデフォルトで縮小されます。 |
いいえ |
DisplayFieldDropDownObject
次のフィールドは、カスタム・メタデータがドロップダウン・リストの作成に使用するオプションについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| dOption | 文字列 | オプションの内部値。 | いいえ |
| dDescription | 文字列 | オプションの表示値。 | いいえ |
DataSourceResponse
次のフィールドは、データ・ソースの問合せについて示しています。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| copyAborted | 数値 | trueの場合、リクエストで問合せからすべての行が返されるとはかぎりません。 | いいえ |
| nextRow | 数値 | 問合せ内の次の行の番号。 | いいえ |
| count | 数値 | 返される行数。 | いいえ |
| items | 配列 | 問合せ結果。フィールドは、使用されるデータ・ソースによって異なります。 | いいえ |
FoldersSearchResultsResponse
フォルダ内のアイテムの検索結果を返すレスポンス。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| count | 数値 | 返されるドキュメントの数。 | いいえ |
| hasMore | ブール | falseの場合、検索のすべての結果が返されました。 | いいえ |
| offset | 数値 | 限られた数の検索結果を返すために使用する場合のオフセット。 | いいえ |
| totalResults | 数値 | 検索を満たすドキュメントの合計数。 | いいえ |
| limit | 数値 | リストされるアイテムの最大数。 | いいえ |
| q | 文字列 | このレスポンスの生成に使用される検索問合せ。 | いいえ |
| orderBy | 文字列 | このレスポンスの生成に使用されるソート・フィールドおよびソート順序。 | いいえ |
| startRow | 数値 | 返されるitemsの開始行番号。 |
いいえ |
| endRow | 数値 | 返されるitemsの終了行番号。 |
いいえ |
| nextRow | 数値 | 問合せ内の次の行の番号。 | いいえ |
| itemType | 文字列 | アイテム・タイプ。値1はフォルダ、2はファイル、3はドキュメントです。 |
いいえ |
| dataSource | 文字列 | 検索結果の生成に使用されるdataSource。 | いいえ |
| searchEngineName | 文字列 | 使用される検索エンジンの名前。 | いいえ |
| items | FolderInfoObjectまたはFileInfoObjectの配列 | 検索問合せを満たすドキュメントのメタデータ・オブジェクトの配列。 | いいえ |
Oracle WebCenter Content REST API
G19931-01
最終更新:2024年10月
Copyright © 2024, Oracle and/or its affiliates.
原本著者: Oracle Corporation