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

機械翻訳について

パートナ層の作成

post

/crmRestApi/resources/11.13.18.05/partnerTiers

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

Description: string

最大長: 1000

パートナ階層を説明するテキスト。
Name: string

タイトル: Name

最大長: 155

パートナ階層の名前。
TierId: integer (int64)

パートナ階層のシステム生成の一意の識別子および主キー。

{
    "type":"object",
    "properties":{
        "TierId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the partner tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the partner tier.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner tier.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partnerTiers-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

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

読取り専用: true

パートナ階層を削除する必要があるかどうかを示します。値がYの場合、パートナ階層を削除できます。デフォルト値は「Y」です。
Description: string

最大長: 1000

パートナ階層を説明するテキスト。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

パートナ階層を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 155

パートナ階層の名前。
ランキング: 整数(int32)

タイトル: Rank

読取り専用: true

階層ランキング。1は最上位階層を表します。
TierId: integer (int64)

パートナ階層のシステム生成の一意の識別子および主キー。
UpdateFlag: boolean

読取り専用: true

パートナ階層を更新できるかどうかを示します。値がYの場合、階層を更新できます。デフォルト値は「Y」です。

{
    "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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the partner tier can be updated. If the value is Y, then the tier can be updated. The default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Ranking":{
            "title":"Rank",
            "type":"integer",
            "description":"The tier ranking, where 1 represents the top tier.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the partner tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the partner tier.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the partner tier should be deleted. If the value is Y, then the partner tier can be deleted. The default value is Y.",
            "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
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the partner tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner tier.",
            "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."
        }
    }
}

リンク

delete

操作: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/delete

パラメータ:

TierId: $request.path.TierId

製品階層とその階層を削除します。

moveDown

操作: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/moveDown

パラメータ:

TierId: $request.path.TierId

パートナ層を下に1レベル下に移動します。

moveUp

操作: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/moveUp

パラメータ:

TierId: $request.path.TierId

パートナ階層を1レベル下ランキングで上に移動します。

トップに戻る

例:

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

cURLコマンド

curl -v -u Username:Password -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X POST "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerTiers" -d '{request_payload}'

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{     
  "Name":"Gold Tier"
}

レスポンス本文の例

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

{
  "TierId" : 300100071293753,
  "Name" : "Gold Tier",
  "Description" : null,
  "Ranking" : 1,
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T12:00:01-08:00",
  "LastUpdateDate" : "2016-02-17T12:00:01-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "DeleteFlag" : "true",
  "UpdateFlag" : "true",

  ...
}

「トップに戻る」