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

機械翻訳について

パートナ・タイプの作成

post

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

リクエスト

パス・パラメータ

CompanyNumber(required): string

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

DimSubtypeCode: string

最大長: 30

ディメンション・コード内の特定タイプのアイテムを示すコード。たとえば、製品ディメンションには、製品アイテムと製品カテゴリがあります。
IntegrationId: string

最大長: 80

統合目的で使用される一意の識別子。
PartnerCompanyNumber: string

タイトル: Partner Number

最大長: 30

パートナ会社の一意の識別子。
PartnerDimMembersId: integer (int64)

パートナ・タイプの一意の識別子。
PartnerTypeCode: string

タイトル: Partner Type

最大長: 30

パートナ・タイプを示すコード。たとえば、CCPやESPなどです。
PartnerTypeName: string

タイトル: Type

最大長: 360

パートナ・タイプの名前(付加価値再販業者など)。

{
    "type":"object",
    "properties":{
        "PartnerTypeCode":{
            "title":"Partner Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the partner type. For example, CCP, or ESP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DimSubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating a specific type of item within the dimension code. For example, for the products dimension there could be product items and product categories.",
            "nullable":true,
            "x-queryable":false
        },
        "IntegrationId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier used for integration purposes.",
            "nullable":false,
            "x-queryable":false
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false
        },
        "PartnerDimMembersId":{
            "type":"integer",
            "description":"The unique identifier for the partner type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartnerTypeName":{
            "title":"Type",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner type, such as Value Added Reseller.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

レコードが作成された日時。
DimSubtypeCode: string

最大長: 30

ディメンション・コード内の特定タイプのアイテムを示すコード。たとえば、製品ディメンションには、製品アイテムと製品カテゴリがあります。
IntegrationId: string

最大長: 80

統合目的で使用される一意の識別子。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Partner Number

最大長: 30

パートナ会社の一意の識別子。
PartnerDimMembersId: integer (int64)

パートナ・タイプの一意の識別子。
PartnerTypeCode: string

タイトル: Partner Type

最大長: 30

パートナ・タイプを示すコード。たとえば、CCPやESPなどです。
PartnerTypeName: string

タイトル: Type

最大長: 360

パートナ・タイプの名前(付加価値再販業者など)。

{
    "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 and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerTypeCode":{
            "title":"Partner Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the partner type. For example, CCP, or ESP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimSubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating a specific type of item within the dimension code. For example, for the products dimension there could be product items and product categories.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntegrationId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier used for integration purposes.",
            "nullable":false,
            "x-queryable":false
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerDimMembersId":{
            "type":"integer",
            "description":"The unique identifier for the partner type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerTypeName":{
            "title":"Type",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner type, such as Value Added Reseller.",
            "nullable":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"
    }
}

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

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

リンク

PartnerTypesLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_CHANNEL_TYPES

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

トップに戻る

例:

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/types

リクエスト本文の例

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

{
   "PartnerTypeName" : "Global Finance"
}

レスポンス本文の例

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

{
  "PartnerDimMembersId" : 100000020252075,
  "OwnerId" : 300100031646292,
  "OwnerType" : "PARTNER_PROFILE",
  "PartitionTypeCode" : "PRODUCTION",
  "DimensionCode" : "Prod",
  "IntegrationId" : "999997500685865",
  "AttributePk1" : "PROD_777",
  "DimSubtypeCode" : "Prod",
  "DimensionMemberName" : "Sales for Handhelds",
  "DimensionMemberNameBackup" : "Global Sales",
  "ObjectVersionNumber" : 2,
  "TerrDimMemberId" : 300100100988774,
  "TypeCode" : "BACKUP_P_1432705142118",
  "TerrDimPartitionId" : 300100100983327,
  "PartnerTypeCode" : null,
  "PartnerTypeName" : "Global Finance",
  ...
}

「トップに戻る」