機械翻訳について

移動先

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

リポジトリによって参照される編集ロールのリスト

get

/content/management/api/v1.1/editorialRoles/{roleId}/referencedByRepositories

カスタム編集ロールによって参照されるリポジトリをリストします。

リクエスト

パス・パラメータ

• roleId: string
  カスタム編集ロールのID。

問合せパラメータ

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

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

  デフォルト値: 0
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : EditorialRoleReferencedByRepositories

型: object

EditorialRoleReferencedByRepositories

ソースを表示

• 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/RepositoryInEditorialRole"
            }
        },
        "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":"EditorialRoleReferencedByRepositories"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object RepositoryInEditorialRole
  編集ロール・レスポンスのリポジトリ

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

ネストされたスキーマ: 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
        }
    }
}

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

型: object

編集ロール・レスポンスのリポジトリ

ソースを表示

• id(optional): string
  カスタム編集ロールによって参照されるリポジトリのID。
• isUsed(optional): boolean
  カスタム編集ロールがリポジトリで使用されているかどうか。
• links(optional): array links
  リポジトリ・リソースのリンク。
• name(optional): string
  カスタム編集ロールによって参照されるリポジトリの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of a repository referenced by a custom editorial role."
        },
        "name":{
            "type":"string",
            "description":"Name of a repository referenced by a custom editorial role."
        },
        "isUsed":{
            "type":"boolean",
            "description":"Whether a custom editorial role is being used by a repository."
        },
        "links":{
            "type":"array",
            "description":"Links of a repository resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Repository in Editorial Role Response"
}

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

型: array

リポジトリ・リソースのリンク。

ソースを表示

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

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

ネストされたスキーマ: 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を使用してGETリクエストを発行して、カスタム編集ロールによって参照されるリポジトリをリストする方法を示しています。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/editorialRoles/{roleId}/referencedByRepositories'

例

/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?offset=0&limit=10&totalResults=true

これは、ID 76F2903A0C8E48BCA222E68264BE1E05のカスタム編集ロールによって参照される最初の10個のリポジトリを、リポジトリ名の昇順でソートしてリストします。 ここで「参照元」は、編集ロールがそのリポジトリに割り当てられていることを意味します。

レスポンス本文

{
	    "hasMore": false,
	    "offset": 0,
	    "count": 2,
	    "limit": 2,
	    "totalResults": 2,
	    "items": [
	        {
	            "id": "48040240881C40749E10F57A060D8AB4",
	            "name": "Repo1",
	            "isUsed": false,
	            "links": [
	                {
	                    "href": "http://<hostname>/content/management/api/v1.1/repositories/48040240881C40749E10F57A060D8AB4",
	                    "rel": "self",
	                    "method": "GET",
	                    "mediaType": "application/json"
	                }
	            ]
	        },
	        {
	            "id": "7F289D0F4FD44C0382A83EFD44A355C0",
	            "name": "Repo2",
	            "isUsed": true,
	            "links": [
	                {
	                    "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0",
	                    "rel": "self",
	                    "method": "GET",
	                    "mediaType": "application/json"
	                }
	            ]
	        }
	    ],
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "canonical",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories",
	            "rel": "describedby",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "first",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "last",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }

先頭に戻る