REST APIリファレンス

前へ次へ

org

このリソースを使用して、

Informatica Intelligent Cloud Services

組織または関連するサブ組織の詳細を要求します。このリソースを使用して、組織または関連するサブ組織を更新することができます。サブ組織を削除することもできます。

GET要求

組織の詳細を要求するには、次のURIを使用します。

/api/v2/org

組織に関連するサブ組織の詳細を要求するために、URIにサブ組織IDまたはサブ組織名を含めることができます。次のいずれかのURIを使用します。

/api/v2/org/<sub-organization ID>

/api/v2/org/name/<sub-organization name>

URIに組織名を使用し、組織名にスペースが含まれる場合、スペースを

%20

に置き換えます。以下に例を示します。

/api/v2/org/name/my%20suborg

GET応答

組織の詳細を要求するときに、

Informatica Intelligent Cloud Services

はリスト形式でorgオブジェクトを返します。

組織が組織階層の親組織の場合、orgオブジェクトにすべてのサブ組織のIDと名前が含まれます。

エラーが発生した場合にエラーオブジェクトを返します。

org

オブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	組織ID。
orgId	String	組織ID。
name	String	組織名。
description	String	組織の説明。
createTime	Date/Time	組織が作成された日時。
updateTime	Date/Time	組織の最終更新時刻。
createdBy	String	組織を作成したユーザー。
updatedBy	String	組織を更新した最後のユーザー。
parentOrgId	String	親組織の組織ID。組織がスタンドアロンまたは親の組織である場合、0を返します。
address1	String	組織の住所。
address2	String	組織の住所の追加情報。
address3	String	組織の住所の追加情報。
city	String	組織の拠点がある市区町村。
state	String	組織の拠点がある都道府県。州コードを返します。詳細については、州コードを参照してください。
zipcode	String	組織の拠点がある地域の郵便番号。
timezone	String	組織のタイムゾーン。詳細については、タイムゾーンのコードを参照してください。
country	String	組織の拠点がある国。国コードを返します。詳細については、国コードを参照してください。
employees	String	組織の従業員の範囲。
offerCode	String	Informatica Intelligent Cloud Services パートナーに割り当てられたオファーコード。
successEmails	String	正常に完了したタスクの通知を受信するための電子メールアドレス。
warningEmails	String	エラーで完了したタスクの通知を受信するための電子メールアドレス。
errorEmails	String	完了に失敗したタスクの通知を受信するための電子メールアドレス。
campaignCode	String	キャンペーンコード。
atlasProjectId	String	AtlasプロジェクトID。
zuoraAccountId	String	ZuoraアカウントID。
spiUrl	String	このフィールドは適用されなくなり、非推奨になりました。
devOrg	Boolean	組織が開発組織であることを示します。開発組織の場合は1を返します。プロダクション組織の場合は0を返します。
maxLogRows	Int	アクティビティログに保持する最大行数。
minPasswordLength	Int	ユーザーアカウントパスワードの最小文字数。
minPasswordCharMix	Int	各パスワードには文字を混在させる必要があります。パスワードには、次の文字セットを混在させることができます: 小文字、大文字、数字、および特殊文字。次のいずれかの値を返します。 1. 少なくとも1つの文字セットが含まれます。 2. 少なくとも2つの文字セットが含まれます。 3. 少なくとも3つの文字セットが含まれます。 4. 4つすべての文字セットが含まれます。
passwordReuseInDays	Int	前のパスワードを再度使用できるまでの日数。値0はパスワードを常に再利用できることを意味します。
passwordExpirationInDays	Int	パスワードの有効期限までの日数。値0はパスワードの有効期限がないことを意味します。
subOrgLimit	Int	許可されたサブ組織数。限界がカスタマイズされている場合、REST APIはカスタム制限を返します。カスタマイズされていない場合、REST APIはエディションに関連付けられた制限を返します。
restApiSessionLimit	Int	許可されたconcurrent REST APIの同時セッションの数。限界がカスタマイズされている場合、REST APIはカスタム制限を返します。カスタマイズされていない場合、REST APIはエディションに関連付けられた制限を返します。
parentOrgId	String	親組織の組織ID。 0は、組織がスタンドアロンまたは親の組織であることを示します。
jobExecUserProfile	String	コンタクト検証タスクを実行するために設定された Informatica Intelligent Cloud Services ユーザーアカウント。
orgUUID	String	組織の一意のID。
subOrgs		各サブ組織に情報を含むオブジェクト。
id	String	subOrgsオブジェクトに含まれます。サブ組織のID。
name	String	subOrgsオブジェクトに含まれます。サブ組織の名前。

POST要求

REST APIセッションを開始したユーザーが、管理者ロールを所有し、更新する組織または親組織のいずれかに属している場合、

Informatica Intelligent Cloud Services

組織を更新できます。

組織に適切なライセンスがあり、REST APIセッションを開始したユーザーが親組織で管理者ロールを持つ場合、サブ組織を更新できます。

親組織に関連するサブ組織の詳細を更新するには、次のURIの組織IDを使用します。組織の詳細を更新するには、オプションのIDを省略します。

/api/v2/org/<id>

REST APIを介して組織を更新するときに、アクションは完全に更新されます。フィールドが要求に含まれていない場合、値はデフォルトにリセットします。

組織ID、オファーコード、または組織で作成された組織管理者のユーザーアカウントは更新できません。

このURIで、

org

オブジェクトの次の属性を使用できます。

フィールド	タイプ	必須	説明
name	String	○	組織名。
address	String	○	組織の住所。
address2	String		組織の住所の追加情報。
address3	String		組織の住所の追加情報。
city	String	○	組織の拠点がある市区町村。
state	String	国がUSの場合に必須。	組織の拠点がある都道府県。適切な州コードを使用します。国がUSに設定される場合に必須。詳細については、付録A、州コードを参照してください。
zipcode	String	国がUSの場合に必須。	組織の拠点がある地域の郵便番号。国がUSに設定される場合に必須。
country	String	○	組織の拠点がある国。適切な国コードを使用します。詳細については、付録A、国コードを参照してください。
timezone	String		組織のタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、付録A、タイムゾーンのコードを参照してください。
description	String		組織の説明。最大長は255文字です。
successEmails	String		ジョブが正常に完了したことを通知するためのデフォルトの電子メールアドレス。
warningEmails	String		ジョブ完了について警告するためのデフォルトの電子メールアドレス。
errorEmails	String		ジョブ失敗について通知するためのデフォルトの電子メールアドレス。
employees	String	○	組織の従業員の範囲。次の範囲のいずれかを使用します。 "0_10" "11_25" "26_50" "51_100" "101_500" "501_1000" "1001_5000" "5001_"
offerCode	String		Informatica Intelligent Cloud Services パートナーに割り当てられたオファーコード。
passwordReuseInDays	Int		前のパスワードを再度使用できるまでの日数。最大日数は730（2年）です。値0はパスワードを常に再利用できることを意味します。
passwordExpirationInDays	Int		パスワードの有効期限までの日数。最大日数は180です。値0はパスワードの有効期限がないことを意味します。

POST応答

成功した場合、作成または更新した組織のorg要求オブジェクトを返します。

エラーが発生した場合にエラーオブジェクトを返します。

DELETE要求

REST APIセッションを開始したユーザーが、管理者ロールを所有し、親組織に属している場合、

Informatica Intelligent Cloud Services

サブ組織を削除できます。

Informatica Intelligent Cloud Services

組織を削除するには、次のURIで組織IDを使用します。

/api/v2/org/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。

エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

ID 02340000でサブ組織を更新するために、次の要求を使用することができます。

POST <serverUrl>/api/v2/org/02340000
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<org>
  <name>Dev Org</name>
  <address1>333 Main Street</address1>
  <city>City</city>
  <state>MD</state>
  <zipcode>90001</zipcode>
  <country>US</country>  
  <timezone>America/Chicago</timezone>
</org>

成功した要求は、更新したサブ組織のorg要求オブジェクトを返します。

プラットフォームREST APIバージョン2リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal