APIを使ったキャンペーンのアップデート

キャンペーンに必要な変更を加えてアップデートします。編集できるのはラベルか参加者のみです。

この例ではリクエストの送信でTalend API Testerが使われます。

Talend API Testerの詳細は、Talend Cloud API Testerユーザーガイドをご覧ください。

手順

パーソナルアクセストークンがまだない場合は1つ生成します。詳細は、パーソナルアクセストークンを生成をご覧ください。
ブラウザーでTalend API Testerを開きます。
[Repository] (リポジトリー)タブの[Method] (メソッド)ドロップダウンリストで、[Put]を選択します。
https://tds.{region}.cloud.talend.com/data-stewardship/api/v1/campaigns/ownedというURLを入力します。

各データセンターのURLのリストは、Talend CloudのリージョンとURLで確認できます。
[Add hearder] (ヘッダーの追加)ボタンをクリックし、[name] (名前)フィールドに Authorizationと、そして[value] (値)フィールドにBearerに続けて空白スペースと自分のトークンを入力します。
[Add header] (ヘッダーの追加)ボタンをクリックし、[name] (名前)フィールドにCookieと入力します。[value] (値)フィールドを空のままにしておきます。

[Body] (ボディ)フィールドに、キャンペーンの作成で使用されたPOST https://tds.{region}.cloud.talend.com/data-stewardship/api/v1/campaigns/owned操作のボディを含めて、必要な変更を加えます。

例

[New] (新規)ワークフローステップでsteward2@account.comデータスチュワードを追加する場合は、participantsオブジェクトの[Supervisor] (スーパーバイザー)値に追加します:

{
    "campaign": {
        "name": "my-campaign-resolution-created-via-api",
        "label": "Improve product catalog data quality (created via API)",
        "description": "Increase the level of data quality for each product catalog.",
        "owners": ["owner@account.com"],
        "taskType": "RESOLUTION",
        "schemaRef": {
            "namespace": "org.talend.schema",
            "name": "my_products_created_via_API",
            "version": 1,
            "displayName": "Product (created via API)"
        },
        "taskResolutionDelay": {
            "value": 10,
            "unit": "DAYS"
        },
        "workflow": {
            "name": "default workflow",
            "states": [{
                "name": "New",
                "label": "New",
                "transitions": [{
                    "name": "To validate",
                    "label": "To validate",
                    "targetStateName": "To validate",
                    "allowedRoles": ["Supervisor"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "To validate",
                "label": "To validate",
                "transitions": [{
                    "name": "Accept",
                    "label": "Accept",
                    "targetStateName": "Resolved",
                    "allowedRoles": ["Validator"]
                }, {
                    "name": "Reject",
                    "label": "Reject",
                    "targetStateName": "New",
                    "allowedRoles": ["Validator"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "Resolved",
                "label": "Resolved",
                "transitions": [],
                "allowedRoles": ["Validator"],
                "translations": {}
            }]
        }
    },
    "participants": {
        "Supervisor": ["steward1@account.com", "steward2@account.com"],
        "Validator": ["steward1@account.com"]
    }
}

[Send] (送信)をクリックします。

タスクの結果

リクエストが成功したことを表す200 HTTPコードがAPIによって返されます。この応答には、キャンペーンのJSONによるアップデート済み説明が含まれています。

このページは役に立ちましたか?

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。

こちらにフィードバックをお寄せください