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

機械翻訳について

営業リード・リソースの取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}

リクエスト

パス・パラメータ

LeadResourceId(required): integer

営業リード・リソースの一意の識別子。
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
links: string

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

例:
self,canonical
onlyData: boolean

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

ヘッダー・パラメータ

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-MklLeadResources-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

デフォルト値: FULL

チーム・メンバーのアクセス・レベルを示すコード。
ConflictId: integer (int64)

タイトル: Conflict Identifier

デフォルト値: 1

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

タイトル: Created By

読取り専用: true

最大長: 64

この営業リード・リソースを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

この営業リード・リソースが作成された日時。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

営業リード・チーム・リソースに関連付けられたEメール・アドレス。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

リード営業チーム・リソースの書式設定された電話番号。
FunctionalRole: string

タイトル: Function

最大長: 30

この営業リードの処理のためにこの営業チーム・リソースによって果たされるロール。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

営業リード・リソースの最終更新日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

営業リード・リソースを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LeadId: integer

タイトル: Lead ID

この営業リード・リソースの営業リードの一意の識別子。
LeadNumber: string

タイトル: Lead Number

最大長: 30

リードの代替一意識別子。
LeadResourceId: integer

タイトル: Lead Resource ID

営業リード・リソースの一意の識別子。
links: array Links

タイトル: Links

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

タイトル: Manager Name

読取り専用: true

最大長: 360

営業リード・マネージャの名前。
Name: string

タイトル: Organization

読取り専用: true

最大長: 240

営業リード・リソースの名前。
PartyName: string

タイトル: Team Member

読取り専用: true

最大長: 360

営業リード・リソースに関連付けられたパーティの名前。
PartyNumber: string

タイトル: Resource Party Number

読取り専用: true

最大長: 30

リード・リソースに関連付けられたパーティの担当者番号。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

レコードがリードのプライマリ・リソースを表すかどうかを示します。リードのプライマリ・リソースは、リード所有者と同じです。
PrimaryPhonePurpose: string

タイトル: Role

読取り専用: true

最大長: 30

基礎となる担当者TCAデータの更新に使用される担当者のタイプ。
ResourceId: integer

タイトル: Resource ID

この営業リード・リソースに関連付けられた一意の識別子。
ResourceOrgId: integer (int64)

タイトル: Resource Organization ID

読取り専用: true

この営業リード・リソースに関連付けられたリソース組織の一意の識別子。
RoleName: string

タイトル: Role

読取り専用: true

最大長: 60

営業リードに関連付けられた営業リード・リソースのロールの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead resource is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created this sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"FULL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the sales lead manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Team Member",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The role played by this Sale team resource for the handling of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address associated with the sales lead team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "LeadResourceId":{
            "title":"Lead Resource ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead resource.",
            "nullable":false,
            "x-queryable":false
        },
        "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.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"The name of the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceOrgId":{
            "title":"Resource Organization ID",
            "type":"integer",
            "description":"The unique identifier of the resource organization associated with this sales lead resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RoleName":{
            "title":"Role",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role of the sales lead resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Resource Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The contact number of the party associated with the lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales lead resource.",
            "nullable":false,
            "x-hints":{
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead resource.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The type of contact point used for updating underlying contact point TCA data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead sales team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead resource.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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."
        }
    }
}

リンク

AccessVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_ACCESS_LEVEL%2CBindLookupCode%3D{AccessLevelCode}

参照リソースは、標準参照コードの表示に使用されます。

HzLookupPVO1

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

トップに戻る

例:

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/MklLeadResources/300100092582212

レスポンス本文の例

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

{
  "LeadResourceId" : 300100092582212,
  "CreatedBy" : "MHoope",
  "CreationDate" : "2016-11-07T05:10:16-08:00",
  "LastUpdateDate" : "2016-11-07T05:10:24-08:00",
  "LastUpdatedBy" : "MHoope",
  "PrimaryFlag" : false,
  "FunctionalRole" : null,
  "ResourceId" : 300100031597528,
  "LeadId" : 300100092582093,
  "ResourceOrgId" : null,
  "EmailAddress" : "PLM_AUTO@oracle.com",
  "PartyName" : "AUTO PLM",
  "PrimaryPhonePurpose" : null,
  "RoleName" : null,
  "ManagerName" : null,
  "FormattedPhoneNumber" : null,
  "Name" : null,
  "PartyNumber" : "CDRM_70144",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582212",
    "name" : "MklLeadResources",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582212",
    "name" : "MklLeadResources",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100092582093",
    "name" : "leads",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadResources/300100092582212/lov/HzLookupPVO1",
    "name" : "HzLookupPVO1",
    "kind" : "Collection"
  } ]
}

「トップに戻る」