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

機械翻訳について

リソース・メンバーの更新

patch

/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}

リクエスト

パス・パラメータ

QueueId(required): integer(int64)

キューの一意の識別子。
QueueResourceId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

キュー・リソース・メンバーが有効かどうかを示します。有効な場合、値はtrueで、それ以外の場合はfalseです。デフォルト値はtrueです。
QueueResourceId: integer (int64)

タイトル: Queue Resource ID

キュー・リソース・メンバーの一意の識別子。

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the queue resource member is enabled.  If enabled, the value is true, else the value is false. The default value is true.",
            "nullable":false,
            "default":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the queue resource member.",
            "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のデフォルト・バージョンを選択します。

ルート・スキーマ : queues-resourceMembers-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

リソースをキューのメンバーとして追加したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キュー・リソース・メンバーが作成された日時。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

リソース・メンバーを削除できるかどうかを示します。デフォルト値はtrueです。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

リソース・メンバーの電子メール・アドレス。
EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

キュー・リソース・メンバーが有効かどうかを示します。有効な場合、値はtrueで、それ以外の場合はfalseです。デフォルト値はtrueです。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

キュー・リソース・メンバーの書式設定された電話番号。
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)

タイトル: Resource Member ID

キュー・リソース・メンバーとして追加された個々のリソースの一意の識別子。
ObjectTypeCd: string

タイトル: Queue ResourceType

読取り専用: true

最大長: 30

デフォルト値: ORA_SVC_RESOURCE

リソースが個人かチームかを示すコード。
PartyId: integer (int64)

読取り専用: true

キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の識別子。
PartyName: string

タイトル: Name

読取り専用: true

最大長: 360

キュー・リソース・メンバーの名前。
PartyNumber: string

読取り専用: true

最大長: 30

キュー・リソース・メンバーに関連付けられたパーティ・レコードの公開一意識別子。
PartyUniqueName: string

タイトル: Name

読取り専用: true

最大長: 900

キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の名前。
QueueId: integer (int64)

タイトル: Queue ID

キューの一意の識別子。
QueueName: string

タイトル: Queue Name

読取り専用: true

最大長: 400

このリソースが関連付けられているキューの名前。
QueueNumber: string

タイトル: Queue Number

読取り専用: true

最大長: 30

このリソースが関連付けられているキューの公開一意識別子。
QueueResourceId: integer (int64)

タイトル: Queue Resource ID

キュー・リソース・メンバーの一意の識別子。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

リソース・メンバーを更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the queue resource member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the resource as a member of the queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Resource Member ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as queue resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the party record associated with the queue resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the resource member can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the party record associated with the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the resource member can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the queue to which this resource is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party record associated with the queue resource member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Queue ResourceType",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the resource is an individual or a team.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-queryable":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the queue resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the queue resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the queue resource member is enabled.  If enabled, the value is true, else the value is false. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the queue to which this resource is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the queue resource member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login associated with the user who last updated the queue resource member.",
            "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."
        }
    }
}

リンク

ObjectTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_Q_RES_OBJ_TYPE_CD

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

トップに戻る

例:

次の例は、RESTリソースに対してPATCHリクエストを発行してリソース・メンバーを更新する方法を示しています。

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

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

PATCH /crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

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

{
"EnabledFlag": false
}

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

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

HTTP/1.1 200: OK
Date: Wed, 05 Oct 2016 07:20:55 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

{
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-09-08T04:36:54-07:00"
"EnabledFlag": false
"LastUpdateDate": "2016-09-08T04:36:54-07:00"
"LastUpdateLogin": "3BE5E4712BA78A8EE053780CF10A753D"
"LastUpdatedBy": "SALES_ADMIN"
"ObjectId": 100010032752719
"ObjectTypeCd": "ORA_SVC_RESOURCE"
"QueueId": 300100089889772
"QueueResourceId": 300100092156968
"EmailAddress": "edwin.mitchell@us2.oraclecloud.com"
"PartyId": 100010032752719
"PartyName": "Mitchell,Edwin"
"PartyNumber": "100010032752719"
"FormattedPhoneNumber": null
"PartyUniqueName": null
"links": 
[
4]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719"
"name": "resourceMembers"
"kind": "item"
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
-
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719"
"name": "resourceMembers"
"kind": "item"
}
-
2:  
{
"rel": "parent"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772"
"name": "queues"
"kind": "item"
}
-
3:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719/lov/ObjectTypeCdLookup"
"name": "ObjectTypeCdLookup"
"kind": "collection"
}
-
-
}

「トップに戻る」