Jump to

• Request
• Response
• Examples

Get an universal work object

get

/crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}

Request

Path Parameters

• WorkId(required): integer(int64)
  The unique identifier of the universal work object.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : universalWorkObjects-item-response

Type: object

Show Source

• 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• 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.

{
    "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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get an universal work object by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "WorkId": 300100122471265,
    "CreationDate": "2017-08-23T09:11:17+00:00",
    "CreatedBy": "bi_csmgr11",
    "LastUpdateDate": "2017-08-23T09:11:21+00:00",
    "LastUpdatedBy": "anonymous",
    "LastUpdateLogin": "5769182D74A037C4E0534180F50ABC7E",
    "Priority": 1,
    "ChannelId": null,
    "ChannelTypeCd": "ORA_SVC_NONE",
    "RealtimeFlag": false,
    "InteractionId": null,
    "AccountPartyId": null,
    "ContactPartyId": null,
    "ContactFirstName": null,
    "ContactLastName": null,
    "ContactEmailAddr": null,
    "AppClassification": null,
    "ObjectId": 300100122471257,
    "ObjectTypeCd": "SVC_SERVICE_REQUESTS",
    "StripeCd": "ORA_SVC_CRM",
    "ProdGroupId": null,
    "InventoryItemId": null,
    "InventoryOrgId": 0,
    "CategoryId": null,
    "LanguageCd": null,
    "QueueId": 100100053060507,
    "AssigneeResourceId": null,
    "LastAssignmentDate": null,
    "AgentSkipList": null,
    "StatusCd": "SVC_ROUTING_IN_PROGRESS",
    "ProductGroupName": null,
    "ProductItemDescription": null,
    "AccountPartyUniqueName": null,
    "ProductItemNumber": null,
    "CategoryName": null,
    "WoName": "SR0000011001",
    "WoTitle": "Respond Flag-N- Child Message",
    "WoTypeName": "Service Request",
    "ContextObjectId": null,
    "ContextObjectName": null,
    "ContextObjectType": null,
    "ContextObjectAssigneeId": null,
    "BuOrgId": 204,
    "Severity": null,
    "UpdateFlag": true,
    "DeleteFlag": false,
    "SocialChannelId": null,
    "SocialChannelName": null,
    "SocialChannelTypeCd": null,
    "ServiceZoneId": null,
    "ServiceZoneName": null,
    "ContextObjectSeverityCd": null,
    "VisitorBrowserHistSessId": null,
    "EscalationLevel": 0,
    "ObjectStatus": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/universalWorkObjects/300100122471265",
            "name": "universalWorkObjects",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/universalWorkObjects/300100122471265",
            "name": "universalWorkObjects",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/universalWorkObjects/300100122471265/enclosure/PropertyMap",
            "name": "PropertyMap",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/universalWorkObjects/300100122471265/enclosure/PreferredResources",
            "name": "PreferredResources",
            "kind": "other"
        }
    ]
}

Back to Top