機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

顧客対応参照の作成

post

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences

リクエスト

パス・パラメータ

• InteractionId(required): integer(int64)
  顧客対応の一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• InteractionId: integer (int64)
  タイトル: Interaction ID

  顧客対応参照の一意の識別子。
• InteractionNumber: string
  タイトル: Interaction Number

  最大長: 30

  顧客対応の代替キー識別子。
• ObjectId: integer (int64)
  タイトル: Object ID

  顧客対応参照に関連付けられたオブジェクトの一意の識別子。
• ObjectTypeCd: string
  タイトル: Object Type

  最大長: 30

  顧客対応参照に存在するオブジェクトのタイプを示すコード。 有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。

{
    "type":"object",
    "properties":{
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : interactions-interactionReferences-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  参照を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  参照が作成された日時。
• DeleteFlag: boolean
  読取り専用: true

  顧客対応参照を現在のユーザーが削除できるかどうかを示します。 デフォルト値はfalseです。
• InteractionId: integer (int64)
  タイトル: Interaction ID

  顧客対応参照の一意の識別子。
• InteractionNumber: string
  タイトル: Interaction Number

  最大長: 30

  顧客対応の代替キー識別子。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectId: integer (int64)
  タイトル: Object ID

  顧客対応参照に関連付けられたオブジェクトの一意の識別子。
• ObjectNumber: string
  タイトル: Reference Number

  読取り専用: true

  最大長: 255

  顧客対応参照に関連付けられたオブジェクトの代替キー識別子。
• ObjectTypeCd: string
  タイトル: Object Type

  最大長: 30

  顧客対応参照に存在するオブジェクトのタイプを示すコード。 有効な値のリストは、参照ORA_SVC_IM_REF_OBJECT_TYPE_CDで定義されます。
• ReferenceId: integer (int64)
  タイトル: Reference ID

  読取り専用: true

  外部システムとの統合に使用される一意の識別子。
• UpdateFlag: boolean
  読取り専用: true

  顧客対応参照を現在のユーザーが更新できるかどうかを示します。 ユーザーが顧客対応参照を更新するアクセス権を持っている場合、デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Reference Number",
            "maxLength":255,
            "type":"string",
            "description":"The alternate key identifier of the object associated with the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier used for integration with external systems.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the reference.",
            "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."
        }
    }
}

リンク

ObjectTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_IM_REF_OBJECT_TYPE_CD

オブジェクト・タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ObjectTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

トップに戻る

例:

次の例は、RESTリソースに対してPOSTリクエストを発行して相互作用参照を作成する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

POST /crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 201: Created
Date: Fri, 03 Mar 2017 07:54:53 GMT
Server : Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourcecollection+json
Content-Language: en

リクエスト本文の例

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

{
"ObjectTypeCd": "SVC_SERVICE_REQUESTS",
"ObjectId": "30001233322"
}

応答本文の例

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

{
  "ReferenceId" : 300100097921285,
  "InteractionId" : 300100096307925,
  "ObjectTypeCd" : "SVC_SERVICE_REQUESTS",
  "ObjectId" : 30001233322,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2017-03-10T00:31:09-08:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "LastUpdateDate" : "2017-03-10T00:31:09-08:00",
  "LastUpdateLogin" : "4A49E601416B05A8E05307B3F20A1B38",
  "UpdateFlag" : "true",
  "DeleteFlag" : "true",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285",
    "name" : "interactionReferences",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences/300100097921285",
    "name" : "interactionReferences",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
    "name" : "interactions",
    "kind" : "item"
  } ]
}

「トップに戻る」