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

機械翻訳について

提案の更新

patch

/crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}

リクエスト

パス・パラメータ

TerrProposalId(required): integer(int64)

提案の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

ActFailureReasonCode: string

タイトル: Failure Reason Code

最大長: 60

提案のアクティブ化に失敗した理由を示すコード。
ActivationDateTime: string (date-time)

提案がアクティブ化された日付。
Description: string

タイトル: Description

最大長: 240

提案とその目的の変更に関する簡単な説明。
Name: string

タイトル: Name

最大長: 60

提案の名前。
OwnerId: integer (int64)

タイトル: Owner ID

提案を開始したリソースの一意の識別子で、通常はテリトリの所有者です。
PartitionCode: string

タイトル: Partition Type

最大長: 30

デフォルト値: PRODUCTION

提案がステージ・パーティションまたは本番パーティションのどちらにあるかを記録することによって、ディメンションによって無効になったテリトリまたはメンバー変更のエラー修正提案であるかどうかを示すコード。デフォルト値はPRODUCTIONです。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: DRAFT

提案のステータスを示すコード。たとえば、DRAFTやPENDING ACTIVATIONなどです。

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the proposal and its intended changes.",
            "nullable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the resource who initiated the proposal, typically the owner of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivationDateTime":{
            "type":"string",
            "description":"The date when the proposal is activated.",
            "format":"date-time",
            "nullable":true
        },
        "PartitionCode":{
            "title":"Partition Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether or not the proposal is an error correction proposal for territories that were made invalid by dimension, or member changes, by recording whether the proposal is in the Stage or Production partition. The default value is PRODUCTION.",
            "nullable":false,
            "default":"PRODUCTION"
        },
        "ActFailureReasonCode":{
            "title":"Failure Reason Code",
            "maxLength":60,
            "type":"string",
            "description":"The code indicating the reason for failure of the proposal activation.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the proposal.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

ActFailureReasonCode: string

タイトル: Failure Reason Code

最大長: 60

提案のアクティブ化に失敗した理由を示すコード。
ActivationDateTime: string (date-time)

提案がアクティブ化された日付。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DeleteFlag: boolean

読取り専用: true

提案を削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 240

提案とその目的の変更に関する簡単な説明。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Name

最大長: 60

提案の名前。
Owner: string

タイトル: Owner

読取り専用: true

最大長: 360

提案の開始者の表示名。
OwnerId: integer (int64)

タイトル: Owner ID

提案を開始したリソースの一意の識別子で、通常はテリトリの所有者です。
OwnerNumber: string

タイトル: Owner Registry ID

読取り専用: true

最大長: 30

所有者の番号。
PartitionCode: string

タイトル: Partition Type

最大長: 30

デフォルト値: PRODUCTION

提案がステージ・パーティションまたは本番パーティションのどちらにあるかを記録することによって、ディメンションによって無効になったテリトリまたはメンバー変更のエラー修正提案であるかどうかを示すコード。デフォルト値はPRODUCTIONです。
ProposalNumber: string

タイトル: Proposal Number

最大長: 30

提案の代替キー識別子。
StatusCode: string

タイトル: Status

最大長: 30

デフォルト値: DRAFT

提案のステータスを示すコード。たとえば、DRAFTやPENDING ACTIVATIONなどです。
TerrProposalId: integer (int64)

タイトル: Territory Proposal ID

提案の一意の識別子。
UpdateFlag: boolean

読取り専用: true

提案を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The display name for the initiator of the proposal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the proposal and its intended changes.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerNumber":{
            "title":"Owner Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The number of the owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivationDateTime":{
            "type":"string",
            "description":"The date when the proposal is activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the proposal. For example, DRAFT or PENDING ACTIVATION.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the proposal.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether a proposal can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the resource who initiated the proposal, typically the owner of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartitionCode":{
            "title":"Partition Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether or not the proposal is an error correction proposal for territories that were made invalid by dimension, or member changes, by recording whether the proposal is in the Stage or Production partition. The default value is PRODUCTION.",
            "nullable":false,
            "default":"PRODUCTION",
            "x-queryable":true
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the proposal.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActFailureReasonCode":{
            "title":"Failure Reason Code",
            "maxLength":60,
            "type":"string",
            "description":"The code indicating the reason for failure of the proposal activation.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The unique identifier of the proposal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して提案を更新する方法を示しています。

cURLコマンド

curl -v -u sales_cloud_user -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X PATCH "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294"  -d '{request_payload}'

リクエスト本文の例

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

{
"StatusCode":"PENDING ACTIVATION"
}

レスポンス本文の例

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

{
"TerrProposalId": 300100129032294,
"Name": "Rest Proposals",
"Description": null,
"StatusCode": "PENDING ACTIVATION",
"OwnerId": 100010025532672,
"Owner": "Gabrielle Lee",
"PartitionCode": "PRODUCTION",
"ActFailureReasonCode": null,
"ProposalNumber": "CDRM_274065",
"ActivationDateTime": "2016-12-10T23:00:00-08:00",
"UpdateFlag": true,
"DeleteFlag": true,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/proposals/300100129032294/lov/ValidStatusCodeViewAccessor",???}
]
}

「トップに戻る」