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

機械翻訳について

動的リンク・パターンの更新

patch

/crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/{ObjectId}

リクエスト

パス・パラメータ

ObjectId(required): integer(int64)

パターンの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

Label: string

最大長: 1024

サービス・リクエスト、ナレッジ記事など、オブジェクト・タイプの表示ラベル。
ObjectType: string

タイトル: Object Type

最大長: 30

サービス・リクエスト、ナレッジ記事など、オブジェクトのタイプ。
ObjectVersionNumber: 整数(int32)

表行の内部一意識別子。
Pattern: string

タイトル: Pattern

最大長: 1024

メッセージ・コンテンツ内のオブジェクトの検索に使用される正規表現。
PatternPrefix: string

タイトル: Pattern Beginning

最大長: 512

パターンのプレフィクス。実際のオブジェクト識別子の前の情報。
PatternSuffix: string

タイトル: Pattern Ending

最大長: 512

パターンのサフィクス。実際のオブジェクト識別子のあとの情報。

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object, such as Service Request, Knowledge Article, etc.",
            "nullable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":1024,
            "type":"string",
            "description":"The regular expression used for searching the object in the message content.",
            "nullable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "maxLength":512,
            "type":"string",
            "description":"The suffix of the pattern, the information after the actual object identifier.",
            "nullable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "maxLength":512,
            "type":"string",
            "description":"The prefix of the pattern, the information before the actual object identifier.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The internal unique identifier of the table row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Label":{
            "maxLength":1024,
            "type":"string",
            "description":"The display label for the object type, such as Service Request, Knowledge Article, etc.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : dynamicLinkPatterns-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

パターンを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

パターンが作成された日付。
Label: string

最大長: 1024

サービス・リクエスト、ナレッジ記事など、オブジェクト・タイプの表示ラベル。
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

読取り専用: true

パターンの一意の識別子。
ObjectType: string

タイトル: Object Type

最大長: 30

サービス・リクエスト、ナレッジ記事など、オブジェクトのタイプ。
ObjectVersionNumber: 整数(int32)

表行の内部一意識別子。
Pattern: string

タイトル: Pattern

最大長: 1024

メッセージ・コンテンツ内のオブジェクトの検索に使用される正規表現。
PatternPrefix: string

タイトル: Pattern Beginning

最大長: 512

パターンのプレフィクス。実際のオブジェクト識別子の前の情報。
PatternSuffix: string

タイトル: Pattern Ending

最大長: 512

パターンのサフィクス。実際のオブジェクト識別子のあとの情報。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the pattern was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":1024,
            "type":"string",
            "description":"The regular expression used for searching the object in the message content.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "maxLength":512,
            "type":"string",
            "description":"The suffix of the pattern, the information after the actual object identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the pattern.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Label":{
            "maxLength":1024,
            "type":"string",
            "description":"The display label for the object type, such as Service Request, Knowledge Article, etc.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object, such as Service Request, Knowledge Article, etc.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "maxLength":512,
            "type":"string",
            "description":"The prefix of the pattern, the information before the actual object identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The internal unique identifier of the table row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the pattern was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、動的リンク・パターンを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/1

リクエスト本文の例

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

{
"ObjectType": "SERVICE_REQUEST_CRM"
}

レスポンス本文の例

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

{
    "ObjectId": 2,
    "ObjectVersionNumber": 2,
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2018-08-18T04:14:01+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "7572459B45477E7DE0538E09F20A8E5D",
    "LastUpdateDate": "2018-09-11T09:15:17+00:00",
    "ObjectType": "SERVICE_REQUEST_CRM",
    "Pattern": "(?i)\\b(SR)([0-9]{10})\\b",
    "PatternPrefix": null,
    "PatternSuffix": null,
    "Label": null,
    "links": [
		...
		]
}

「トップに戻る」