機械翻訳について

移動先

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

すべてのコネクタのリスト

get

/content/management/api/v1.1/connectors

すべてのコネクタを一覧表示します。

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 現在で使用できるfieldNamesはnameとconnectorTypeのみで、現在使用できる演算子は、connectorTypeのnameとeqではmtのみです。 この問合せパラメータは、デフォルトではオプションです。
  例:
  ?q=(name mt "foo")
  例:
  ?q=(connectorType eq "translation")
  例:
  ?q=(connectorType eq "content")
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : コネクタ

型: object

コネクタ

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Connector"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Connectors"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object Connector
  コネクタ

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Connector"
    }
}

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

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : コネクタ

型: object

コネクタ

ソースを表示

• connectorId(optional): string
  コネクタのId。 これはレスポンス取得の必須プロパティです。
• connectorName(optional): string
  コネクタの名前 これはレスポンス取得の必須プロパティです。
• connectorType(optional): string
  コネクタのタイプ。 これはレスポンス取得の必須プロパティです。
• isDigitalContentConnector(optional): boolean
  読取り専用: true

  デジタル・アセット・コネクタの場合はTrue、それ以外の場合はfalse
• supportedContentTypes(optional): array supportedContentTypes
  コネクタのサポートされているコンテンツ・タイプ。

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"Id of the connector. It is a required property in the get response."
        },
        "connectorName":{
            "type":"string",
            "description":"Name of the connector. It is a required property in the get response."
        },
        "connectorType":{
            "type":"string",
            "description":"Type of the connector. It is a required property in the get response."
        },
        "isDigitalContentConnector":{
            "type":"boolean",
            "description":"True for Digital asset connectors, otherwise false",
            "readOnly":true
        },
        "supportedContentTypes":{
            "type":"array",
            "description":"Supported content types of the connector.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Connector"
}

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

型: array

コネクタのサポートされているコンテンツ・タイプ。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Supported content types of the connector.",
    "items":{
        "type":"string"
    }
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのコネクタをリストする方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/connectors'

例:

システムで構成されているすべてのコネクタがリストされます。

/content/management/api/v1.1/connectors

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "connectorId": "10000",
            "connectorName": "Google Drive",
            "connectorType": "content",
            "supportedContentTypes": []
          },
          {
            "connectorId": "10002",
            "connectorName": "Dropbox",
            "connectorType": "content",
            "supportedContentTypes": []
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/connectors",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/connectors",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/connectors",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/connectors?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/connectors?offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }

先頭に戻る