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

機械翻訳について

リソース・メンバーの取得

get

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

リクエスト

パス・パラメータ

MemberId(required): integer(int64)

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

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

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

リソースをサービス・リクエストのメンバーとして追加したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

サービス・リクエスト・リソース・メンバーが作成された日時。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: 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

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

タイトル: Member ID

一意の識別子サービス・リクエスト・リソース・メンバー・レコード。
ObjectId: integer (int64)

タイトル: Service Request Team Member Resource ID

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

タイトル: Object Type

読取り専用: true

最大長: 30

デフォルト値: ORA_SVC_RESOURCE

リソースが個人かチームかを示すコード。受け入れられる値のリストは、参照ORA_SVC_RES_OBJECT_TYPE_CDで定義されます。
OwnerFlag: boolean

タイトル: Assigned To

サービス・リクエストがリソース・メンバーに割り当てられているかどうかを示します。はいの場合、値はTrueで、そうでない場合はFalseです。
PartyUniqueName: string

タイトル: Unique Party Name

読取り専用: true

最大長: 900

サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの一意の名前。
ResourceEmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

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

タイトル: Resource Formatted Address

読取り専用: true

サービス・リクエスト・リソース・メンバーのフォーマット済住所を示します。
ResourceFormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

リソース・メンバーの書式設定された電話番号。
ResourceName: string

タイトル: Name

最大長: 360

サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの名前。
ResourcePartyNumber: string

タイトル: Resource Number

読取り専用: true

最大長: 30

サービス・リクエスト・チーム・メンバーの公開一意識別子。
SrId: integer (int64)

タイトル: Service Request ID

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

タイトル: Service Request Number

最大長: 30

サービス・リクエスト番号の公開一意識別子。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

リソース・メンバーが更新されたかどうかを示します。
UserGUID: string

タイトル: User GUID

読取り専用: true

最大長: 64

サービス・リクエスト・リソース・メンバーとして追加されたリソースのグローバル一意識別子。
UserId: integer (int64)

タイトル: User ID

読取り専用: true

サービス・リクエスト・リソース・メンバーとして追加されたリソースのユーザー識別子。
Username: string

タイトル: User Name

読取り専用: true

最大長: 100

リソース・メンバーのユーザー名。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service request resource member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request 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 service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserGUID":{
            "title":"User GUID",
            "maxLength":64,
            "type":"string",
            "description":"A globally unique identifier of the resource added as the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the individual resource added as service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectId"
                ]
            }
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the individual resource added as service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceFormattedAddress":{
            "title":"Resource Formatted Address",
            "type":"string",
            "description":"Indicates the formatted address of the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceCountry",
                    "ResourceIdenAddrLocationId",
                    "ResourcePersonalAddressFlag"
                ]
            }
        },
        "ResourceEmailAddress":{
            "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
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the resource member has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier service request resource member record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the resource member has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"The user name of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"The user identifier of the resource added as the service request resource member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePersonalPhoneFlag",
                    "ResourcePrimaryPhoneAreaCode",
                    "ResourcePrimaryPhoneContactPtId",
                    "ResourcePrimaryPhoneCountryCode",
                    "ResourcePrimaryPhoneExtension",
                    "ResourcePrimaryPhoneLineType",
                    "ResourcePrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request team member.",
            "nullable":false,
            "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 service request that the resource is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the service request resource member 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 associated with the user who last updated the service request 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."
        }
    }
}

リンク

ObjectTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

個人やチームなどのリソース・オブジェクト・タイプを示す値リスト。

ResourcePickerPVO

操作: /crmRestApi/resources/11.13.18.05/resources

サービス・リクエスト・リソース・メンバー名の値リスト。

トップに戻る

例:

次の例は、RESTリソースに対するGETリクエストを発行して、特定のリソース・メンバーに関する情報を取得する方法を示しています。

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

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

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953

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

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

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

レスポンス本文の例

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

{
  "MemberId": 300100092156953,
  "SrId": 300100092156941,
  "ObjectTypeCd": "ORA_SVC_RESOURCE",
  "ObjectId": 100010032635399,
  "CreatedBy": "autouicsm1",
  "CreationDate": "2016-09-08T03:57:28-07:00",
  "LastUpdatedBy": "autouicsm1",
  "LastUpdateDate": "2016-09-08T03:58:25-07:00",
  "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
  "ResourceName": "Dan Foreman",
  "PartyUniqueName": "Dan Foreman",
  "ResourceEmailAddress": "sendmail-test-discard@oracle.com",
  "ResourceFormattedPhoneNumber": "+1 (415) 820-3815",
  "UserGUID": "331DF0E7846E4318E2B2399766991627",
  "UserId": 100010032635372,
  "Username": "SALES_REPRESENTATIVE",
  "OwnerFlag": true,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953",
      "name": "resourceMembers",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953",
      "name": "resourceMembers",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002",
      "name": "serviceRequests",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ResourcePickerPVO",
      "name": "ResourcePickerPVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ObjectTypeLookup",
      "name": "ObjectTypeLookup",
      "kind": "collection"
    }
  ]
}

「トップに戻る」