Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべてのパートナ・プログラムの取得

get

/crmRestApi/resources/11.13.18.05/partnerPrograms

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : パートナ・プログラムIDを使用してパートナ・プログラムを検索します。
  ファインダ変数:
  - PartnerProgramId; integer; システム生成の一意の識別子およびパートナ・プログラムの主キー。
- ProgramNumberRF : プログラム番号を使用してパートナ・プログラムを検索します。
  ファインダ変数:
  - ProgramNumber; string; プログラムごとに生成される代替キー識別子。
- UniqueProgramNumber : プログラム番号を使用してパートナ・プログラムを検索します。
  ファインダ変数:
  - ProgramNumber; string; プログラムごとに生成される代替キー識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CountryNames; string; プログラムに適用される国のリスト。
- CreatedBy; string; 行を作成したユーザー。
- CreationDate; string; 行が作成された日時。
- EndDateActive; string; パートナ・プログラムが終了する日付。
- LastUpdateDate; string; 行が最後に更新された日時。
- LastUpdatedBy; string; 行を最後に更新したユーザー。
- OwnerPartyNumber; string;パートナ・プログラムの所有者パーティの公開一意識別子。
- PartnerProgramId; integer; システム生成の一意の識別子およびパートナ・プログラムの主キー。
- ProgramDescription; string;プログラムを説明するテキスト。
- ProgramManagerName; string;パートナ・プログラムの所有者/マネージャの名前。
- ProgramName; string;パートナ・プログラムの名前。
- ProgramNumber; string; プログラムごとに生成される代替キー識別子。
- ProgramType; string;パートナ・プログラムのタイプ。たとえば、再販業者やGo-To-Marketなどです。
- StartDateActive; string; パートナ・プログラムが開始する日付。
- StatusCode; string; プログラムのステータスを示すコード。たとえば、ドラフト、失敗、公開済、拒否済、保留中、終了済、未公開などがあります。有効な値のリストは、参照ZPM_PROGRAM_STATUSで定義されます。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : partnerPrograms

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object partnerPrograms-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : partnerPrograms-item-response

タイプ: object

ソースを表示

Attachments: array Attachments

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。
CountryNames: string

タイトル: Countries

読取り専用: true

プログラムに適用される国のリスト。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DeleteFlag: boolean

読取り専用: true

プログラムを削除できるかどうかを示します。値がYの場合、プログラムを削除できます。デフォルト値はNです。
EndDateActive: 文字列(日付)

タイトル: End Date

パートナ・プログラムが終了する日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

プログラムを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OwnerPartyNumber: string

タイトル: Owner Party Number

読取り専用: true

最大長: 30

パートナ・プログラムの所有者パーティの公開一意識別子です。
PartnerProgramCountries: array Countries

タイトル: Countries

国のリソースは、パートナ・プログラムに関連付けられた国を表示、作成、更新および削除するために使用されます。国のリソースは、特定の国のパートナ・プログラムの可用性の範囲を決定するために使用されます。
PartnerProgramId: integer

タイトル: Program ID

パートナ・プログラムのシステム生成の一意の識別子および主キー。
ProgramBenefitDetails: array Program Benefit Details

タイトル: Program Benefit Details

プログラム福利厚生詳細リソースは、パートナ・プログラムに追加されたプログラム福利厚生の表示、作成、更新および削除に使用されます。
ProgramDescription: string

タイトル: Description

最大長: 1000

プログラムを説明するテキスト。
ProgramManagerId: integer

タイトル: Program Manager ID

パートナ・プログラムの所有者の一意の識別子。
ProgramManagerName: string

タイトル: Owner

最大長: 360

パートナ・プログラムの所有者/管理者の名前。
ProgramName: string

タイトル: Name

最大長: 150

パートナ・プログラムの名前。
ProgramNumber: string

タイトル: Program Number

最大長: 30

プログラムごとに生成される代替キー識別子。
ProgramTiers: array Tiers

タイトル: Tiers

パートナ・プログラム階層リソースは、特定のプログラムの階層を表示、作成、更新および削除するために使用されます。パートナ・プログラムは、階層に編成し、ビジネスへの貢献度に基づいてパートナに割り当てることができます。
ProgramType: string

タイトル: Type

最大長: 30

パートナ・プログラムのタイプ。たとえば、再販業者やGo-To-Marketなどです。
StartDateActive: 文字列(日付)

タイトル: Start Date

パートナ・プログラムが開始する日付。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: D

プログラムのステータスを示すコード。たとえば、ドラフト、失敗、公開済、拒否済、保留中、終了済、未公開などがあります。有効な値のリストは、参照ZPM_PROGRAM_STATUSで定義されます。
UpdateFlag: boolean

読取り専用: true

プログラムを更新できるかどうかを示します。値がYの場合、プログラムを更新できます。デフォルト値はNです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Owner Party on the Partner Programs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramBenefitDetails":{
            "title":"Program Benefit Details",
            "type":"array",
            "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-response"
            }
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the program. For example, Draft, Failed, Published, Rejected, Pending, Terminatedm or Unpublished. A list of valid values is defined in the lookup ZPM_PROGRAM_STATUS .",
            "nullable":false,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-Attachments-item-response"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program can be deleted. If the value is Y, then the program can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramManagerId":{
            "title":"Program Manager ID",
            "type":"integer",
            "description":"The unique identifier for the owner of the partner program.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryNames":{
            "title":"Countries",
            "type":"string",
            "description":"The list of countries that apply to the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the partner program starts.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the program can be updated. If the value is Y, then the program can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the partner program ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the program.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerProgramCountries":{
            "title":"Countries",
            "type":"array",
            "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-response"
            }
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier generated for each program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramManagerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner/manager of the partner program.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of partner program. For example, Reseller or Go-to-Market.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。

ソースを表示

Array of: object partnerPrograms-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-Attachments-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: array

タイトル: Countries

国のリソースは、パートナ・プログラムに関連付けられた国を表示、作成、更新および削除するために使用されます。国のリソースは、特定の国のパートナ・プログラムの可用性の範囲を決定するために使用されます。

ソースを表示

Array of: object partnerPrograms-PartnerProgramCountries-item-response

{
    "title":"Countries",
    "type":"array",
    "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-response"
    }
}

ネストされたスキーマ : プログラム給付金詳細

タイプ: array

タイトル: Program Benefit Details

プログラム福利厚生詳細リソースは、パートナ・プログラムに追加されたプログラム福利厚生の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object partnerPrograms-ProgramBenefitDetails-item-response

{
    "title":"Program Benefit Details",
    "type":"array",
    "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-response"
    }
}

ネストされたスキーマ : 階層

タイプ: array

タイトル: Tiers

パートナ・プログラム階層リソースは、特定のプログラムの階層を表示、作成、更新および削除するために使用されます。パートナ・プログラムは、階層に編成し、ビジネスへの貢献度に基づいてパートナに割り当てることができます。

ソースを表示

Array of: object partnerPrograms-ProgramTiers-item-response

{
    "title":"Tiers",
    "type":"array",
    "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-response"
    }
}

ネストされたスキーマ : partnerPrograms-Attachments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

レコードを作成したユーザーの名前。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示す値。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付の作成元のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

ファイルのURI。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

レコードを最後に更新したユーザーの名前。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Title: string

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルのサイズ。
UploadedFileName: string

タイトル: Uploaded File Name

新しい添付ファイルに割り当てる名前。
UploadedText: string

タイトル: Uploaded Text

新規テキスト添付のテキスト・コンテンツ。
Uri: string

タイトル: Uri

最大長: 4000

トポロジ・マネージャ・タイプ・アタッチメントのURI。
Url: string

タイトル: Url

最大長: 4000

webページ・タイプ添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付を作成したユーザーのログイン資格証明。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : partnerPrograms-PartnerProgramCountries-item-response

タイプ: object

ソースを表示

CountryCode: string

最大長: 2

パートナ・プログラムが適用される国コード。
CountryName: string

タイトル: Territory Name

読取り専用: true

最大長: 80

パートナ・プログラムが適用される国の名前。
CreatedBy: string

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

行が作成された日時。
DeleteFlag: boolean

読取り専用: true

プログラム国を削除できるかどうかを示します。値がYの場合、プログラム国を削除できます。デフォルト値はNです。
LastUpdateDate: string (date-time)

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PartnerProgramId: integer

国に関連付けられているパートナ・プログラムの一意の識別子。
ProgramCountryId: integer

プログラム国のシステム生成の一意の識別子および主キー。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Territory Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a country to which a partner program applies.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the country.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"The country code to which the partner program applies.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program countries can be deleted. If the value is Y, then the program countries can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : partnerPrograms-ProgramBenefitDetails-item-response

タイプ: object

ソースを表示

BenefitListValue: string

プログラム特典の値タイプが「リスト」の場合のプログラム階層特典のリスト値。
BenefitValue: string

タイトル: Benefit Value

最大長: 150

プログラム階層の値には、プログラム・ベネフィットの値タイプに適した書式の利点があります。
CategoryCode: string

タイトル: Category

読取り専用: true

最大長: 30

プログラム特典のカテゴリを示すコード。有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DataType: string

タイトル: Value Type

読取り専用: true

最大長: 30

プログラム特典の値タイプ。
DeleteFlag: boolean

読取り専用: true

プログラム特典を削除できるかどうかを示します。値がYの場合、プログラム特典は削除できます。デフォルト値はNです。
Description: string

タイトル: Benefits Description

読取り専用: true

最大長: 1000

プログラム特典を説明するテキスト。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

プログラム特典詳細を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Name

最大長: 155

プログラム階層特典の名前。
PartnerProgramId: integer (int64)

タイトル: Program

プログラム階層特典が追加されたパートナ・プログラムの一意の識別子。
ProgramBenefitDetailId: integer

タイトル: Program Benefit Details

システム生成の一意の識別子およびプログラム階層特典の主キー。
ProgramBenefitId: integer (int64)

タイトル: Benefit

プログラムまたはプログラム階層に追加されるプログラム・ベネフィットの一意の識別子。
TierId: integer (int64)

タイトル: Tier

プログラム階層特典が適用される階層の一意の識別子。
TierName: string

タイトル: Name

読取り専用: true

最大長: 155

プログラム階層特典が適用される階層の名前。
UpdateFlag: boolean

読取り専用: true

プログラム特典を更新できるかどうかを示します。値がYの場合、プログラム特典を更新できます。デフォルト値はNです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Benefits Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier for the partner program to which the program tier benefit has been added.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.PartnerProgramsVO",
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"ProgramName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartnerProgramId"
            },
            "x-queryable":true
        },
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "title":"Benefit",
            "type":"integer",
            "description":"The unique identifier for a program benefit added to a program or program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.ProgramBenefitsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ProgramBenefitId"
            },
            "x-queryable":true
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":150,
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be deleted. If the value is Y, then the program benefit can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be updated. If the value is Y, then the program benefit can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":18,
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of a tier to which a program tier benefit applies.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the program benefit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramBenefitDetailId":{
            "title":"Program Benefit Details",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ExtnEventActionProperty":"HideInFieldUpdate;",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the program benefit detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate;HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : partnerPrograms-ProgramTiers-item-response

タイプ: object

ソースを表示

BadgeImageName: string

タイトル: Badge

読取り専用: true

最大長: 100

プログラム階層のバッジ・イメージ名。
CreatedBy: string

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

行が作成された日時。
DeleteFlag: boolean

読取り専用: true

プログラム階層を削除する必要があるかどうかを示します。値がYの場合、プログラム階層を削除する必要があります。デフォルト値はNです。
EnrollmentCount: integer

タイトル: Enrollments

読取り専用: true

プログラム階層を参照している登録の数。
LastUpdateDate: string (date-time)

読取り専用: true

行を最後に更新したユーザー。
LastUpdatedBy: string

読取り専用: true

最大長: 64

行が最後に更新された日時。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Name

読取り専用: true

最大長: 155

プログラム階層の名前。
PartnerProgramId: integer (int64)

プログラム階層に関連付けられたパートナ・プログラムの一意の識別子。
ProgramTierId: integer (int64)

プログラムに追加されるプログラム階層の一意の識別子。
ランキング: 整数(int32)

タイトル: Rank

読取り専用: true

プログラム階層のランク。
TierId: integer (int64)

プログラムに追加される階層の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time the row was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramTierId":{
            "type":"integer",
            "description":"The unique identifier for a program tier added to a program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BadgeImageName":{
            "title":"Badge",
            "maxLength":100,
            "type":"string",
            "description":"The badge image name of the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program tier should be deleted. If the value is Y, then the program tier has to be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the program tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentCount":{
            "title":"Enrollments",
            "type":"integer",
            "description":"The count of enrollments referencing the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Ranking":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of the program tier.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"The unique identifier of the Tier which is being added to the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのパートナ・プログラムを取得する方法を示しています。

cURLコマンド

curl -v -u Username:Password -X GET "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerPrograms/"

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items" : [ {
  "PartnerProgramId" : 300100071293754,
  "ProgramName" : "North America program",
  "ProgramNumber" : "CDRM_12005",
  "ProgramDescription" : null,
  "StartDateActive" : null,
  "EndDateActive" : null,
  "ProgramManagerId" : 100010038017885,
  "ProgramManagerName" : "Channel_OPS_Mgr_ENT1 COM",
  "ProgramType" : "GTMI",
  "StatusCode" : "D",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T12:57:37-08:00",
  "LastUpdateDate" : "2016-02-17T12:57:37-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "DeleteFlag" : "true",
  "UpdateFlag" : "true",
  "CountryNames" : "",
...
}

「トップに戻る」