機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

チャネルの存在を更新

patch

/crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• AvailabilityFlag: boolean
  各チャネルでチャネル・プレゼンスを使用できるかどうかを示します。
• DisabledAvailabilityCd: string
  この属性は、リソース・セッションの開始時にチャネルごとに新しい作業を無効にします。
• EndAgentSessionFlag: boolean
  リソース・セッションが終了したかどうかを示します。
• GetAvailabilityFlag: boolean
  新規作業のリソースが使用可能かどうかを示します。
• MediaGroup: string
  メディア・グループは、リソースが作業を受け入れるチャネルを決定します。
• NewPresenceCd: string
  この属性は、チャネル・プレゼンス・ステータスを更新します。
• PresenceChangedFlag: boolean
  更新のリクエスト時のチャネル・プレゼンス・ステータスの変更。
• SessionId: string
  リソースのセッションの一意の識別子。
• SetResourceAvailabilityFlag: boolean
  リソースの可用性を更新する必要があるかどうかを示します。
• SetResourcePresenceFlag: boolean
  リソース・チャネル・プレゼンス・ステータスを更新する必要があるかどうかを示します。
• StartAgentSessionFlag: boolean
  リソースが新しいチャネル・セッションを開始したかどうかを示します。

{
    "type":"object",
    "properties":{
        "GetAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource for new work is available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MediaGroup",
                    "ResourcePartyId"
                ]
            }
        },
        "AvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether an omnichannel presence is available for each channel.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourcePresenceFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources omnichannel presence status needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "NewPresenceCd",
                    "PresenceCd",
                    "ResourcePartyId"
                ]
            }
        },
        "MediaGroup":{
            "type":"string",
            "description":"The media group determines the channels a resource accepts to work on.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId"
                ]
            }
        },
        "EndAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource session is ended.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        },
        "DisabledAvailabilityCd":{
            "type":"string",
            "description":"The attribute disables new work for each channel when a resource session begins.",
            "nullable":true,
            "x-queryable":false
        },
        "PresenceChangedFlag":{
            "type":"boolean",
            "description":"The changes to the omnichannel presence status when an update is requested.",
            "nullable":true,
            "x-queryable":false
        },
        "StartAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether a resource initiated a new omnichannel session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DisabledAvailabilityCd",
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        },
        "NewPresenceCd":{
            "type":"string",
            "description":"The attribute updates the omnichannel presence status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SessionId":{
            "type":"string",
            "description":"The unique identifier of the session of a resource.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourceAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources availability needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AvailabilityFlag",
                    "MediaGroup",
                    "PresenceChangedFlag",
                    "ResourcePartyId"
                ]
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AvailabilityFlag: boolean
  各チャネルでチャネル・プレゼンスを使用できるかどうかを示します。
• DisabledAvailabilityCd: string
  この属性は、リソース・セッションの開始時にチャネルごとに新しい作業を無効にします。
• EndAgentSessionFlag: boolean
  リソース・セッションが終了したかどうかを示します。
• GetAvailabilityFlag: boolean
  新規作業のリソースが使用可能かどうかを示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MediaGroup: string
  メディア・グループは、リソースが作業を受け入れるチャネルを決定します。
• NewPresenceCd: string
  この属性は、チャネル・プレゼンス・ステータスを更新します。
• PresenceCd: string
  読取り専用: true

  最大長: 30

  現在のチャネルの存在ステータス。
• PresenceChangedFlag: boolean
  更新のリクエスト時のチャネル・プレゼンス・ステータスの変更。
• ResourcePartyId: integer (int64)
  タイトル: Resource Party ID

  読取り専用: true

  リソースの一意の識別子。
• SessionId: string
  リソースのセッションの一意の識別子。
• SetResourceAvailabilityFlag: boolean
  リソースの可用性を更新する必要があるかどうかを示します。
• SetResourcePresenceFlag: boolean
  リソース・チャネル・プレゼンス・ステータスを更新する必要があるかどうかを示します。
• StartAgentSessionFlag: boolean
  リソースが新しいチャネル・セッションを開始したかどうかを示します。

{
    "type":"object",
    "properties":{
        "AvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether an omnichannel presence is available for each channel.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourcePresenceFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources omnichannel presence status needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "NewPresenceCd",
                    "PresenceCd",
                    "ResourcePartyId"
                ]
            }
        },
        "MediaGroup":{
            "type":"string",
            "description":"The media group determines the channels a resource accepts to work on.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId"
                ]
            }
        },
        "EndAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource session is ended.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId",
                    "SessionId"
                ]
            },
            "x-queryable":true
        },
        "StartAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether a resource initiated a new omnichannel session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DisabledAvailabilityCd",
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        },
        "NewPresenceCd":{
            "type":"string",
            "description":"The attribute updates the omnichannel presence status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GetAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource for new work is available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MediaGroup",
                    "ResourcePartyId"
                ]
            }
        },
        "DisabledAvailabilityCd":{
            "type":"string",
            "description":"The attribute disables new work for each channel when a resource session begins.",
            "nullable":true,
            "x-queryable":false
        },
        "PresenceChangedFlag":{
            "type":"boolean",
            "description":"The changes to the omnichannel presence status when an update is requested.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PresenceCd":{
            "maxLength":30,
            "type":"string",
            "description":"The current omnichannel presence status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourcePartyId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionId":{
            "type":"string",
            "description":"The unique identifier of the session of a resource.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourceAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources availability needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AvailabilityFlag",
                    "MediaGroup",
                    "PresenceChangedFlag",
                    "ResourcePartyId"
                ]
            }
        }
    }
}

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

タイプ: 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."
        }
    }
}

リンク

PresenceCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_PRESENCE_CD

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

• ソース属性: NewPresenceCd;ターゲット属性: LookupCode
• 表示属性: LookupCode

「トップに戻る」