Update an universal work object
patch
/crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}
Request
Path Parameters
-
WorkId(required): integer(int64)
The unique identifier of the universal work object.
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
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier of the account party associated with the work object. -
AccountPartyUniqueName: string
Title:
Account
Maximum Length:900
The unique name to identify the account. -
AgentSkipList: string
Title:
Skip List
Maximum Length:2000
A comma separated list of agents unique identifiers to which this work object should not be offered. -
AppClassification: string
Title:
Application Classification
Maximum Length:30
The application classification associated to the work object such as SALES or SERVICE. -
AssigneeResourceId: integer
(int64)
Title:
Assignee Resource ID
The identifier of the resource assigned to this work object. -
BuOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the Business Unit Organization associated with this work object. Reserved for future use. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier of the category to the work request. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel associated to the work object. -
ChannelTypeCd: string
Title:
Channel
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ContactEmailAddr: string
Title:
Contact Email Address
Maximum Length:320
The contact email address as sent from the channel. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
The first name of the contact as sent from the channel. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:100
The last name of the contact as sent from the channel. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The unique identifier of the contact party associated with the work object. -
ContextObjectAssigneeId: integer
(int64)
Title:
Context Object Assignee ID
The assignee unique identifier of the business object that adds context to the work object. -
ContextObjectId: integer
(int64)
Title:
Context Object ID
The unique identifier of a business object that adds context to the work object. -
ContextObjectName: string
Title:
Context Object Name
Maximum Length:64
The visible user name of the business object that adds context to the work object. -
ContextObjectSeverityCd: string
Title:
Context Severity Code
Maximum Length:30
The severity code of the business object that adds context to the work object. -
ContextObjectType: string
Title:
Context Object Type
Maximum Length:30
The business object type that adds context to the work object. -
EscalationLevel: integer
(int64)
Title:
Escalation Level
The level to which the work object has been escalated to. The default value is 0, which means no escalation. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction associated to this work object. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated with the work object. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that is associated work object. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The lookup code that indicates customer preferred language for this work object. -
LastAssignmentDate: string
(date-time)
Title:
Last Assignment Date
The last time this request was offered to an agent. -
ObjectId: number
Title:
Object ID
The unique identifier of the business object or client channel instance id associated with this request. -
ObjectStatus: string
Title:
Object Status
Maximum Length:100
The status of the business object that adds context to the work object. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The type of the Business Object if set. For example SVC_SERVICE_REQUESTS. -
PreferredResources: string
(byte)
Title:
Preferred Resources
A comma separated list of agents unique identifiers that would be preferred to be assigned to the work object. -
Priority: integer
Title:
Priority
The priority of the work that needs to be assigned. For example a SR's priority could be calculated based on its severity. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated with the work object. -
PropertyMap: string
(byte)
Title:
Work Object Properties
A collection of work object properties as name value pairs in JSON format. -
QueueId: integer
(int64)
Title:
Queue ID
The identifier of the queue that the work object has been assigned to. -
RealtimeFlag: boolean
Title:
Real Time
Maximum Length:1
Indicates whether the channel is in real time or not. -
ServiceZoneId: integer
(int64)
Title:
Region ID
The service region unique identifier associated to the work object. -
ServiceZoneName: string
Title:
Service Region
Maximum Length:360
The service region name associated to the work object. -
Severity: string
Maximum Length:
30
The severity code of the work that needs to be assigned. -
SocialChannelId: string
Title:
Social Channel ID
Maximum Length:400
The social channel identifier associated to the work object. -
SocialChannelName: string
Title:
Social Channel Name
Maximum Length:400
The social channel name associated to the work object. -
SocialChannelTypeCd: string
Title:
Social Channel Type
Maximum Length:30
The social channel type associated to the work object. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The status of the work object assignment. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The lookup code that indicates the stripe code, such as CRM, HCM, or PRM. -
VisitorBrowserHistSessId: string
Title:
Visitor's Browser History ID
Maximum Length:100
The unique identifier of the browser history that provides insight into the end-user's page visits. -
WoName: string
Title:
Reference ID
Maximum Length:64
The user visible name of the object associated with the work object. -
WoTitle: string
Title:
Title
Maximum Length:400
The user visible title of the object associated with the work object. -
WoTypeName: string
Title:
Work Object Type
Maximum Length:30
The user visible name for the type of work associated with the work object.
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 : universalWorkObjects-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier of the account party associated with the work object. -
AccountPartyUniqueName: string
Title:
Account
Maximum Length:900
The unique name to identify the account. -
AgentSkipList: string
Title:
Skip List
Maximum Length:2000
A comma separated list of agents unique identifiers to which this work object should not be offered. -
AppClassification: string
Title:
Application Classification
Maximum Length:30
The application classification associated to the work object such as SALES or SERVICE. -
AssigneeResourceId: integer
(int64)
Title:
Assignee Resource ID
The identifier of the resource assigned to this work object. -
BuOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the Business Unit Organization associated with this work object. Reserved for future use. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier of the category to the work request. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:255
The name of the category associated with the work object. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel associated to the work object. -
ChannelTypeCd: string
Title:
Channel
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ContactEmailAddr: string
Title:
Contact Email Address
Maximum Length:320
The contact email address as sent from the channel. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
The first name of the contact as sent from the channel. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:100
The last name of the contact as sent from the channel. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The unique identifier of the contact party associated with the work object. -
ContextObjectAssigneeId: integer
(int64)
Title:
Context Object Assignee ID
The assignee unique identifier of the business object that adds context to the work object. -
ContextObjectId: integer
(int64)
Title:
Context Object ID
The unique identifier of a business object that adds context to the work object. -
ContextObjectName: string
Title:
Context Object Name
Maximum Length:64
The visible user name of the business object that adds context to the work object. -
ContextObjectSeverityCd: string
Title:
Context Severity Code
Maximum Length:30
The severity code of the business object that adds context to the work object. -
ContextObjectType: string
Title:
Context Object Type
Maximum Length:30
The business object type that adds context to the work object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the universal work object. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the universal work object was created. -
DeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether the universal work object can be deleted. -
EscalationLevel: integer
(int64)
Title:
Escalation Level
The level to which the work object has been escalated to. The default value is 0, which means no escalation. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction associated to this work object. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated with the work object. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that is associated work object. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The lookup code that indicates customer preferred language for this work object. -
LastAssignmentDate: string
(date-time)
Title:
Last Assignment Date
The last time this request was offered to an agent. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the universal work object was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the universal work object. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the universal work object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: number
Title:
Object ID
The unique identifier of the business object or client channel instance id associated with this request. -
ObjectStatus: string
Title:
Object Status
Maximum Length:100
The status of the business object that adds context to the work object. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The type of the Business Object if set. For example SVC_SERVICE_REQUESTS. -
PreferredResources: string
(byte)
Title:
Preferred Resources
A comma separated list of agents unique identifiers that would be preferred to be assigned to the work object. -
Priority: integer
Title:
Priority
The priority of the work that needs to be assigned. For example a SR's priority could be calculated based on its severity. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated with the work object. -
ProductGroupName: string
Title:
Product Group
Read Only:true
Maximum Length:255
The name of the product group associated with the work object. -
ProductItemDescription: string
Title:
Product Description
Read Only:true
Maximum Length:255
The description of the product associated with the work object. -
ProductItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:255
The alternate key identifier of the product associated with the work object. -
PropertyMap: string
(byte)
Title:
Work Object Properties
A collection of work object properties as name value pairs in JSON format. -
QueueId: integer
(int64)
Title:
Queue ID
The identifier of the queue that the work object has been assigned to. -
RealtimeFlag: boolean
Title:
Real Time
Maximum Length:1
Indicates whether the channel is in real time or not. -
ServiceZoneId: integer
(int64)
Title:
Region ID
The service region unique identifier associated to the work object. -
ServiceZoneName: string
Title:
Service Region
Maximum Length:360
The service region name associated to the work object. -
Severity: string
Maximum Length:
30
The severity code of the work that needs to be assigned. -
SocialChannelId: string
Title:
Social Channel ID
Maximum Length:400
The social channel identifier associated to the work object. -
SocialChannelName: string
Title:
Social Channel Name
Maximum Length:400
The social channel name associated to the work object. -
SocialChannelTypeCd: string
Title:
Social Channel Type
Maximum Length:30
The social channel type associated to the work object. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The status of the work object assignment. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The lookup code that indicates the stripe code, such as CRM, HCM, or PRM. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the universal work object can be updated. -
VisitorBrowserHistSessId: string
Title:
Visitor's Browser History ID
Maximum Length:100
The unique identifier of the browser history that provides insight into the end-user's page visits. -
WoName: string
Title:
Reference ID
Maximum Length:64
The user visible name of the object associated with the work object. -
WorkId: integer
(int64)
Title:
Work ID
Read Only:true
The unique identifier of the universal work object. -
WoTitle: string
Title:
Title
Maximum Length:400
The user visible title of the object associated with the work object. -
WoTypeName: string
Title:
Work Object Type
Maximum Length:30
The user visible name for the type of work associated with the work object.
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.