機械翻訳について

移動先

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

コレクションの更新

put

/content/management/api/v1.1/repositories/{id}/collections/{collectionId}

指定されたペイロードでコレクションを更新します。

リクエスト

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

• application/json

パス・パラメータ

• collectionId: string
  コレクションのId。
• id: string
  コレクションのリポジトリIdパラメータ。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内の指定の情報でコレクションを更新します。 ペイロード内に指定されている場合でも、createdBy, createdDate, updatedBy, updatedDateおよびlinksフィールドは無視されます。

ルート・スキーマ: Collection

型: object

コレクション

ソースを表示

• channels(optional): array channels
  コレクションに関連付けられているチャネル。
• createdBy(optional): string
  コレクションのcreatedByユーザー。
• createdDate(optional): object date
  date
• description(optional): string
  コレクションの説明。
• id(optional): string
  コレクションのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isDynamic(optional): boolean
  true
• links(optional): array links
  リンク
• name(optional): string
  コレクションの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• repository(optional): object RepositoryIdentifier
  RepositoryIdentifier
• roleName(optional): string
  コレクションのユーザー・ロールの名前。
• ruleGroups(optional): array ruleGroups
• updatedBy(optional): string
  コレクションのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "repository":{
            "description":"Information of the collection repository.",
            "$ref":"#/definitions/RepositoryIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the collection. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the collection."
        },
        "isDynamic":{
            "type":"boolean",
            "description":"true"
        },
        "ruleGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleGroup"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Collection."
        },
        "createdDate":{
            "description":"date and time Collection createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Collection."
        },
        "updatedDate":{
            "description":"date and time Collection updatedAt.",
            "$ref":"#/definitions/date"
        },
        "channels":{
            "type":"array",
            "description":"Channels associated with the collection.",
            "items":{
                "$ref":"#/definitions/ChannelInCollections"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the collection."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Collection"
}

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

型: array

コレクションに関連付けられているチャネル。

ソースを表示

• Array of: object ChannelInCollections
  ChannelInCollections

{
    "type":"array",
    "description":"Channels associated with the collection.",
    "items":{
        "$ref":"#/definitions/ChannelInCollections"
    }
}

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

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

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

型: array

リンク

ソースを表示

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

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

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

型: object

RepositoryIdentifier

ソースを表示

• id(optional): string
  コレクション・リポジトリのId。 これはレスポンス取得の必須プロパティです。
• name(optional): string
  コレクション・リポジトリの名前。 これはレスポンス取得の必須プロパティです。
• role (オプション): string
  コレクション・リポジトリのロール。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection repository. It is a required property in the get response."
        },
        "name":{
            "type":"string",
            "description":"Name of the collection repository. It is a required property in the get response."
        },
        "role":{
            "type":"string",
            "description":"Role on the collection repository."
        }
    },
    "description":"RepositoryIdentifier"
}

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

型: array

ソースを表示

• Array of: object RuleGroup
  ルール・グループ定義

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

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

型: object

ChannelInCollections

ソースを表示

• id(optional): string
  チャネルのId。
• name(optional): string
  チャネルの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInCollections"
}

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

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

型: object

ルール・グループ定義

ソースを表示

• assetType(optional): string
  ルール・グループに関連付けられたアセット・タイプ。ルール・グループ内のすべてのルールは、このアセット・タイプに関連するプロパティに基づきます

  例: File
• conjunction(optional): string
  このルール・グループを前のグループと結合するときに使用する演算子

  例: OR
• ruleSet(optional): array ruleSet
  ルール・グループに関連付けられたルールのセット

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"OR",
            "description":"the operator to be used while joining this rule group with a previous group"
        },
        "assetType":{
            "type":"string",
            "example":"File",
            "description":"asset type associated with the rule group, all rules within the rule group are based on properties related to this asset type"
        },
        "ruleSet":{
            "type":"array",
            "description":"set of rules associated with the rule group",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"rule group definition"
}

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

型: array

ルール・グループに関連付けられたルールのセット

ソースを表示

• Array of: object RuleSet
  ルールまたは条件のセット

{
    "type":"array",
    "description":"set of rules associated with the rule group",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

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

型: object

ルールまたは条件のセット

ソースを表示

• conjunction(optional): string
  このルール・セットと既存のルール・セットを結合するときに使用する演算子

  例: and
• rule(optional): object Rule
• ruleSet(optional): array ruleSet
  指定されたルール・セットに関連付けられた子またはサブ・ルール・セット

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"and",
            "description":"The operator to be used when combining this rule set with an existing rule set"
        },
        "rule":{
            "description":"The rule definition within the rule set",
            "$ref":"#/definitions/Rule"
        },
        "ruleSet":{
            "type":"array",
            "description":"The child or sub rule set associated with the given rule set",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"Set of rules or conditions"
}

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

型: object

ソースを表示

• fieldId(optional): string
• fieldName(optional): string
• fieldValue(optional): string
• operator(optional): string

{
    "type":"object",
    "properties":{
        "fieldId":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        }
    }
}

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

型: array

指定されたルール・セットに関連付けられた子またはサブ・ルール・セット

ソースを表示

• Array of: object RuleSet
  ルールまたは条件のセット

{
    "type":"array",
    "description":"The child or sub rule set associated with the given rule set",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ: Collection

型: object

コレクション

ソースを表示

• channels(optional): array channels
  コレクションに関連付けられているチャネル。
• createdBy(optional): string
  コレクションのcreatedByユーザー。
• createdDate(optional): object date
  date
• description(optional): string
  コレクションの説明。
• id(optional): string
  コレクションのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isDynamic(optional): boolean
  true
• links(optional): array links
  リンク
• name(optional): string
  コレクションの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• repository(optional): object RepositoryIdentifier
  RepositoryIdentifier
• roleName(optional): string
  コレクションのユーザー・ロールの名前。
• ruleGroups(optional): array ruleGroups
• updatedBy(optional): string
  コレクションのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "repository":{
            "description":"Information of the collection repository.",
            "$ref":"#/definitions/RepositoryIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the collection. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the collection."
        },
        "isDynamic":{
            "type":"boolean",
            "description":"true"
        },
        "ruleGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleGroup"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Collection."
        },
        "createdDate":{
            "description":"date and time Collection createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Collection."
        },
        "updatedDate":{
            "description":"date and time Collection updatedAt.",
            "$ref":"#/definitions/date"
        },
        "channels":{
            "type":"array",
            "description":"Channels associated with the collection.",
            "items":{
                "$ref":"#/definitions/ChannelInCollections"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the collection."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Collection"
}

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

型: array

コレクションに関連付けられているチャネル。

ソースを表示

• Array of: object ChannelInCollections
  ChannelInCollections

{
    "type":"array",
    "description":"Channels associated with the collection.",
    "items":{
        "$ref":"#/definitions/ChannelInCollections"
    }
}

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

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

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

型: array

リンク

ソースを表示

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

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

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

型: object

RepositoryIdentifier

ソースを表示

• id(optional): string
  コレクション・リポジトリのId。 これはレスポンス取得の必須プロパティです。
• name(optional): string
  コレクション・リポジトリの名前。 これはレスポンス取得の必須プロパティです。
• role (オプション): string
  コレクション・リポジトリのロール。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection repository. It is a required property in the get response."
        },
        "name":{
            "type":"string",
            "description":"Name of the collection repository. It is a required property in the get response."
        },
        "role":{
            "type":"string",
            "description":"Role on the collection repository."
        }
    },
    "description":"RepositoryIdentifier"
}

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

型: array

ソースを表示

• Array of: object RuleGroup
  ルール・グループ定義

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

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

型: object

ChannelInCollections

ソースを表示

• id(optional): string
  チャネルのId。
• name(optional): string
  チャネルの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInCollections"
}

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

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

型: object

ルール・グループ定義

ソースを表示

• assetType(optional): string
  ルール・グループに関連付けられたアセット・タイプ。ルール・グループ内のすべてのルールは、このアセット・タイプに関連するプロパティに基づきます

  例: File
• conjunction(optional): string
  このルール・グループを前のグループと結合するときに使用する演算子

  例: OR
• ruleSet(optional): array ruleSet
  ルール・グループに関連付けられたルールのセット

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"OR",
            "description":"the operator to be used while joining this rule group with a previous group"
        },
        "assetType":{
            "type":"string",
            "example":"File",
            "description":"asset type associated with the rule group, all rules within the rule group are based on properties related to this asset type"
        },
        "ruleSet":{
            "type":"array",
            "description":"set of rules associated with the rule group",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"rule group definition"
}

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

型: array

ルール・グループに関連付けられたルールのセット

ソースを表示

• Array of: object RuleSet
  ルールまたは条件のセット

{
    "type":"array",
    "description":"set of rules associated with the rule group",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

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

型: object

ルールまたは条件のセット

ソースを表示

• conjunction(optional): string
  このルール・セットと既存のルール・セットを結合するときに使用する演算子

  例: and
• rule(optional): object Rule
• ruleSet(optional): array ruleSet
  指定されたルール・セットに関連付けられた子またはサブ・ルール・セット

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"and",
            "description":"The operator to be used when combining this rule set with an existing rule set"
        },
        "rule":{
            "description":"The rule definition within the rule set",
            "$ref":"#/definitions/Rule"
        },
        "ruleSet":{
            "type":"array",
            "description":"The child or sub rule set associated with the given rule set",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"Set of rules or conditions"
}

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

型: object

ソースを表示

• fieldId(optional): string
• fieldName(optional): string
• fieldValue(optional): string
• operator(optional): string

{
    "type":"object",
    "properties":{
        "fieldId":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        }
    }
}

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

型: array

指定されたルール・セットに関連付けられた子またはサブ・ルール・セット

ソースを表示

• Array of: object RuleSet
  ルールまたは条件のセット

{
    "type":"array",
    "description":"The child or sub rule set associated with the given rule set",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースにGETリクエストを送信して、すべてのアイテムを検索する方法を示します。

curl -X PUT -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'http://host:port/content/management/api/v1.1/repositories/{id}/collections/{collectionId}'

例1:

既存のリポジトリの名前または説明で既存のコレクションが更新されます。 F264EF72737B35991E381047D5B43D87656640771B3Cは既存のリポジトリのidであり、O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407はリポジトリに関連付けられている既存のコレクションのidです。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/repositories/{id}/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407

レスポンス本文

{
    "id": "O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
    "name": "Collection1_updatedName",
    "description": "Collection1 description_ some Update."
    }

例2:

これは、既存のリポジトリにチャネルのリストを追加することでコレクションを更新します。 F264EF72737B35991E381047D5B43D87656640771B3Cは既存のリポジトリのidであり、O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407はリポジトリに関連付けられた既存のコレクションのidであり、CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0、CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E、CCB70F44D5015819EBC0F86A2B3133B22638AF123V8Aはリポジトリに関連付けられた既存のチャネルのidです。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/repositories/{id}/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407

レスポンス本文

{
    "id": "O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
    "name": "Collection2",
    "description": "Collection2 description.",
    "channels": [
    {
      "id": "CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E"
    },
    {
      "id": "CCB70F44D5015819EBC0F86A2B3133B22638AF123V8A"
    },
    {
      "id": "CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0"
    }
    ]
    }

先頭に戻る