機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

使用可能なMetadataコレクションの取得

get

/documents/api/1.2/metadata

現在のユーザーが使用可能な、すべてのメタデータ・コレクションを取得します。 結果リストには、そのテナントのすべてのグローバル・メタデータ・コレクションと、現在のユーザーが作成したすべての個人メタデータ・コレクションが含まれます。 デフォルトでは、メタデータ・コレクション定義のみが取得されますが、必要に応じて、それぞれのフィールド定義もすべて取得できます。

リクエスト

サポートされるメディア・タイプ

• application/json
• application/xml

本文 ()

リクエスト本文では、現在のユーザーが使用可能なメタデータ・コレクションの取得について詳細を定義します。 これは必須ではなく、デフォルトでメタデータ・コレクションのみを取得します。 フィールドも同様に検索する必要がある場合は、retrieveFieldsを使用できます。

ルート・スキーマ: AvailableCollectionsRequestBody

タイプ: object

リクエスト本文では、使用可能なすべてのコレクションの取得のリクエストについて詳細を定義します。

ソースを表示

• retrieveFields(optional): number
  コレクションのみを取得( 0)するか、コレクションおよびそれぞれのフィールド定義を取得します( 1)。

{
    "description":"The request body defines details of the get all available collections request.",
    "properties":{
        "retrieveFields":{
            "type":"number",
            "description":"Retrieve only collections (<code>0</code>) or retrieve collections and respective field definitions (<code>1</code>)."
        }
    }
}

リクエストの例(application/json)

{
    "retrieveFields":"1"
}

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ: AllAvailableCollectionsResponse

タイプ: object

レスポンス本文には、現在のユーザーが使用可能なすべてのコレクションについての情報が含まれます。

ソースを表示

• errorCode(optional): number
  エラー・コードがゼロ(0)の場合は、エラーなしです
• metadataCollections(optional): array metadataCollections

{
    "description":"The response body includes information about all available collections for the current user.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "metadataCollections":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionDefinition"
            }
        }
    }
}

ネストされたスキーマ: metadataCollections

タイプ: array

ソースを表示

• Array of: object CollectionDefinition
  メタデータ・コレクション定義。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CollectionDefinition"
    }
}

ネストされたスキーマ: CollectionDefinition

タイプ: object

メタデータ・コレクション定義。

ソースを表示

• isEnabled(optional): string
  コレクションの有効化(1)または無効化(0)のステータス。
• isInherited(optional): string
  コレクション継承(1)または直接割り当て(0)のステータス。
• items(optional): array items
  フィールド定義のリスト。
• type(optional): string
  アイテム・タイプcollection。

{
    "description":"Metadata collection definition.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Item type <code>collection</code>."
        },
        "isEnabled":{
            "type":"string",
            "description":"Collection enable (<code>1</code>) or disable (<code>0</code>) status."
        },
        "isInherited":{
            "type":"string",
            "description":"Collection inherited (<code>1</code>) or directly assigned (<code>0</code>) status."
        },
        "items":{
            "type":"array",
            "description":"List of field definitions.",
            "items":{
                "$ref":"#/definitions/CollectionFieldDefinition"
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: array

フィールド定義のリスト。

ソースを表示

• Array of: object CollectionFieldDefinition
  メタデータ・フィールド定義。

{
    "type":"array",
    "description":"List of field definitions.",
    "items":{
        "$ref":"#/definitions/CollectionFieldDefinition"
    }
}

ネストされたスキーマ: CollectionFieldDefinition

タイプ: object

メタデータ・フィールド定義。

ソースを表示

• fieldDescription(optional): string
  フィールドの説明。
• fieldName(optional): string
  フィールド名。
• fieldType(optional): string
  フィールド・タイプ。
• isEnabled(optional): string
  フィールドの有効(1)または無効(0)ステータス。
• type(optional): string
  アイテム・タイプfield。

{
    "description":"Metadata fields definition.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Item type <code>field</code>."
        },
        "fieldName":{
            "type":"string",
            "description":"Field name."
        },
        "fieldDescription":{
            "type":"string",
            "description":"Field description."
        },
        "fieldType":{
            "type":"string",
            "description":"Field type."
        },
        "isEnabled":{
            "type":"string",
            "description":"Field enable (1) or disable (0) status."
        }
    }
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

トップに戻る

例

次の例では、現在のユーザーが使用可能なすべてのメタデータ・コレクションが返されます。 デフォルトでは、コレクション情報のみが取得されます。 管理ユーザーによって作成されたすべてのグローバル・コレクション、および現在のユーザーによって作成されたすべての個人コレクションが取得されます。 この例のURLリクエストは、問合せパラメータ"retrieveFields=0"を渡すことと同じ効果があります。

GET .../metadata

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "metadataCollections": {
        "GlobalCollectionA": {
            "isEnabled": "1",
            "type": "collection"
        },
        "GlobalCollectionB": {
            "isEnabled": "0",
            "type": "collection"
        },
        "Personal.MyUserAMetadata": {
            "isEnabled": "1",
            "type": "collection"
        }
    }
}

例2

次の例では、現在のユーザーが使用可能なすべてのメタデータ・コレクションが返されます。 管理ユーザーによって作成されたすべてのグローバル・コレクション、および現在のユーザーによって作成されたすべての個人コレクションを含め、すべてのコレクションおよびそれらのそれぞれのフィールドが取得されます。

GET .../metadata?retrieveFields=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "metadataCollections": {
        "GlobalCollectionA": {
            "isEnabled": "1",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "globalFieldA1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "globalFieldA2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        },
        "GlobalCollectionB": {
            "isEnabled": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "globalFieldB1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "globalFieldB2",
                    "fieldType": "string",
                    "isEnabled": "1"
                }
            ]
        },
        "Personal.MyUserAMetadata": {
            "isEnabled": "1",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "myField1",
                    "fieldType": "string",
                    "isEnabled": "0"
                },
                {
                    "type": "field",
                    "fieldName": "myField2",
                    "fieldType": "string",
                    "isEnabled": "1"
                }
            ]
        }
    }
}

例3

次の例では、現在のユーザーが使用可能な、すべてのメタデータ・コレクションをリクエストします。 オプションのパラメータですが、"retrieveFields"問合せパラメータでは、値0 (コレクションのみ)および1 (コレクションおよびフィールド)のみがサポートされます。 他の値が指定された場合は、エラーが返されます。

GET .../metadata?retrieveFields=abc

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csInvalidFieldValue,abc",
    "errorMessage": "'abc' is not a valid field value.",
    "title": "'abc' is not a valid field value.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る