プロジェクトおよびフォルダ
REST API呼び出しを介して、プロジェクトとフォルダを作成、更新、および削除できます。
注: プロジェクト名またはフォルダ名に特殊文字、スペース文字、または国際文字が含まれている場合は、サーバーが名前を正しくデコードできるように、URIでURLエンコードを使用してください。
例えば、「My Project」という名前のプロジェクトの場合、URIに次のテキストを含めます。
My%20Project
次の文字は使用できません。
# ? ' | { } " ^ & [ ] / \
プロジェクトの作成
アセットを整理するためにプロジェクトを作成します。
POST要求
プロジェクトを作成するには、次のURIを使用してPOST要求を送信します。
/public/core/v3/projects
注: Informatica Intelligent Cloud Services REST APIを使用して最大500個のプロジェクトを作成できます。
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
---|
name | String | ○ | プロジェクトの名前。 |
description | 文字列 | - | プロジェクトの説明。 |
POST応答
成功した場合、次の詳細を含むプロジェクトオブジェクトを返します。
フィールド | タイプ | 説明 |
---|
id | String | プロジェクトID。 |
name | String | プロジェクト名。 |
description | String | プロジェクトの説明。 |
updatedBy | String | プロジェクトを作成したユーザー。 |
updateTime | String | プロジェクトを作成した日時。 |
POSTの例
プロジェクトを作成するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/projects
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"name":"Orders",
"description": "Orders from all regions"
}
次の例のような応答を受信します。
{
"id": "kTKQG4Kv3uhgQleaOoUbWu",
"name": "Orders",
"description": "Orders from all regions",
"updatedBy": "scotty@infa.com",
"updateTime": "2022-04-12T23:40:40.395Z"
}
プロジェクトの更新
プロジェクトの更新権限がある場合は、プロジェクトの名前または説明を変更できます。
PATCH要求
プロジェクトを更新するには、次のURIのいずれかを使用してPATCH要求を送信します。
/public/core/v3/projects/<project ID>
/public/core/v3/projects/name/<project name>
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
---|
name | String | - | プロジェクトの名前。 |
description | 文字列 | - | プロジェクトの説明。 |
PATCH応答
成功したら成功コードを、エラーが発生したらエラーオブジェクトを返します。
PATCHの例
プロジェクトを更新するには、次の例のような要求を送信します。
PATCH <baseApiUrl>/public/core/v3/projects/kTKQG4Kv3uhgQleaOoUbWu
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"name":"Requests",
"description": "Orders from all regions"
}
プロジェクトの削除
プロジェクトにフォルダやアセットが含まれておらず、そのプロジェクトの削除権限がある場合は、プロジェクトを組織から削除できます。
DELETE要求
プロジェクトを削除するには、次のURIのいずれかを使用します。
/public/core/v3/projects/<project ID>
/public/core/v3/projects/name/<project name>
DELETEの例
「All Orders」という名前のプロジェクトを削除するには、次の要求を送信します。
DELETE <baseApiUrl>/public/core/v3/projects/name/All%20Orders
フォルダの作成
デフォルトプロジェクトにフォルダを作成するか、別のプロジェクトを指定できます。
注: Informatica Intelligent Cloud Services REST APIを使用して最大5,000個のフォルダを作成できます。
POST要求
デフォルトプロジェクトにフォルダを作成するには、次のURIを使用します。
/public/core/v3/folders
デフォルトプロジェクト以外のプロジェクトにフォルダを作成するには、次のURIのいずれかを使用します。
/public/core/v3/projects/<project ID>/folders
/public/core/v3/projects/name/<project name>/folders
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
---|
name | String | ○ | フォルダの名前。 |
description | 文字列 | - | フォルダの説明です。 |
POST応答
成功した場合、次の詳細を含むフォルダオブジェクトを返します。
フィールド | タイプ | 説明 |
---|
id | String | フォルダID。 |
name | String | フォルダ名。 |
description | String | フォルダの説明。 |
updatedBy | String | フォルダを作成したユーザー。 |
updateTime | String | フォルダを作成した日時。 |
POSTの例
Ordersプロジェクトにフォルダを作成するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/projects/name/Orders/folders
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"name":"Northwest Orders",
"description": "Orders from northwest offices"
}
次の例のような応答を受信します。
{
"id": "kTrYZ8fInr1Uw3ugQbOuWe",
"name": "Northwest Orders",
"description": "Orders from northwest offices",
"updatedBy": "scotty@infa.com",
"updateTime": "2022-04-13T18:20:40.325Z"
}
フォルダの更新
フォルダの更新権限がある場合は、フォルダの名前または説明を変更できます。
PATCH要求
デフォルトプロジェクトにあるフォルダを更新するには、次のURIを使用してPATCH要求を送信します。
/public/core/v3/folders/<folder ID>
デフォルトプロジェクト以外のプロジェクトにあるフォルダを更新するには、次のURIのいずれかを使用します。
/public/core/v3/projects/<project ID>/folders/<folder ID>
/public/core/v3/projects/name/<project name>/folders/name/<folder name>
注: プロジェクトとフォルダのID、またはプロジェクトとフォルダの名前を1つのURIに含めることはできますが、IDと名前を1つのURIに含めることはできません。例えば、プロジェクトIDとフォルダ名を含めることはできません。
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
---|
name | String | - | フォルダの名前。 |
description | 文字列 | - | フォルダの説明です。 |
PATCH応答
成功したら成功コードを、エラーが発生したらエラーオブジェクトを返します。
PATCHの例
Northeast Ordersフォルダの名前と説明を変更するには、次の例のような要求を送信します。
PATCH <baseApiUrl>/public/core/v3/projects/name/Orders/folders/name/Northeast%20Orders
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"name":"Northeast Requests",
"description": "Requests from the northeast offices"
}
フォルダの削除
フォルダが空で、そのフォルダに対する削除権限がある場合は、フォルダを削除できます。フォルダにアセットが含まれている場合は、フォルダを削除する前に、アセットを削除または移動する必要があります。
DELETE要求
デフォルトプロジェクトにあるフォルダを削除するには、次のURIを使用します。
/public/core/v3/projects/<folder ID>
デフォルトプロジェクト以外のプロジェクトにあるフォルダを削除するには、次のURIのいずれかを使用します。
/public/core/v3/projects/<project ID>/folders/<folder ID>
/public/core/v3/projects/name/<project name>/folders/name/<folder name>
注: プロジェクトとフォルダのID、またはプロジェクトとフォルダの名前を1つのURIに含めることはできますが、IDと名前を1つのURIに含めることはできません。例えば、プロジェクトIDとフォルダ名を含めることはできません。
DELETEの例
「Orders:West Coast」という名前のフォルダを削除するには、次の要求を送信します。
DELETE <baseApiUrl>/public/core/v3/projects/name/Orders/folders/name/Orders%3AWest%20Coast