ドキュメント用REST API

機械翻訳について

メタデータ・コレクション定義の取得

get

/documents/api/1.2/metadata/{collectionName}

メタデータ・フィールド情報とともにメタデータ・コレクション定義情報を取得します。

Enable ( 1)またはdisable ( 0)ステータスは、メタデータ・コレクションおよびそのすべてのフィールドに対して個別に表示されます。

リクエスト

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

application/json
application/xml

パス・パラメータ

collectionName: string

コレクション名。ユーザー個人コレクションの場合は、Personal.MyCollectionなどのPersonal.で始まる必要があります。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: CollectionGetResponse

タイプ: object

レスポンス本文には、メタデータ・コレクション定義に関する情報が含まれます。

ソースを表示

errorCode(optional): number

エラー・コードがゼロ(0)の場合は、エラーなしです
isEnabled(optional): string

Metadataコレクションの有効化( 1)または無効化( 0)ステータス。
items(optional): array items

フィールド定義のリスト。
type(optional): string

アイテム・タイプcollection。

{
    "description":"The response body includes information about a metadata collection definition.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "isEnabled":{
            "type":"string",
            "description":"Metadata collection enable (<code>1</code>) or disable (<code>0</code>) status."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>collection</code>."
        },
        "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レスポンス

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

その名前のコレクションは存在しません。

トップに戻る

例

次の例では、CollectionBメタデータ・コレクションの定義を取得します。

GET .../metadata/CollectionB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "isEnabled": "1",
    "type": "collection",
    "items": [
        {
            "type": "field",
            "fieldName": "B1",
            "fieldType": "string",
            "isEnabled": "0"
        },
        {
            "type": "field",
            "fieldName": "B2",
            "fieldType": "string",
            "isEnabled": "1"
        }
    ]
}

例2

次の例では、Personal.CollectionAメタデータ・コレクションの定義を取得します。

GET .../metadata/Personal.CollectionA

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "isEnabled": "1",
    "type": "collection",
    "items": [
        {
            "type": "field",
            "fieldName": "FieldA",
            "fieldDescription": "Field A",
            "fieldType": "text",
            "isEnabled": "1"
        },
        {
            "type": "field",
            "fieldName": "FieldB",
            "fieldDescription": "Field B",
            "fieldType": "number",
            "isEnabled": "1"
        },
        {
            "type": "field",
            "fieldName": "FieldC",
            "fieldDescription": "Field C",
            "fieldType": "date",
            "isEnabled": "1"
        },
        {
            "type": "field",
            "fieldName": "FieldD",
            "fieldDescription": "Field D",
            "fieldType": "boolean",
            "isEnabled": "1"
        }
    ]
}

例3

次の例では、存在しないコレクションの定義を取得しようとします。

GET .../metadata/Personal.CollectionAB

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToGetMetaColDef!csMetaCollectionDoesntExist,Personal.CollectionAB",
    "errorMessage": "Unable to get metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "title": "Unable to get metadata collection definition. Metadata Collection 'Personal.CollectionAB' is not defined.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、コレクション名に含まれる無効な文字を使用して、定義を取得しようとします。

GET .../metadata/Personal.CollectionA,B

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csCollectionNameInvalidCharacters,Personal.CollectionA\\,B",
    "errorMessage": "Invalid characters in the collection name 'Personal.CollectionA,B'.",
    "title": "Invalid characters in the collection name 'Personal.CollectionA,B'.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る