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

機械翻訳について

担当者の更新

patch

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}

リクエスト

パス・パラメータ

MemberId(required): integer(int64)

担当者の一意の識別子。
SrNumber(required): string

サービス・リクエストの識別に使用される一意の番号。サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AccessLevelCd: string

タイトル: Access Level

最大長: 30

担当者に付与されたサービス・リクエスト・アクセス・レベル。
ContactPartyName: string

タイトル: Name

最大長: 360

サービス・リクエスト担当者の名前。
ContactTypeCd: string

タイトル: Contact Type

最大長: 30

顧客やパートナなどのサービス・リクエスト担当者タイプ。
ContactUniqueName: string

タイトル: Unique Name

最大長: 900

担当者に関連付けられた一意のパーティ名。
MemberId: integer (int64)

タイトル: Member ID

担当者の一意の識別子。
PartyId: integer (int64)

タイトル: Party ID

担当者の一意のパーティ識別子。
PersonId: integer (int64)

タイトル: Person ID

サービスrequest.Thisの担当者である個人の一意の識別は、人事ヘルプ・デスクのサービス・リクエストにのみ使用されます。
PrimaryContactFlag: boolean

タイトル: Primary

担当者がサービス・リクエストのプライマリ担当者かどうかを示します。はいの場合、値はTrueで、そうでない場合はFalseです。デフォルト値はfalseです。
RelationTypeCd: string

タイトル: Relationship Type Code

最大長: 30

サービス・リクエストのコンテキストにおける担当者との関係のタイプを示すコード。たとえば、代替、フォロワ、Third_Partyなどです。

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : serviceRequests-contacts-item-response

タイプ: object

ソースを表示

AccessLevelCd: string

タイトル: Access Level

最大長: 30

担当者に付与されたサービス・リクエスト・アクセス・レベル。
AccountName: string

タイトル: Account Name

読取り専用: true

最大長: 900

サービス・リクエスト担当者のプライマリ取引先。
ContactEmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

担当者に関連付けられたパーティの電子メール・アドレス。
ContactFormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

担当者に関連付けられたパーティのフォーマット済電話番号。
ContactPartyName: string

タイトル: Name

最大長: 360

サービス・リクエスト担当者の名前。
ContactPartyNumber: string

タイトル: Contact Number

読取り専用: true

最大長: 30

サービス・リクエストに関連付けられている担当者の公開一意識別子。
ContactPreferredContactMethod: string

タイトル: Preferred Contact Method

読取り専用: true

最大長: 30

担当者に関連付けられたパーティの優先連絡メソッド。
ContactTypeCd: string

タイトル: Contact Type

最大長: 30

顧客やパートナなどのサービス・リクエスト担当者タイプ。
ContactUniqueName: string

タイトル: Unique Name

最大長: 900

担当者に関連付けられた一意のパーティ名。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Can Delete

読取り専用: true

担当者が削除されたかどうかを示します。
DoNotContactFlag: boolean

タイトル: Do Not Contact

読取り専用: true

最大長: 1

サービス・リクエストの担当者に連絡を希望しないかどうかを示します。デフォルト値はfalseです。
FormattedAddress: string

タイトル: Formatted Address

読取り専用: true

サービス・リクエスト担当者のフォーマット済み住所。
JobTitle: string

タイトル: Job Title

読取り専用: true

最大長: 100

サービス・リクエスト担当者の肩書。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

サービス・リクエストに関連付けられた担当者オブジェクトを最後に更新したユーザーのアプリケーション・ログインID。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MemberId: integer (int64)

タイトル: Member ID

担当者の一意の識別子。
PartyId: integer (int64)

タイトル: Party ID

担当者の一意のパーティ識別子。
PersonId: integer (int64)

タイトル: Person ID

サービスrequest.Thisの担当者である個人の一意の識別は、人事ヘルプ・デスクのサービス・リクエストにのみ使用されます。
PrimaryContactFlag: boolean

タイトル: Primary

担当者がサービス・リクエストのプライマリ担当者かどうかを示します。はいの場合、値はTrueで、そうでない場合はFalseです。デフォルト値はfalseです。
RelationTypeCd: string

タイトル: Relationship Type Code

最大長: 30

サービス・リクエストのコンテキストにおける担当者との関係のタイプを示すコード。たとえば、代替、フォロワ、Third_Partyなどです。
SrId: integer (int64)

タイトル: Service Request ID

関連付けられたサービス・リクエストの一意の識別子。
SrNumber: string

タイトル: Service Request Number

最大長: 30

サービス・リクエストの公開固有番号。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

担当者が更新されたかどうかを示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the contact has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            },
            "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
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"The formatted address of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactIdenAddrLocationId"
                ]
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the contact has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact of the service request does not want to be contacted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time 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 application login id of the user who last updated the contacts object associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":900,
            "type":"string",
            "description":"The primary account of the service request contact.",
            "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."
        }
    }
}

リンク

AccessLevelLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

サービス・リクエスト担当者のアクセス・レベルの値リスト。

ContactTypeLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

パートナや顧客などのサービス・リクエスト担当者タイプを示す値リスト。

PersonDVO

操作: /crmRestApi/resources/11.13.18.05/contacts

担当者パーティ名の値リスト。

RelationshipTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

代替、フォロワ、Third_Partyなどのサービス・リクエスト担当者関連タイプの値リスト。

トップに戻る

例:

次の例は、RESTリソースでPATCHリクエストを発行して担当者を更新する方法を示しています。

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

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

PATCH /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

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

{
"PartyId":" 300100075388631"
}

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

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

HTTP/1.1 200: OK
Date:  Mon, 15 Nov 2016 10:11:57 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

{
"MemberId": 300100090124783,
"SrId": 300100089812740,
"PartyId": 300100075388631,
"RelationTypeCd": null,
"ContactUniqueName": "autouislr1 svc",
"ContactFormattedPhoneNumber": null,
"ContactEmailAddress": "autouislr1@oracle.com",
"ContactPreferredContactMethod": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-10-18T07:42:37-07:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-15T02:10:00-08:00",
"LastUpdateLogin": "41438BCB97E343F5E0535CC0F20AC895",
"PrimaryContactFlag": false,
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783",
"name": "contacts",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783",
"name": "contacts",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001",
"name": "serviceRequests",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783/lov/PersonDVO",
"name": "PersonDVO",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002001/child/contacts/300100090124783/lov/RelationshipTypeLookup",
"name": "RelationshipTypeLookup",
"kind": "collection"
}
],
}

「トップに戻る」