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

機械翻訳について

すべての営業リード担当の取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1

リクエスト

パス・パラメータ

leadsUniqID(required): string

これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- LeadContactUserKey : 指定されたリードIDおよびパーティIDを持つリード担当者が検索されます。
  ファインダ変数:
  - LeadId; integer; リードIDによる問合せに使用されるパラメータ。
  - PartyId; integer;パーティIDによる問合せに使用されるパラメータ。
- LeadNumberAndPartyNumberRF : 指定されたリード番号およびパーティ番号を持つリード担当者が検索されます。
  ファインダ変数:
  - LeadNumber; string; リソースの問合せに使用されるパラメータ。
  - PartyNumber; string; リソースの問合せに使用されるパラメータ。
- PrimaryKey : 指定されたリード識別子に一致するリードの営業チーム・メンバーを検索します。
  ファインダ変数:
  - LeadMemberId; integer; Leadメンバーの一意の識別子。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- 市区町村、文字列。このリード担当者に関連付けられた識別住所に関連付けられた市区町村。
- ConflictId; integer; この値により、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
- ContactDoNotCallFlag; boolean;ユーザーが個人をコールできるかどうかを示します。値がTrueの場合、ユーザーは個人をコールできません。デフォルト値は「False」です。受け入れられる値のリストは、参照YES_NOを使用して定義されます。この属性の値は、「設定およびメンテナンス」、「作業領域の共通参照の管理」タスクを使用してレビューおよび更新できます。
- ContactDoNotContactFlag; boolean;ユーザーが電話、Eメールまたはメールで個人に連絡できるかどうかを示します。値がTrueの場合、ユーザーは個人に連絡できません。デフォルト値は「False」です。
- ContactDoNotMailFlag; boolean;営業リード担当の個人レベルで設定されたメールしないフラグ。
- ContactJobTitle; string;会社の担当者の役職を表示するラベル。
- CreatedBy; string; この営業リード担当者を作成したユーザー。
- CreationDate; string; この営業リード担当者が作成された日時。
- EmailAddress; string; 営業リード担当者に関連付けられたEメール・アドレス。
- FormattedPhoneNumber; string; リード担当者の書式設定された電話番号。
- JobTitle; string;営業リード担当者のジョブ・タイトル。
- LastUpdateDate; string;営業リード担当者が最後に更新された日時。
- LastUpdateLogin; string; 営業リード・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; 営業リード担当者を最後に更新したユーザー。
- LeadId; integer; この営業リード担当の営業リードの一意の識別子。
- LeadMemberId; integer; 営業リード担当の一意の識別子。
- LeadNumber; string;リードの代替の一意の識別子。
- OrgContactId; integer; この営業リード担当者の組織の一意の識別子。
- PartyId; integer; 担当者が関連付けられているリードの一意の識別子。
- PartyName; string;リード担当者に関連付けられたパーティの名前。
- PartyNumber; string; 営業リード担当者のパーティ番号。
- PartyType; string;リード担当者として記録されたパーティのタイプ。指定可能な値は、個人、組織またはグループです。
- PartyUsageCode; string; 顧客マスターでこのリード担当者に記録されたパーティ使用目的。
- PersonFirstName; string;リード・コンタクトの名。
- PersonLastName; string; リード担当者の姓または名。
- PersonTitle; string;リード担当者に関連付けられたタイトル。これはジョブ・タイトルと同じではありません。
- PostalCode; string; このリード担当者に関連付けられた識別住所の郵便番号。
- PrimaryFlag;ブール。リード担当者がプライマリ担当者であるかどうかを示します。プライマリ見込み客担当者は見込み客所有者でもあります。
- RelationshipId; integer;このリード担当者の一意の関係識別子。これは、このリード担当者とリード顧客との関係を表します。
- ロール、文字列。このリードのコンテキストにおけるリード担当者のロール。
- 都道府県、文字列。この見込み客担当者に関連付けられた識別住所の都道府県。
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のデフォルト・バージョンを選択します。

ルート・スキーマ : leads-MklLeadTcMembers1

タイプ: 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/leads-MklLeadTcMembers1-item-response"
            }
        }
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object leads-MklLeadTcMembers1-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-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"
    }
}

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

タイプ: object

ソースを表示

AccountName: string

タイトル: Existing Account

読取り専用: true

最大長: 900

見込み客担当者に関連付けられた取引先名。
City: string

タイトル: City

読取り専用: true

最大長: 60

このリード担当者に関連付けられた識別住所に関連付けられた市区町村。
ConflictId: integer

タイトル: Conflict Identifier

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
ContactDoNotCallFlag: boolean

タイトル: Do Not Call

読取り専用: true

最大長: 1

ユーザーが個人をコールできるかどうかを示します。値がTrueの場合、ユーザーは個人をコールできません。デフォルト値は「False」です。受け入れられる値のリストは、参照YES_NOを使用して定義されます。この属性の値は、「設定およびメンテナンス」、「作業領域の共通参照の管理」タスクを使用してレビューおよび更新できます。
ContactDoNotContactFlag: boolean

タイトル: Do Not Contact

読取り専用: true

最大長: 1

ユーザーが電話、Eメールまたは郵送で個人に連絡できるかどうかを示します。値がTrueの場合、ユーザーは個人に連絡できません。デフォルト値は「False」です。
ContactDoNotMailFlag: boolean

タイトル: Do Not Mail

読取り専用: true

最大長: 1

営業リード担当者に対して個人レベルで設定されたフラグを郵送しないでください。
ContactJobTitle: string

タイトル: Job Title

会社の担当者のジョブ・タイトルを表示するラベル。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

この営業リード担当者を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

この営業リード担当者が作成された日時。
EmailAddress: string

タイトル: Email

営業リード担当者に関連付けられたEメール・アドレス。
EmailPreference: string

タイトル: Email Preference

読取り専用: true

最大長: 255

引合担当者のEメール・プリファレンスがEメール送信不可、Eメール送信可または値なしのいずれであるかを示します。
FormattedPhoneNumber: string

タイトル: Phone

見込み客担当者の書式設定された電話番号。
JobTitle: string

タイトル: Title

読取り専用: true

最大長: 100

営業リード担当者のジョブ・タイトル。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

営業リード担当者の最終更新日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

営業リード担当者を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated Login

読取り専用: true

最大長: 32

営業リード・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
LeadId: integer (int64)

タイトル: Lead ID

この営業リード担当者の営業リードの一意の識別子。
LeadMemberId: integer (int64)

タイトル: Lead Contact ID

営業リード担当の一意の識別子。
LeadNumber: string

タイトル: Lead Number

最大長: 30

リードの代替一意識別子。
links: array Links

タイトル: Links

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

タイトル: Organization Contact ID

読取り専用: true

この営業リード担当者の組織の一意の識別子。
PartyId: integer (int64)

タイトル: Contact Party ID

担当者が関連付けられているリードの一意の識別子。
PartyName: string

タイトル: Name

読取り専用: true

最大長: 360

リード担当者に関連付けられたパーティの名前。
PartyNumber: string

タイトル: Contact Party Number

読取り専用: true

最大長: 30

営業リード担当者のパーティ番号。
PartyType: string

タイトル: Type

読取り専用: true

最大長: 30

リード担当者として記録されたパーティのタイプ。指定可能な値は、個人、組織またはグループです。
PartyUsageCode: string

タイトル: Party Usage Code

最大長: 30

顧客マスターのこのリード担当者について記録されたパーティ使用目的。
PersonFirstName: string

タイトル: First Name

読取り専用: true

最大長: 150

リード担当者の名。
PersonLastName: string

タイトル: Last Name

読取り専用: true

最大長: 150

リード担当者の姓。
PersonTitle: string

タイトル: Title

読取り専用: true

最大長: 60

見込み客担当者に関連付けられたタイトル。これはジョブ・タイトルと同じではありません。
PhonePreference: string

タイトル: Phone Preference

読取り専用: true

最大長: 255

見込み客担当者が電話プリファレンスが電話不可、電話可、または値なしのいずれであるかを示します。
PostalCode: string

タイトル: Postal Code

読取り専用: true

最大長: 60

このリード担当者に関連付けられた識別住所の郵便番号部分です。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

見込み客担当者がプライマリ担当者かどうかを示します。プライマリ見込み客担当者は見込み客所有者でもあります。
RelationshipId: integer (int64)

タイトル: Relationship ID

このリード担当者の一意の関係識別子。これは、このリード担当者とリード顧客との関係を表します。
Role: string

タイトル: Function

最大長: 30

このリードのコンテキストにおけるリード担当者のロール。
State: string

タイトル: State

読取り専用: true

最大長: 60

このリード担当者に関連付けられた識別住所の都道府県。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead contact is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal code part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the sales lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title associated with the lead contact. This is not the same as the job title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhonePreference":{
            "title":"Phone Preference",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "OrgContactId":{
            "title":"Organization Contact ID",
            "type":"integer",
            "description":"The unique identifier of the Organization for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The label displaying the job title of a contact in his company.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactDoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. \nA list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadMemberId":{
            "title":"Lead Contact ID",
            "type":"integer",
            "description":"The unique identifier for the sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "ContactDoNotMailFlag":{
            "title":"Do Not Mail",
            "maxLength":1,
            "type":"boolean",
            "description":"Do not mail flag set at person level for the sales lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the party recorded as lead contact. Possible values are person, organization or group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created this sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name or surname of a lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "EmailPreference":{
            "title":"Email Preference",
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the lead contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City associated with the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ContactDoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address associated with the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS",
                    "ISBLANK"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The role of lead contact in the context of this lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the lead to which the contact is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":30,
            "type":"string",
            "description":"The party usage recorded for this lead contact in the customer master.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead contact.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the sales lead record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Existing Account",
            "maxLength":900,
            "type":"string",
            "description":"The account name associated with lead contacts.",
            "nullable":true,
            "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"
    }
}

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

タイプ: 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."
        }
    }
}

トップに戻る

例:

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行して、すべての担当者を取得する方法を示しています。

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "items": [
    {
      "LeadMemberId": 300100092582196,
      "RelationshipId": 300100090715458,
      "PartyUsageCode": null,
      "PartyId": 300100090715456,
      "Role": null,
      "CreatedBy": "MHoope",
      "CreationDate": "2016-11-07T03:25:48-08:00",
      "LastUpdatedBy": "MHoope",
      "LastUpdateDate": "2016-11-07T03:25:53-08:00",
      "LeadId": 300100092582093,
      "PartyName": "Test Contact",
      "PrimaryFlag": false,
      "PersonLastName": "Contact",
      "PersonFirstName": "Test",
      "PartyType": "PERSON",
      "PersonTitle": null,
      "FormattedPhoneNumber": "+1 (2222)222222 x22",
      "PartyNumber": "CDRM_568258",
      "EmailAddress": "testContact@oracle.com",
      "OrgContactId": 300100090715459,
      "JobTitle": null,
      "ContactDoNotCallFlag": false,
      "ContactDoNotContactFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582196",
          "name": "MklLeadTcMembers1",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
.......
 ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1",
      "name": "MklLeadTcMembers1",
      "kind": "Collection"
    }
  ]
}

「トップに戻る」