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

機械翻訳について

インバウンド・メッセージ・フィルタの取得

get

/crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}

リクエスト

パス・パラメータ

FilterId(required): integer(int64)

インバウンド・メッセージ・フィルタの一意の識別子。

問合せパラメータ

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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ActionCd: string

タイトル: Action Code

最大長: 30

受入または拒否処理がフィルタに適用されているかどうかを示すコード。受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_ACTION_TYPEで定義されます。
ActionCdMeaning: string

タイトル: Action Value

最大長: 255

インバウンドEメール・フィルタの処理参照コードに対応する表示値を示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

インバウンド・メッセージ・フィルタを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

インバウンド・メッセージ・フィルタが作成された日付。
CustomFilterFlag: boolean

タイトル: User-Defined Filter

最大長: 1

デフォルト値: false

フィルタがユーザー定義かどうかを示します。
DeletedFlag: boolean

タイトル: Deleted

最大長: 1

デフォルト値: false

フィルタが削除されたかどうかを示します。デフォルト値はfalseです。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

インバウンド・メッセージ・フィルタを削除できるかどうかを示します。デフォルト値はfalseです。
Description: string

タイトル: Description

最大長: 400

フィルタの説明。
FieldName: string

タイトル: Field Name

最大長: 64

フィルタが適用されるフィールドの名前。
FilterId: integer (int64)

タイトル: Filter ID

インバウンド・メッセージ・フィルタの一意の識別子。
FilterTypeCd: string

タイトル: Filter Type Code

最大長: 30

フィルタのタイプを示すコード。受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_FIELD_TYPEで定義されます。
FilterTypeCdMeaning: string

タイトル: Filter Type Value

最大長: 255

インバウンドEメール・フィルタのフィルタ・タイプ参照コードに対応する表示値を示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

インバウンド・メッセージ・フィルタが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

インバウンド・メッセージ・フィルタを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Order Number

フィルタを適用する順序。複数のフィルタがある場合にのみ有効です。
Pattern: string

タイトル: Pattern

最大長: 400

フィルタのパターン値。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

インバウンド・メッセージ・フィルタを更新できるかどうかを示します。デフォルト値はfalseです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inbound message filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomFilterFlag":{
            "title":"User-Defined Filter",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the filter is user defined.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "FilterTypeCd"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message filter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":400,
            "type":"string",
            "description":"The pattern value of the filter.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterTypeCd":{
            "title":"Filter Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the filter. A list of accepted values is defined in the lookup ORA_SVC_INBND_FLTR_FIELD_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The description of the filter.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterTypeCdMeaning":{
            "title":"Filter Type Value",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the display value corresponding to the filter type lookup code for the inbound email filters.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FilterTypeCd"
                ]
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"integer",
            "description":"The order in which the filters must be applied. Valid only if there are more than one filters.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FilterId":{
            "title":"Filter ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message filter.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the inbound message filter can be deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate"
            }
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message filter can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate"
            }
        },
        "ActionCd":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating if an Accept or a Reject action is applied on the filter. A list of accepted values is defined in the lookup ORA_SVC_INBND_FLTR_ACTION_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionCdMeaning":{
            "title":"Action Value",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the display value corresponding to the action lookup code for the inbound email filters.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionCd"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the filter is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the field on which the filter is to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message filter 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."
        }
    }
}

リンク

ActionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ActionCd;ターゲット属性: LookupCode
表示属性: 意味

FilterTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: FilterTypeCd;ターゲット属性: LookupCode
表示属性: 意味

YesNoLookupPVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

インバウンド・メッセージ・フィルタが削除されたかどうかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: DeletedFlag;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

特定のインバウンド・メッセージ・フィルタの詳細を取得するには、次のURI構文でGETを使用します:

リクエストURIの例

次に、リクエストURLの例を示します。

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107

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

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

GET /crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107 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, 18 Jan 2017 08:50:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

Content type:
{
"FilterId": 300100091717107,
"FilterTypeCd": "ORA_SVC_MIME",
"FieldName": "MIMEAttachment",
"Pattern": "application/pdf",
"OrderNumber": 300100091712547,
"Description": "Automation Filter. DO NOT EDIT OR CHANGE THE ORDER",
"CustomFilterFlag": true,
"DeletedFlag": false,
"CreationDate": "2016-10-20T03:05:11-07:00",
"CreatedBy": "xInboundEmailUI1",
"LastUpdateDate": "2016-11-22T14:30:01-08:00",
"LastUpdatedBy": "MHoope",
"ActionCd": "ORA_SVC_REJECT",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107",
"name": "inboundMsgFilters",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000778"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107",
"name": "inboundMsgFilters",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/ActionCdLookupPVO",
"name": "ActionCdLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/YesNoLookupPVO",
"name": "YesNoLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/FilterTypeLookupPVO",
"name": "FilterTypeLookupPVO",
"kind": "collection"
}
],
}

「トップに戻る」