パッケージを作成
この呼び出しでは、複数ステップのプロセスが実行されます。
最初のステップでは、「ASSEMBLING」ステータスの空のプロモーションパッケージが作成されます。
2 番目のステップでは、POST 本文で指定された objectCollections 配列を使用して、Workfront に要求されたレコードを組み立てます。要求されたレコードの数と Workfront の設定によっては、このステップが完了するまでに数分かかる場合があります。このプロセスの終わりに、空のプロモーションパッケージに packageEntities が反映され、ステータスが自動的に「DRAFT」に設定されます。
NOTEobjectCollections 配列の構造をメモしておきます。配列内の各項目には、Workfront API エクスプローラーに記載されているオブジェクトコードに対応する
objCode キーが含まれます。また、各項目には
entities コレクションも含まれています。これは、ID フィールドを想定しています。また、ID で表されている内容がわかりやすくなるように、オプションの name 属性を指定することもできます。objectCollections リストで要求できるオブジェクトコードのリストについては、この記事の環境プロモーションでサポートされているオブジェクトの節を参照してください。URL
POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages
ヘッダー
{
"apikey": "**********",
"Content-Type": "application/json"
}
または
{
"sessionID": "*****************",
"Content-Type": "application/json"
}
本文
{
"name": "Agency Onboarding - 2023-06-06",
"description": "This promotion package contains configuration to support the agency onboarding processes...",
"source": "https://{domain}.{environment}.workfront.com",
"objectCollections": [
{
"objCode": "PROJ",
"entities": [
{
"ID": "6419b8b9001151ee258921a4f7597ba1",
"name": "Agency Request"
}
]
},
{
"objCode": "TMPL",
"entities": [
{
"ID": "6419b8b9001151ee258921a4f7597bb2",
"name": "New Agency Onboarding"
},
{
"ID": "6419b8b9001151ee258921a4f7597bc3",
"name": "New Agency Offboarding"
}
]
},
{
"objCode": "PTLTAB",
"entities": [
{
"ID": "645e6435000b4aaebe4776f4a42ed5ad",
"name": "Agency Performance and Readiness"
}
]
}
]
}
応答
200
{
"data": {
"id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
"name": "Agency Onboarding - 2023-06-06",
"description": "This promotion package contains configuration to support the agency onboarding processes...",
"source": "https://{domain}.{environment}.workfront.com",
"status": "ASSEMBLING",
"version": 1,
"createdAt": "2023-06-06T17:29:21.600Z",
"createdById": "61aa9d0e0005fcee8f212835bdaa2619",
"publishedAt": null,
"customerId": "61aa9d090005fa42152c1cb66659f38d"
}
}
パッケージのリストを取得
この呼び出しでは、顧客に属するプロモーションパッケージのフィルタリングされていないリストを返します。
応答には、顧客の Workfront のサンドボックス、プレビューインスタンス、実稼動インスタンスのいずれかから作成されたすべてのパッケージが含まれます。
URL
GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages
ヘッダー
{
"apikey": "**********"
}
または
{
"sessionID": "*****************"
}
本文
空
応答
200
{
"data": [
{
"id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
"name": "Agency Onboarding - 2023-06-06",
"description": "This promotion package contains configuration to support the agency onboarding processes...",
"status": "ASSEMBLING",
"createdAt": "2023-06-06T17:29:21.600Z",
"deletedAt": null
},
{...}
]
}
<!-- 前述の「ステータス」を確認します–追加しましたか？–>
ID でパッケージを取得
この呼び出しでは、要求されたプロモーションパッケージの詳細を返します。
リクエストは、プロモーションパッケージの元のソースに関係なく、任意の環境を通じて行うことができます。
