Update an omnichannel presence
patch
/crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}
Request
Path Parameters
-
ResourcePartyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AvailabilityFlag: boolean
Indicates whether an omnichannel presence is available for each channel.
-
DisabledAvailabilityCd: string
The attribute disables new work for each channel when a resource session begins.
-
EndAgentSessionFlag: boolean
Indicates whether the resource session is ended.
-
GetAvailabilityFlag: boolean
Indicates whether the resource for new work is available.
-
MediaGroup: string
The media group determines the channels a resource accepts to work on.
-
NewPresenceCd: string
The attribute updates the omnichannel presence status.
-
PresenceChangedFlag: boolean
The changes to the omnichannel presence status when an update is requested.
-
SessionId: string
The unique identifier of the session of a resource.
-
SetResourceAvailabilityFlag: boolean
Indicates whether a resources availability needs to be updated.
-
SetResourcePresenceFlag: boolean
Indicates whether a resources omnichannel presence status needs to be updated.
-
StartAgentSessionFlag: boolean
Indicates whether a resource initiated a new omnichannel session.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : resourcePresences-item-response
Type:
Show Source
object
-
AvailabilityFlag: boolean
Indicates whether an omnichannel presence is available for each channel.
-
DisabledAvailabilityCd: string
The attribute disables new work for each channel when a resource session begins.
-
EndAgentSessionFlag: boolean
Indicates whether the resource session is ended.
-
GetAvailabilityFlag: boolean
Indicates whether the resource for new work is available.
-
LastPingDate: string
(date-time)
Read Only:
true
The date when the resource was last marked as active. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MediaGroup: string
The media group determines the channels a resource accepts to work on.
-
NewPresenceCd: string
The attribute updates the omnichannel presence status.
-
PresenceCd: string
Read Only:
true
Maximum Length:30
The current omnichannel presence status. -
PresenceChangedFlag: boolean
The changes to the omnichannel presence status when an update is requested.
-
ResourcePartyId: integer
(int64)
Title:
Resource Party ID
Read Only:true
The unique identifier of the resource. -
SessionId: string
The unique identifier of the session of a resource.
-
SetResourceAvailabilityFlag: boolean
Indicates whether a resources availability needs to be updated.
-
SetResourcePresenceFlag: boolean
Indicates whether a resources omnichannel presence status needs to be updated.
-
StartAgentSessionFlag: boolean
Indicates whether a resource initiated a new omnichannel session.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- PresenceCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_PRESENCE_CD
The following properties are defined on the LOV link relation:- Source Attribute: NewPresenceCd; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- keepAlive
-
Parameters:
- ResourcePartyId:
$request.path.ResourcePartyId
This method lets you mark the resource as active. It's used to determine if the resource still has active sessions. - ResourcePartyId: