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

機械翻訳について

パートナの地理の作成

post

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies

リクエスト

パス・パラメータ

CompanyNumber(required): string

パートナの会社の代替キー識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

GeographyId: string

最大長: 30

サービスされる地理の一意の識別子。
GeographyName: string

タイトル: Geography Served

最大長: 360

サービスされる地理の名前。
OwnerId: integer (int64)

ディメンション・データとの関係を所有するエンティティの識別子。たとえば、パートナ・プロファイル、パートナ・プログラムまたは登録です。
PartnerDimMembersId: integer (int64)

タイトル: Geography ID

パートナ地理の一意の識別子。

{
    "type":"object",
    "properties":{
        "GeographyName":{
            "title":"Geography Served",
            "maxLength":360,
            "type":"string",
            "description":"The name of the geography being served.",
            "nullable":false
        },
        "GeographyId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the geography being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerDimMembersId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier for the partner geography .",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partners-geographies-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

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

タイトル: Name

読取り専用: true

最大長: 360

サービスされる地理の名前。
GeographyId: string

最大長: 30

サービスされる地理の一意の識別子。
GeographyName: string

タイトル: Geography Served

最大長: 360

サービスされる地理の名前。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

ディメンション・データとの関係を所有するエンティティの識別子。たとえば、パートナ・プロファイル、パートナ・プログラムまたは登録です。
PartnerDimMembersId: integer (int64)

タイトル: Geography ID

パートナ地理の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the geography served.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the geography being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography Served",
            "maxLength":360,
            "type":"string",
            "description":"The name of the geography being served.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartnerDimMembersId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier for the partner geography .",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "nullable":true,
            "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"
    }
}

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

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

リンク

AllGeographyLookup: 操作: /crmRestApi/resources/11.13.18.05/geographiesLOV

地理値リスト・リソースは、地理のリストを表示するために使用されます。

トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行して、パートナの地理を作成する方法を示しています。

curl -u <username:password> \ -X POST -d @example_request_payload.json
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/100001/child/geographies

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
  "GeographyName" : "North American Sales"
}

レスポンス本文の例

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

{
  "items" : [ {
    "PartnerDimMembersId" : 100000020252075,
    "OwnerId" : 100000016934002,
    "OwnerType" : "PARTNER_PROFILE",
    "PartitionTypeCode" : "PRODUCTION",
    "DimensionCode" : "Geo",
    "IntegrationId" : "999984000000017",
    "DimSubtypeCode" : null,
    "DimensionMemberName" : "North American Sales",
    "DimensionMemberNameBackup" : "North American Sales",
    "ObjectVersionNumber" : 1,
    "TerrDimMemberId" : 300100102420297,
    "TypeCode" : "PRODUCTION",
    "TerrDimPartitionId" : 300100102420155,
    "GeographyId" : "999984000000017",
    "GeographyName" : "North American Sales",
    ...
}

「トップに戻る」