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

機械翻訳について

サービス・リクエスト参照の取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}

リクエスト

パス・パラメータ

ReferenceId(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-srReferences-item-response

タイプ: object

ソースを表示

ArticleId: string

タイトル: Article ID

最大長: 64

Oracle Knowledge Cloud Serviceの記事の一意の識別子。
ArticleLocale: string

タイトル: Article Locale

最大長: 10

ドキュメントのロケール(en_USなど)。この属性は、ArticleIdが移入されている場合にのみ有効です。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

サービス・リクエスト参照を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

サービス・リクエスト参照が作成された日時。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

参照が削除されたかどうかを示します。
DocumentId: string

タイトル: Document ID

読取り専用: true

最大長: 50

参照された記事に関連付けられたドキュメントの識別子。
HelpfulFlag: boolean

タイトル: Helpful

最大長: 1

サービス・リクエスト参照が役に立ったかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

サービス・リクエスト参照が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

サービス・リクエスト参照を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

サービス・リクエスト参照を最後に更新したユーザーのログインID。
LinkedFlag: boolean

タイトル: Linked

最大長: 1

参照がサービス・リクエストにリンクされているかどうかを示します。
links: array Links

タイトル: Links

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

タイトル: Object ID

サービス・リクエスト(SR)を参照するオブジェクト、またはSRによって参照されるオブジェクトの一意の識別子(ノート、欠陥、別のSRなど)。
ObjectTypeCd: string

タイトル: Object Type

最大長: 30

サービス・リクエスト参照が関連付けられているオブジェクトのタイプを示すコード(ノート、記事、欠陥、その他のSRなど)。受け入れられる値のリストは、参照ORA_SVC_SR_REF_OBJECT_TYPE_CDで定義されます。
ReferenceId: integer (int64)

タイトル: Reference ID

読取り専用: true

サービス・リクエスト参照レコードの一意の識別子。
RelationTypeCd: string

タイトル: Relation Type

最大長: 30

関係のタイプ。
ResolutionCd: string

タイトル: Resolution Code

最大長: 30

サービス・リクエストの解決コードを示すコード。たとえば、満足度、Not_Satisfied、Returned_Product、New_Purchase、不明などです。受け入れられる値のリストは、参照ORA_SVC_SR_RESOLUTION_CDで定義されます。
SharedFlag: boolean

タイトル: Shared

最大長: 1

サービス・リクエスト参照が顧客と共有されるかどうかを示します。
SrId: integer (int64)

タイトル: Service Request ID

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

タイトル: Service Request Number

最大長: 30

サービス・リクエストの公開一意識別子。
Subject: string

タイトル: Title

最大長: 1000

記事のタイトル。この属性は、ArticleIdが移入されている場合にのみ有効です。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

参照が更新されたかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service request reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedFlag":{
            "title":"Shared",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference is shared with the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request 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 service request reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationTypeCd":{
            "title":"Relation Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the document associated with the referenced article.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HelpfulFlag":{
            "title":"Helpful",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request reference was helpful.",
            "nullable":true,
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the reference has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Subject":{
            "title":"Title",
            "maxLength":1000,
            "type":"string",
            "description":"The title of the article. This attribute is valid only when ArticleId is populated.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the reference has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LinkedFlag":{
            "title":"Linked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the reference is linked with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the service request reference record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArticleLocale":{
            "title":"Article Locale",
            "maxLength":10,
            "type":"string",
            "description":"The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArticleId":{
            "title":"Article ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Oracle Knowledge Cloud Service article.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCd":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request to which the reference is associated.",
            "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 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 login ID of the user who last updated the service request 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."
        }
    }
}

リンク

ResolutionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

サービス・リクエスト解決コードの値リスト。たとえば、満足度、Not_Satisfied、Returned_Product、New_Purchase、不明などです。

トップに戻る

例:

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

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

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

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/srReferences/300100090543767 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

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

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

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

レスポンス本文の例

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

{
"ReferenceId": 300100090543767,
"CreationDate": "2016-11-15T06:35:44-08:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-15T06:35:44-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "41438BCB97E343F5E0535CC0F20AC895",
"SrId": 300100090532774,
"ObjectId": null,
"ArticleId": "21",
"ObjectTypeCd": "ORA_SVC_ARTICLE",
"RelationTypeCd": "SR",
"Subject": "Testing",
"ArticleLocale": "en_US",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/srReferences/300100090543767",
"name": "srReferences",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/srReferences/300100090543767",
"name": "srReferences",
"kind": "item"
},
  {
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002",
"name": "serviceRequests",
"kind": "item"
}
],
}

「トップに戻る」