機械翻訳について

移動先

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

ワークフロー・タスクに対するアクションを実行します。

post

/content/management/api/v1.1/items/{id}/workflowAction

リクエスト

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

• application/json

パス・パラメータ

• id: string
  アイテムのId。

問合せパラメータ

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

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

タスク・ステータスは、ペイロード内の指定された情報に基づいて更新されます。 ペイロード内に指定されている場合でも、itemsおよびfailedItemsフィールドは無視されます。

ルート・スキーマ : WorkflowActionBean

型: object

WorkflowActionBean

ソースを表示

• comments(optional): string
  実行されたアクションに関連するコメント
• failedItems(optional): array failedItems
  処理が失敗した品目
• items(optional): array items
• tasks(optional): array tasks
  品目からタスクへのマッピング
• value(optional): string
  アイテムに適用されるアクション

{
    "type":"object",
    "properties":{
        "tasks":{
            "type":"array",
            "description":"Item to tasks mapping",
            "items":{
                "$ref":"#/definitions/TaskItemMapping"
            }
        },
        "value":{
            "type":"string",
            "description":"action applied on the items"
        },
        "comments":{
            "type":"string",
            "description":"comments related to the action taken"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"WorkflowActionBean"
}

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

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

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

型: array

ソースを表示

• Array of: object ItemId

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

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

型: array

品目からタスクへのマッピング

ソースを表示

• Array of: object TaskItemMapping
  TaskItemMapping

{
    "type":"array",
    "description":"Item to tasks mapping",
    "items":{
        "$ref":"#/definitions/TaskItemMapping"
    }
}

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

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• message(optional): string
  失敗品目メッセージです。
• name(optional): string
  アイテムの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "message":{
            "type":"string",
            "description":"failed item message."
        }
    }
}

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

型: array

アイテム・リソースのリンク

ソースを表示

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

{
    "type":"array",
    "description":"links of the item 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."
}

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

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

アイテム・リソースのリンク

ソースを表示

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

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

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

型: object

TaskItemMapping

ソースを表示

• itemId(optional): string
  アイテムのId。
• taskId(optional): string
  ワークフロー・タスクのID。

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"id of the item."
        },
        "taskId":{
            "type":"string",
            "description":"id of the workflow task."
        }
    },
    "description":"TaskItemMapping"
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

400レスポンス

不正リクエスト

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る