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

機械翻訳について

すべてのコラボレーション受信者の取得

get

/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups

リクエスト

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定した主キーを持つコラボレーション・リソースを検索します。
  ファインダ変数:
  - ResourceId; integer; 1つのコラボレーション・リソースの詳細を取得するために使用される主キー識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

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

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

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

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AlternateGroupId; string;リソースが属するコラボレーション・ネットワーク・チームまたはグループの代替識別子。
- ChannelId; string;コラボレーション・ネットワーク・ワークスペースに関連付けられているCX Salesチャネルの識別子。
- CollabGroupId; string;リソースが属するコラボレーション・ネットワーク・チームまたはグループの識別子。
- CollabGroupName; string;リソースが属するコラボレーション・ネットワーク・チームまたはグループの名前。
- CollabId; string;コラボレーション・ネットワーク内のコラボレーション・リソースの識別子。
- DisplayName; string;コラボレーション・リソースの表示名。
- 名前;文字列;コラボレーション・リソースの名前。
- ResourceId; integer;コラボレーション・リソースの一意の識別子。
- ResourceType; string;ユーザー、チャネル、プライベート・チャネルなどのコラボレーション・リソース・タイプの表示名。
- ResourceTypeCd; string; USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレーション・リソースのタイプを示すコード。
- TeamId; string; リソースが属するコラボレーション・ネットワーク・ワークスペースの識別子。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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

ルート・スキーマ : collaborationRecipientLookups

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/collaborationRecipientLookups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object collaborationRecipientLookups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/collaborationRecipientLookups-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : collaborationRecipientLookups-item-response

タイプ: object

ソースを表示

AlternateGroupId: string

タイトル: Collaboration Network Alternative Group ID

最大長: 255

リソースが属するコラボレーション・ネットワーク・チームまたはグループの代替識別子。
ChannelId: string

読取り専用: true

最大長: 255

コラボレーション・ネットワーク・ワークスペースに関連付けられているCX Salesチャネルの識別子。
CollabGroupId: string

タイトル: Collaboration Network Group ID

最大長: 255

リソースが属するコラボレーション・ネットワーク・チームまたはグループの識別子。
CollabGroupName: string

タイトル: Collaboration Network Group Name

最大長: 255

リソースが属するコラボレーション・ネットワーク・チームまたはグループの名前。
CollabId: string

タイトル: Collaboration ID

最大長: 255

コラボレーション・ネットワーク内のコラボレーション・リソースの識別子。
DisplayName: string

タイトル: Display Name

最大長: 400

コラボレーション・リソースの表示名。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Resource Name

最大長: 400

コラボレーション・リソースの名前。
ResourceId: integer (int64)

タイトル: Resource ID

読取り専用: true

コラボレーション・リソースの一意の識別子。
ResourceType: string

読取り専用: true

最大長: 255

ユーザー、チャネル、プライベート・チャネルなど、コラボレーション・リソース・タイプの表示名。
ResourceTypeCd: string

タイトル: Resource Type

最大長: 30

USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレーション・リソースのタイプを示すコード。
TeamId: string

タイトル: Team ID

最大長: 255

リソースが属するコラボレーション・ネットワーク・ワークスペースの識別子。

{
    "type":"object",
    "properties":{
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.",
            "nullable":false,
            "x-queryable":true
        },
        "CollabGroupId":{
            "title":"Collaboration Network Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "CollabGroupName":{
            "title":"Collaboration Network Group Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration resource in the collaboration network.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the collaboration resource.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceType":{
            "maxLength":255,
            "type":"string",
            "description":"The display name of the collaboration resource type such as User, Channel, Private Channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the CX Sales channel that is associated with the collaboration network workspace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TeamId":{
            "title":"Team ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network workspace that the resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "AlternateGroupId":{
            "title":"Collaboration Network Alternative Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The alternative identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Resource Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the collaboration resource.",
            "nullable":false,
            "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リソースに対する取得リクエストを発行することによって、すべてのコラボレーション受信者を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collaborationRecipientLookups

レスポンス本文の例

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

{
    "items": [
        {
            "ResourceId": 300100545235365,
            "ResourceTypeCd": "USER",
            "TeamId": "TNJP96YT1",
            "DisplayName": "Karthik Viswanathan",
            "Name": "Karthik Viswanathan",
            "CollabId": "U01GEF41199",
            "ChannelId": "300100545319641",
            "ResourceType": "User",
            "CollabGroupId": null,
            "CollabGroupName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/300100545235365",
                    "name": "collaborationRecipientLookups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/300100545235365",
                    "name": "collaborationRecipientLookups",
                    "kind": "item"
                }
            ]
        },
  .....
   ],
    "count": 17,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups",
            "name": "collaborationRecipientLookups",
            "kind": "collection"
        }
    ]
}

「トップに戻る」